API Component.Property.SetWritable: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	SetWritable
Sets 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	Value
Set true or false for writable state
- NONE	Return

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)

@@ 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]]
-Sets whether the property can be edited in the UI or not
+| width="90%" class="mtx-class-macrohead" | '''SetWritable'''
+|-
-<div style="width:25%; float:right" class="toc">
+| colspan="2" | Sets 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|SetWritable]]
+| 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" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | Value
-[[Variable Types|BOOL]] ''Value''
+|-
-:Set true or false for writable state
+| colspan="2" | Set true or false for writable state&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
-==Return value==
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
-''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 [[API Component.Property.GetWritable|GetWritable]].
+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==
 ===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>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation