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

From Flowcode Help
Jump to navigationJump to search
(XML import of updated API docs)
Line 1: Line 1:
 +
 +
 
<sidebar>API contents</sidebar>
 
<sidebar>API contents</sidebar>
 
Gets whether the property can be edited in the UI or not
 
Gets whether the property can be edited in the UI or not
Line 33: Line 35:
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.GetWritable(handle, "property")</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.GetWritable(handle, "property")</pre>
  
''<span style="color:red;">No additional information</span>''
+
''<span style="color:red;">No additional examples</span>''

Revision as of 09:58, 17 June 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

Returns true if the operation is a success, else false


Detailed description

Reads whether a property of a component is editable in the Property Pane or not.


Examples

Calling in a calculation

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

No additional examples