Difference between revisions of "API Component.Property.SetVisible"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
(XML import) |
||
| (18 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Sets whether the property is visible or not | Sets whether the property is visible or not | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ====Class hierarchy==== | ||
| + | [[API Component|Component]] | ||
| + | :[[API Component.Property|Property]] | ||
| + | ::[[API Component.Property|SetVisible]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
| − | + | [[Variable Types|HANDLE]] ''Handle'' | |
:The component handle of the property owner | :The component handle of the property owner | ||
| − | + | [[Variable Types|STRING]] ''Property'' | |
:The textual name of the property | :The textual name of the property | ||
| − | + | [[Variable Types|BOOL]] ''Value'' | |
:Set true or false for visible state | :Set true or false for visible state | ||
| − | + | ||
| + | ==Return value== | ||
''This call does not return a value'' | ''This call does not return a value'' | ||
| − | |||
| − | |||
| − | ===Examples | + | ==Detailed description== |
| − | + | Shows or hides the property in the [[Properties Panel]]. This state may be read with [[API Component.Property.GetVisible|GetVisible]]. | |
| − | * Add to a calculation icon: ::Component.Property.SetVisible(handle, "property", false) | + | |
| + | |||
| + | 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 examples</span>'' | ||
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Sets whether the property is visible or not
Contents
Parameters
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
Return value
This call does not return a value
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)
No additional examples
