Parameter.getControlProperties Method

Called to get the object with the list of properties on the root control, or any sub-element of the control.

Parameters

path

Type: Array
ElementType: PropertyPathItem
(optional) The path to the sub-element of this control. Undefined if the root is requested, otherwise an array of plain objects with properties.
Optional: True

options

Type: Object

(optional) The options in which to get the control properties. Structure:
     doNotRecord             [type: Boolean, optional: true]             - (optional) True to generate control properties that do not record any adapter state for undo/redo-ability.
     isSimpleMode            [type: Boolean, optional: true]             - (optional) True to get the 'simple' properties for displaying the quick access property editor.

Optional: True

Return Value

Type: ObjectDescriptor
An object with the list of properties on the desired element.