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

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
(XML import)
Line 2: Line 2:
 
Sets whether the property can be edited in the UI or not
 
Sets whether the property can be edited in the UI or not
  
 +
<div style="width:25%; float:right" class="toc">
 +
===Class hierarchy===
 +
:Component
 +
::Property
 +
:::SetWritable
 +
</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 13: Line 20:
 
:Set true or false for writable state
 
:Set true or false for writable state
  
===Return value===
+
==Return value==
 
''This call does not return a value''
 
''This call does not return a value''
  
===Detailed description===
+
==Detailed description==
 
''No additional information''
 
''No additional information''
  
===Examples===
+
==Examples==
====Calling in a calculation====
+
===Calling in a calculation===
* Add to a calculation icon: <pre class="brush:[C]">::Component.Property.SetWritable(handle, "property", false)</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">::Component.Property.SetWritable(handle, "property", false)</pre>

Revision as of 15:21, 11 May 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

No additional information

Examples

Calling in a calculation

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