ContainerControl type
Important
The finance and operations (Dynamics 365) mobile app and platform are no longer supported. The platform components supporting the mobile app will be removed in a future update. The mobile app has also been removed from app stores. Previously installed instances of the app will continue to work. For more information, see Removed or deprecated platform features.
Container control interface with methods and attributes for all container controls. A container control can contain any number of controls.
Hierarchy
Control
└─ ContainerControl
└─ Group
└─ List
└─ Part
Index
Properties
Methods
Properties
container
container: boolean
True if the control is a container.
generic
generic: boolean (optional)
getDataSource
getDataSource: function(): any
Inherited from Control.getDataSource
hidden
hidden: boolean
True if the control is hidden.
Methods
applyDesign
applyDesign(design: Design): void
Applies given design to the design on the control. If a design already exists, the prototype chain of the design will be preserved.
Inherited from Control.applyDesign
Parameters
| Name | Type | Description |
|---|---|---|
| design | Design | object containing design properties as keys |
Returns void
dataContext
dataContext(): any
Inherited from Control.dataContext
Returns any
getControl
getControl(controlName: string): Control
Given the name of a control, returns the control instance.
Parameters
| Name | Type | Description |
|---|---|---|
| controlName | string | control name |
Returns Control
getControlById
getControlById(id: string): Control
Given the ID of a control, returns the control instance.
Parameters
| Name | Type | Description |
|---|---|---|
| id | string | control ID |
Returns Control
getDesign
getDesign(): Design
Returns the design object of this control.
Returns Design
isEditable
isEditable(): boolean
Boolean indicating if the control is editable. Returns false when either the control or its parent is not editable. Returns true when both the control and its parent are editable. Returns true when either the control or its parent is editable and the other is undefined. Returns undefined if both the control's edit-ability and its parent's edit-ability is undefined.
Inherited from Control.isEditable
Returns boolean
metadata
metadata(): ContainerControlMetadata
Returns the metadata object of this control.
Returns ContainerControlMetadata
parent
Returns the parent (control or page) of this control.
Returns Control | Page
root
root(): Page
Returns the root form instance (page) of this control.