Difference between revisions of "API Component.Property.SetWritable"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
| (21 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | <sidebar>API Contents</sidebar> | |
| − | + | Sets whether the property can be edited in the UI or not | |
| − | + | <div style="width:25%; float:right" class="toc"> | |
| − | + | ====Class hierarchy==== | |
| + | [[API Component|Component]] | ||
| + | :[[API Component.Property|Property]] | ||
| + | ::[[API Component.Property|SetWritable]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==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 | ||
| − | + | [[Variable Types|BOOL]] ''Value'' | |
:Set true or false for writable state | :Set true or false for writable state | ||
| − | + | ||
| + | ==Return value== | ||
''This call does not return a value'' | ''This call does not return a value'' | ||
| − | |||
| − | |||
| − | ===Examples | + | ==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]]. | |
| − | * Add to a calculation icon: ::Component.Property.SetWritable(handle, "property", false) | + | |
| + | ==Examples== | ||
| + | ===Calling in a calculation=== | ||
| + | * Add to a calculation icon: <pre class="brush:[cpp]">::Component.Property.SetWritable(handle, "property", false)</pre> | ||
| + | |||
| + | ''<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
