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

From Flowcode Help
Jump to navigationJump to search
(XML import API changes)
(XML Import to change Variable types into Variable Types)
Line 11: Line 11:
  
 
==Parameters==
 
==Parameters==
[[Variable types|HANDLE]] ''Handle''
+
[[Variable Types|HANDLE]] ''Handle''
 
:The component handle of the property owner
 
:The component handle of the property owner
  
[[Variable types|STRING]] ''Property''
+
[[Variable Types|STRING]] ''Property''
 
:The textual name of the property
 
:The textual name of the property
  
  
 
==Return value==
 
==Return value==
[[Variable types|BOOL]]
+
[[Variable Types|BOOL]]
  
 
Returns true if the operation is a success, else false
 
Returns true if the operation is a success, else false

Revision as of 11:08, 10 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

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")

No additional information