Container module (Client APIs)
Important
The finance and operations (Dynamics 365) mobile app and platform have been deprecated. For more information, see Removed or deprecated platform features.
A container control can contain any number of controls.
Index
Types
Types
ContainerControl
Hierarchy
Control
└─ ContainerControl
└─ Group
└─ List
└─ Part
Properties
Name | Signature | Description |
---|---|---|
container | container: boolean |
True if the control is a container. Overrides Control.container |
generic | generic: boolean (optional) |
Inherited from Control.generic |
getDataSource | getDataSource: function(): any |
Inherited from Control.getDataSource |
hidden | hidden: boolean |
True if the control is hidden. Inherited from Control.hidden |
Methods
Name | Signature | Description |
---|---|---|
applyDesign | applyDesign(design: Design): void | Applies given design to the design on the control. Inherited from Control.applyDesign |
dataContext | dataContext(): any | Inherited from Control.dataContext |
getControl | getControl(controlName: string): Control | Given the name of a control, returns the control instance. |
getControlById | getControlById(id: string): Control | Given the ID of a control, returns the control instance. |
getDesign | getDesign(): Design | Returns the design object of this control. Inherited from Control.getDesign |
isEditable | isEditable(): boolean | Boolean indicating if the control is editable. Inherited from Control.isEditable |
metadata | metadata(): ContainerControlMetadata | Returns the metadata object of this control. Overrides Control.metadata |
parent | parent(): Control | Page | Returns the parent (control or page) of this control. Inherited from Control.parent |
root | root(): Page | Returns the root form instance (page) of this control. Inherited from Control.root |
ContainerControlDesign
Hierarchy
Design
└─ ContainerControlDesign
└─ GroupDesign
└─ ListDesign
└─ PartDesign
Properties
Name | Signature | Description |
---|---|---|
alignItems | alignItems: string (optional) |
This property is an alias for the CSS property "align-items". Inherited from Design.alignItems |
alignSelf | alignSelf: string (optional) |
Inherited from Design.alignSelf |
allowScroll | allowScroll: string (optional) |
True if the container will allow scrolling when its items do not fit into the container's available space. If a container has an item which may scroll, then set this property to false to prevent nested scrolling areas. |
background | background: string (optional) |
The background color of the container. |
bindings | bindings: any (optional) |
Inherited from Design.bindings |
border | border: "none" | "solid" | "left" | "right" | "top" | "bottom" (optional) |
The border behavior of a control. This property will not be inherited by the children. Inherited from Design.border |
color | color: string (optional) |
The foreground color of the container. Inherited from Design.color |
flexFlow | flexFlow: string (optional) |
Specifying this property makes the component a flex container component. Inherited from Design.flexFlow |
flexSize | flexSize: string (optional) |
One number or two numbers written as a string. For example, "(size to grow) [(size-to-shrink)]" to accommodate available space in the immediate flex container. Inherited from Design.flexSize |
fontSize | fontSize: "medium" | "xx-small" | "x-small" | "small" | "large" | "x-large" | "xx-large" (optional) |
The proportional text size Inherited from Design.fontSize |
fontWeight | fontWeight: "normal" | "bold" (optional) |
Normal or bold text. Inherited from Design.fontWeight |
itemBorder | itemBorder: "solid" | "none" (optional) |
If true, a border will appear around each row in the list. |
items | items: string | Design [ ] (optional) |
An array containing the components to place inside of the container. |
justifyItems | justifyItems: "flex-start" | "flex-end" | "center" | "space-between" (optional) |
This property is an alias for the CSS property "justify-content". Inherited from Design.justifyItems |
label | label: string (optional) |
Inherited from Design.label |
labelPosition | labelPosition: "stacked" | "hidden" | "inline" (optional) |
Determines how a label is positioned, if at all. By default, labelPosition is set to stacked. Inherited from Design.labelPosition |
name | name: string (optional) |
Inherited from Design.name |
padding | padding: "none" | "small" | "std" (optional) |
Allows specifying the component's padding behavior. Inherited from Design.padding |
type | type: ControlType (optional) |
The type of the control as a string. Inherited from Design.type |
ContainerControlMetadata
Hierarchy
ControlMetadata
└─ ContainerControlMetadata
└─ GroupMetadata
└─ ListMetadata
└─ PartMetadata
Properties
Name | Signature | Description |
---|---|---|
BoundEntity | BoundEntity: string (optional) |
The entity to which the control is bound. Inherited from ControlMetadata.BoundEntity |
BoundField | BoundField: string (optional) |
Inherited from ControlMetadata.BoundField |
Description | Description: string (optional) |
Description of the control. Inherited from ControlMetadata.Description |
Editable | Editable: boolean (optional) |
Boolean indicating if the control is editable. Inherited from ControlMetadata.Editable |
ExtType | ExtType: ControlType (optional) |
The extended control type. For example, a control of type Input might have an extended type of Barcode. Inherited from ControlMetadata.ExtType |
HelpText | HelpText: string (optional) |
The keyboard shortcut for a command. For example, "(Shift+F5)" Inherited from ControlMetadata.HelpText |
Hidden | Hidden: boolean (optional) |
Boolean indicating if the control is hidden or not. Inherited from ControlMetadata.Hidden |
Id | Id: string (optional) |
Identification string for a control. Inherited from ControlMetadata.Id |
Label | Label: string (optional) |
Label for a control. For example, a control representing a person's first name might have a label "First Name". Inherited from ControlMetadata.Label |
Name | Name: string (optional) |
Name of a control. Inherited from ControlMetadata.Name |
Order | Order: number (optional) |
Number indicating the order in which a control will appear on a page. Inherited from ControlMetadata.Order |
Type | Type: ControlType (optional) |
String indicating the control type. Inherited from ControlMetadata.Type |