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: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Sets whether the property can be edited in the UI or not
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''SetWritable'''
+|-
+| colspan="2" | Sets whether the property can be edited in the UI or not&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Handle
+|-
+| colspan="2" | The component handle of the property owner&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Property
+|-
+| colspan="2" | The textual name of the property&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | Value
+|-
+| 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
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-<div style="width:25%; float:right" class="toc">
-===Class hierarchy===[[API |API ]]
-:[[API Component|Component]]
-::[[API Component.Property|Property]]
-:::SetWritable
-</div>
-__TOC__
-==Parameters==
-''[[Variable types|HANDLE]] Handle''
-:The component handle of the property owner
-''[[Variable types|STRING]] Property''
-:The textual name of the property
-''[[Variable types|BOOL]] Value''
-:Set true or false for writable state
-==Return value==
-''This call does not return a value''
 ==Detailed description==
-''No additional information''
+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>

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation