Difference between revisions of "API Component.Property.SetVisible"
From Flowcode Help
Jump to navigationJump to search (XML import) |
|||
| (11 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |
| − | Sets whether the property is visible or not | + | |- |
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetVisible''' | ||
| + | |- | ||
| + | | colspan="2" | Sets whether the property is visible or not | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| + | | width="90%" | Handle | ||
| + | |- | ||
| + | | colspan="2" | The component handle of the property owner | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
| + | | width="90%" | Property | ||
| + | |- | ||
| + | | colspan="2" | The textual name of the property | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | width="90%" | Value | ||
| + | |- | ||
| + | | colspan="2" | Set true or false for visible state | ||
| + | |- | ||
| + | | 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 [[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== | ==Examples== | ||
===Calling in a calculation=== | ===Calling in a calculation=== | ||
* Add to a calculation icon: <pre class="brush:[cpp]">::Component.Property.SetVisible(handle, "property", false)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">::Component.Property.SetVisible(handle, "property", false)</pre> | ||
Latest revision as of 11:54, 16 January 2023
|
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)
