API Component.Property.GetWritable: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	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")

@@ Line 1: / Line 1: @@
+{| class="mtx-class-macrotable wikitable"
+|-
-<sidebar>API contents</sidebar>
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-Gets whether the property can be edited in the UI or not
+| width="90%" class="mtx-class-macrohead" | '''GetWritable'''
+|-
-<div style="width:25%; float:right" class="toc">
+| colspan="2" | Gets whether the property can be edited in the UI or not&nbsp;
-====Class hierarchy====
+|-
-[[API Component|Component]]
+|-
-:[[API Component.Property|Property]]
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-::[[API Component.Property|GetWritable]]
+| width="90%" | Handle
-</div>
+|-
-__TOC__
+| colspan="2" | The component handle of the property owner&nbsp;
+|-
-==Parameters==
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
-[[Variable Types|HANDLE]] ''Handle''
+| width="90%" | Property
-:The component handle of the property owner
+|-
+| colspan="2" | The textual name of the property&nbsp;
-[[Variable Types|STRING]] ''Property''
+|-
-: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''
+|}
-==Return value==
-[[Variable Types|BOOL]]
-Returns true if the operation is a success, else false
 ==Detailed description==
-Reads whether a property of a component is editable in the [[Property Pane]] or not.
+Reads whether a property of a component is editable in the [[Properties Panel]] or not.
 ==Examples==
@@ Line 34: / Line 29: @@
 * Declare a variable 'result' of type BOOL
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.GetWritable(handle, "property")</pre>
-''<span style="color:red;">No additional examples</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation