Difference between revisions of "API Component.Property.GetWritable"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| (10 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Gets whether the property can be edited in the UI or not | Gets whether the property can be edited in the UI or not | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
| − | ===Class hierarchy===[[API Component|Component]] | + | ====Class hierarchy==== |
| + | [[API Component|Component]] | ||
:[[API Component.Property|Property]] | :[[API Component.Property|Property]] | ||
::[[API Component.Property|GetWritable]] | ::[[API Component.Property|GetWritable]] | ||
| Line 10: | Line 11: | ||
==Parameters== | ==Parameters== | ||
| − | + | [[Variable Types|HANDLE]] ''Handle'' | |
:The component handle of the property owner | :The component handle of the property owner | ||
| − | + | [[Variable Types|STRING]] ''Property'' | |
:The textual name of the property | :The textual name of the property | ||
| + | |||
==Return value== | ==Return value== | ||
| − | [[Variable | + | [[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 [[Properties Panel]] or not. | |
==Examples== | ==Examples== | ||
| Line 28: | Line 31: | ||
* 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 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Gets whether the property can be edited in the UI or not
Contents
Parameters
HANDLE Handle
- The component handle of the property owner
STRING Property
- The textual name of the property
Return value
Returns true if the operation is a success, else false
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")
No additional examples
