Difference between revisions of "API Component.Property.SetWritable"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
(8 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
− | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Sets whether the property can be edited in the UI or not | Sets whether the property can be edited in the UI or not | ||
Line 11: | Line 11: | ||
==Parameters== | ==Parameters== | ||
− | [[Variable | + | [[Variable Types|HANDLE]] ''Handle'' |
:The component handle of the property owner | :The component handle of the property owner | ||
− | [[Variable | + | [[Variable Types|STRING]] ''Property'' |
:The textual name of the property | :The textual name of the property | ||
− | [[Variable | + | [[Variable Types|BOOL]] ''Value'' |
:Set true or false for writable state | :Set true or false for writable state | ||
+ | |||
==Return value== | ==Return value== | ||
''This call does not return a value'' | ''This call does not return a value'' | ||
+ | |||
==Detailed description== | ==Detailed description== | ||
− | + | This call decides if the property, or any of its children if specifying a folder, are writable or not through the [[Properties Panel]]. This state may be read with [[API Component.Property.GetWritable|GetWritable]]. | |
− | |||
==Examples== | ==Examples== | ||
Line 31: | Line 32: | ||
* Add to a calculation icon: <pre class="brush:[cpp]">::Component.Property.SetWritable(handle, "property", false)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">::Component.Property.SetWritable(handle, "property", false)</pre> | ||
− | ''<span style="color:red;">No additional | + | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Sets 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
BOOL Value
- Set true or false for writable state
Return value
This call does not return a value
Detailed description
This call decides if the property, or any of its children if specifying a folder, are writable or not through the Properties Panel. This state may be read with GetWritable.
Examples
Calling in a calculation
- Add to a calculation icon:
::Component.Property.SetWritable(handle, "property", false)
No additional examples