Difference between revisions of "API Component.Property.GetWritable"

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
 
(21 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
<sidebar>API contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Gets whether the property can be edited in the UI or not
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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''
 +
|}
  
  
−
===Parameters===
+
==Detailed description==
−
''[[Variable types|HANDLE]] Handle''
+
Reads whether a property of a component is editable in the [[Properties Panel]] or not.
−
:The component handle of the property owner
 
  
−
''[[Variable types|STRING]] Property''
+
==Examples==
−
:The textual name of the property
+
===Calling in a calculation===
−
 
 
−
===Return value===
 
−
[[Variable types|BOOL]]
 
−
 
 
−
No additional information
 
−
 
 
−
===Detailed description===
 
−
''No additional information''
 
−
 
 
−
===Examples===
 
−
====Calling in a calculation====
 
 
* Declare a variable 'result' of type BOOL
 
* Declare a variable 'result' of type BOOL
−
* Add to a calculation icon: result = ::Component.Property.GetWritable(handle, "property")
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.GetWritable(handle, "property")</pre>

Latest revision as of 11:54, 16 January 2023

Fc9-comp-macro.png GetWritable
Gets whether the property can be edited in the UI or not 
Fc9-h32-icon.png - HANDLE Handle
The component handle of the property owner 
Fc9-string-icon.png - STRING Property
The textual name of the property 
Fc9-bool-icon.png - 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")
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_Component.Property.GetWritable&oldid=30133"