Difference between revisions of "API Component.Property.GetWritable"
From Flowcode Help
Jump to navigationJump to search (XML import) |
|||
| (8 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |
| − | + | |- | |
| − | + | | 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 |
| − | : | + | |- |
| − | :: | + | |- |
| − | + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | |
| − | + | | width="90%" | Handle | |
| − | + | |- | |
| − | == | + | | colspan="2" | The component handle of the property owner |
| − | [[ | + | |- |
| − | + | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | |
| − | + | | width="90%" | Property | |
| − | [[ | + | |- |
| − | + | | colspan="2" | 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'' |
| − | [[ | + | |} |
| − | |||
==Detailed description== | ==Detailed description== | ||
| − | + | Reads whether a property of a component is editable in the [[Properties Panel]] or not. | |
| − | |||
==Examples== | ==Examples== | ||
| Line 31: | 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> | ||
| − | |||
| − | |||
Latest revision as of 11:54, 16 January 2023
|
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")
