Modifier

Partager via

FieldMetadata type

  • Article

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 field metadata.

Hierarchy

InputControlMetadata
   └─ FieldMetadata

Index

Properties

Properties

BoundEntity

BoundEntity: string (optional)

The entity to which the control is bound.

Inherited from ControlMetadata.BoundEntity

BoundField

BoundField: string (optional)

Inherited from ControlMetadata.BoundField

DecimalPlaces

DecimalPlaces: number (optional)

The number of decimals that appear on a field of type "Real". Default = 2; number must be in the range [0:20].

Description

Description: string (optional)

Description of the control.

Inherited from ControlMetadata.Description

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.

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

Formatting

Formatting: any (optional)

Formats a field of type "DateTime" or "Date". Note: if browser does not support toLocaleString with options then it will show the entire value.
The options for Formatting depends on the Style that has been chosen: Style: "DateOnly" options, Style: "TimeOnly" options, and options for no style.


Example 1: { Style: "TimeOnly", Formatting: { timeZone: "UTC", timeZoneName: "short" } }


Example 2: { Style: "DateOnly", Formatting: { month: "long", day: "numeric" } } result: March 2

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

LinkType

LinkType: "Telephone" | "Email" | "Url" (optional)

Assigning the link type of a field allows for the appropriate mobile application to be opened when the link is selected.

Mandatory

Mandatory: boolean (optional)

If set to true then input for the control is required for the task to be completed. Mandatory controls will have a red outline.

Inherited from InputControlMetadata.Mandatory

Name

Name: string (optional)

Name of a control.

Inherited from ControlMetadata.Name

NumSequence

NumSequence: NumberSequenceConfig (optional)

Used for auto detecting and changing visibility of the number sequence controls in the task or page, based on AX number sequence configuration, through extended business logic. Example:

// hide number sequence reference page from users
metadataService.hideNavigation('numSeqReferencePage');

// parameters to be passed to 'numSequence' flag in configureControl
var configParam = {
     referencePageName: 'numSeqReferencePage',
     dataType: 'HcmPersonnelNumberId'
};

// setup 'PersonnelNumber' control as number sequence in the task 'add-worker'
metadataService.configureControl('add-worker', 'PersonnelNumber', { numSequence: configParam });

Inherited from InputControlMetadata.NumSequence

Order

Order: number (optional)

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

Inherited from ControlMetadata.Order

ReferenceAppId

ReferenceAppId: string (optional)

The ID of the app that the field control lives in.

ReferencePageId

ReferencePageId: string (optional)

The ID of the page that the field control lives in.

Style

Style: string (optional)

Styles a field of type "DateTime" or "Date". Example: { Style: TimeOnly } result: 12:00:00 AM

Type

Type: ControlType (optional)

String indicating the control type.

Inherited from ControlMetadata.Type

UnWrapText

UnWrapText: boolean (optional)

False by default -- text of the page will be wrapped.

WrapText

WrapText: boolean (optional)

If true then the text of the field control will wrap to the next line.