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

Latest revision as of 15:57, 16 January 2014

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

HANDLE Handle

The component handle of the property owner

STRING Property

The textual name of the property

Returns true if the operation is a success, else false

Reads whether a property of a component is editable in the Properties Panel or not.

Add to a calculation icon:

result = ::Component.Property.GetWritable(handle, "property")

No additional examples

@@ Line 1: / Line 1: @@
-wiki page name
+<sidebar>API Contents</sidebar>
-==Component.PropertyGetWritable==
+Gets whether the property can be edited in the UI or not
-Gets whether the property can be edited in the UI or not
+<div style="width:25%; float:right" class="toc">
-----
+====Class hierarchy====
+[[API Component|Component]]
+:[[API Component.Property|Property]]
+::[[API Component.Property|GetWritable]]
+</div>
+__TOC__
-===Parameters===
+==Parameters==
-''[[Variable types|HANDLE]] Handle''
+[[Variable Types|HANDLE]] ''Handle''
 :The component handle of the property owner
-''[[Variable types|STRING]] Property''
+[[Variable Types|STRING]] ''Property''
 :The textual name of the property
-===Return value===
-[[Variable types|BOOL]]
-No additional information
+==Return value==
+[[Variable Types|BOOL]]
-===Detailed description===
+Returns true if the operation is a success, else false
-''No additional information''
-===Examples===
-====Calling in a calculation:====
+==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")
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.GetWritable(handle, "property")</pre>
+''<span style="color:red;">No additional examples</span>''