API Component.Property.SetVisible: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	SetVisible
Sets whether the property is visible 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 visible state
- NONE	Return

Detailed description

Shows or hides the property in the Properties Panel. This state may be read with GetVisible.

Note for root component properties the property will not be hidden, but disabled instead so it can be modified by the user. This is not true for compiled components.

Examples

Calling in a calculation

Add to a calculation icon:

::Component.Property.SetVisible(handle, "property", false)

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Sets whether the property is visible or not
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-<div style="width:25%; float:right" class="toc">
+| width="90%" class="mtx-class-macrohead" | '''SetVisible'''
-====Class hierarchy====
+|-
-[[API Component|Component]]
+| colspan="2" | Sets whether the property is visible or not&nbsp;
-:[[API Component.Property|Property]]
+|-
-::[[API Component.Property|SetVisible]]
+|-
-</div>
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-__TOC__
+| width="90%" | Handle
+|-
-==Parameters==
+| colspan="2" | The component handle of the property owner&nbsp;
-[[Variable Types|HANDLE]] ''Handle''
+|-
-:The component handle of the property owner
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Property
-[[Variable Types|STRING]] ''Property''
+|-
-:The textual name of the property
+| colspan="2" | The textual name of the property&nbsp;
+|-
-[[Variable Types|BOOL]] ''Value''
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
-:Set true or false for visible state
+| width="90%" | Value
+|-
+| colspan="2" | Set true or false for visible state&nbsp;
-==Return value==
+|-
-''This call does not return a value''
+| 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''
+|}
 ==Detailed description==
-Shows or hides the property in the [[Property Pane]]. This state may be read with [[API Component.Property.GetVisible|GetVisible]].
+Shows or hides the property in the [[Properties Panel]]. This state may be read with [[API Component.Property.GetVisible|GetVisible]].
 Note for root component properties the property will not be hidden, but disabled instead so it can be modified by the user. This is not true for compiled components.
 ==Examples==
 ===Calling in a calculation===
 * Add to a calculation icon: <pre class="brush:[cpp]">::Component.Property.SetVisible(handle, "property", false)</pre>
-''<span style="color:red;">No additional information</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation