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

From Flowcode Help
Jump to navigationJump to search
(XML import of API documentation)
Line 27: Line 27:
  
 
==Detailed description==
 
==Detailed description==
Reads whether a property of a component is editable in the [[Property Pane]] or not.
+
Reads whether a property of a component is editable in the [[Properties Panel]] or not.
 
 
  
 
==Examples==
 
==Examples==

Revision as of 09:01, 20 August 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 Properties Panel 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