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

From Flowcode Help
Jump to navigationJump to search
(XML import of API documentation)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
 
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
<sidebar>API Contents</sidebar>
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
Gets whether the property can be edited in the UI or not
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetWritable'''
−
 
+
|-
−
<div style="width:25%; float:right" class="toc">
+
| colspan="2" | Gets whether the property can be edited in the UI or not&nbsp;
−
====Class hierarchy====
+
|-
−
[[API Component|Component]]
+
|-
−
:[[API Component.Property|Property]]
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
−
::[[API Component.Property|GetWritable]]
+
| width="90%" | Handle
−
</div>
+
|-
−
__TOC__
+
| colspan="2" | The component handle of the property owner&nbsp;
−
 
+
|-
−
==Parameters==
+
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
−
[[Variable Types|HANDLE]] ''Handle''
+
| width="90%" | Property
−
:The component handle of the property owner
+
|-
−
 
+
| colspan="2" | The textual name of the property&nbsp;
−
[[Variable Types|STRING]] ''Property''
+
|-
−
:The textual name of the property
+
| 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''
−
 
+
|}
−
==Return value==
 
−
[[Variable Types|BOOL]]
 
−
 
 
−
Returns true if the operation is a success, else false
 
  
  
 
==Detailed description==
 
==Detailed description==
−
Reads whether a property of a component is editable in the [[Property Pane]] or not.
+
Reads whether a property of a component is editable in the [[Properties Panel]] or not.
−
 
 
  
 
==Examples==
 
==Examples==
Line 34: Line 29:
 
* Declare a variable 'result' of type BOOL
 
* Declare a variable 'result' of type BOOL
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.GetWritable(handle, "property")</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.GetWritable(handle, "property")</pre>
−
 
−
''<span style="color:red;">No additional examples</span>''
 

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"