ControlMetadata 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.

Interface for the metadata of a control. Overriding control metadata can modify a controls' look and behavior. Properties that can be modified vary by control but every control will have the base properties listed here.

Hierarchy

ControlMetadata
   └─ PageLinkMetadata
   └─ ContainerControlMetadata
   └─ InputControlMetadata
   └─ ImageMetadata

Index

Properties

• BoundEntity
• BoundField
• Description
• Editable
• ExtType
• HelpText
• Hidden
• Id
• Label
• Name
• Order
• Type

Properties

BoundEntity

BoundEntity: string (optional)

The entity to which the control is bound.

BoundField

BoundField: string (optional)

Description

Description: string (optional)

Description of the control.

Editable

Editable: boolean (optional)

Boolean indicating if the control is editable. False when either the control or its parent is not editable. True when both the control and its parent are editable. True when either the control or its parent is editable and the other is undefined. Undefined if both the control's edit-ability and its parent's edit-ability is undefined.

ExtType

ExtType: ControlType (optional)

The extended control type. For example, a control of type Input might have an extended type of Barcode.

HelpText

HelpText: string (optional)

The keyboard shortcut for a command. For example, "(Shift+F5)"

Hidden

Hidden: boolean (optional)

Boolean indicating if the control is hidden or not.

Id

Id: string (optional)

Identification string for a control.

Label

Label: string (optional)

Label for a control. For example, a control representing a person's first name might have a label "First Name".

Name

Name: string (optional)

Name of a control.

Order

Order: number (optional)

Number indicating the order in which a control will appear on a page.

Type

Type: ControlType (optional)

String indicating the control type.