API Component.Property.GetWritable: Difference between revisions

Revision as of 11:41, 16 January 2023

	GetWritable
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
- BOOL	Return

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: @@
-<sidebar>API Contents</sidebar>
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-Gets whether the property can be edited in the UI or not
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-<div style="width:25%; float:right" class="toc">
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetWritable'''
-====Class hierarchy====
+|-
-[[API Component|Component]]
+| colspan="2" | Gets whether the property can be edited in the UI or not&nbsp;
-:[[API Component.Property|Property]]
+|-
-::[[API Component.Property|GetWritable]]
+|-
-</div>
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-__TOC__
+| width="90%" | Handle
+|-
-==Parameters==
+| colspan="2" | The component handle of the property owner&nbsp;
-[[Variable Types|HANDLE]] ''Handle''
+|-
-:The component handle of the property owner
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Property
-[[Variable Types|STRING]] ''Property''
+|-
-:The textual name of the property
+| colspan="2" | The textual name of the property&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
-==Return value==
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
-[[Variable Types|BOOL]]
+|}
-Returns true if the operation is a success, else false