API Component.Property.SetWritable: Difference between revisions
No edit summary |
XML Import to change Variable types into Variable Types |
||
| 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 | ||
Revision as of 11:08, 10 June 2013
<sidebar>API contents</sidebar> Sets whether the property can be edited in the UI or not
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 Property Pane. 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 information