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

From Flowcode Help
Jump to navigationJump to search
(XML import of API documentation)
Line 28: Line 28:
  
 
==Detailed description==
 
==Detailed description==
This call decides if the property, or any of its children if specifying a folder, are writable or not through the [[Property Pane]]. This state may be read with [[API Component.Property.GetWritable|GetWritable]].
+
This call decides if the property, or any of its children if specifying a folder, are writable or not through the [[Properties Panel]]. This state may be read with [[API Component.Property.GetWritable|GetWritable]].
 
 
  
 
==Examples==
 
==Examples==

Revision as of 09:00, 20 August 2013


<sidebar>API Contents</sidebar> Sets whether the property can be edited in the UI or not

Class hierarchy

Component

Property
SetWritable

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 writable state


Return value

This call does not return a value


Detailed description

This call decides if the property, or any of its children if specifying a folder, are writable or not through the Properties Panel. This state may be read with GetWritable.

Examples

Calling in a calculation

  • Add to a calculation icon:
    ::Component.Property.SetWritable(handle, "property", false)

No additional examples