Jump to content

API Component.Property.GetWritable: Difference between revisions

From Flowcode Help
Admin (talk | contribs)
XML import
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead""
 
(17 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
{| class="mtx-class-macrotable wikitable"
Gets whether the property can be edited in the UI or not
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''GetWritable'''
|-
| colspan="2" | Gets whether the property can be edited in the UI or not&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="90%" | Handle
|-
| colspan="2" | The component handle of the property owner&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Property
|-
| colspan="2" | The textual name of the property&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


<div style="width:25%; float:right" class="toc">
===Class hierarchy===
:Component
::Property
:::GetWritable
</div>
__TOC__
==Parameters==
''[[Variable types|HANDLE]] Handle''
:The component handle of the property owner
''[[Variable types|STRING]] Property''
:The textual name of the property
==Return value==
[[Variable types|BOOL]]
No additional information


==Detailed description==
==Detailed description==
''No additional information''
Reads whether a property of a component is editable in the [[Properties Panel]] or not.


==Examples==
==Examples==

Latest revision as of 14:11, 13 July 2026

GetWritable
Gets whether the property can be edited in the UI or not 
- HANDLE Handle
The component handle of the property owner 
- STRING Property
The textual name of the property 
- BOOL Return


Detailed description

Reads whether a property of a component is editable in the Properties Panel or not.

Examples

Calling in a calculation

  • Declare a variable 'result' of type BOOL
  • Add to a calculation icon:
    result = ::Component.Property.GetWritable(handle, "property")