Difference between revisions of "API Component.Property.GetWritable"

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
(XML import)
Line 2: Line 2:
 
Gets whether the property can be edited in the UI or not
 
Gets whether the property can be edited in the UI or not
  
 +
<div style="width:25%; float:right" class="toc">
 +
===Class hierarchy===
 +
:Component
 +
::Property
 +
:::GetWritable
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
 
''[[Variable types|HANDLE]] Handle''
 
''[[Variable types|HANDLE]] Handle''
 
:The component handle of the property owner
 
:The component handle of the property owner
Line 10: Line 17:
 
:The textual name of the property
 
:The textual name of the property
  
===Return value===
+
==Return value==
 
[[Variable types|BOOL]]
 
[[Variable types|BOOL]]
  
 
No additional information
 
No additional information
  
===Detailed description===
+
==Detailed description==
 
''No additional information''
 
''No additional information''
  
===Examples===
+
==Examples==
====Calling in a calculation====
+
===Calling in a calculation===
 
* Declare a variable 'result' of type BOOL
 
* Declare a variable 'result' of type BOOL
* Add to a calculation icon: <pre class="brush:[C]">result = ::Component.Property.GetWritable(handle, "property")</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.GetWritable(handle, "property")</pre>

Revision as of 15:21, 11 May 2013

<sidebar>API contents</sidebar> Gets whether the property can be edited in the UI or not

Class hierarchy

Component
Property
GetWritable

Parameters

HANDLE Handle

The component handle of the property owner

STRING Property

The textual name of the property

Return value

BOOL

No additional information

Detailed description

No additional information

Examples

Calling in a calculation

  • Declare a variable 'result' of type BOOL
  • Add to a calculation icon:
    result = ::Component.Property.GetWritable(handle, "property")