Extended Data Type Properties

  • Article

Applies To: Microsoft Dynamics AX 2012 R2, Microsoft Dynamics AX 2012 Feature Pack, Microsoft Dynamics AX 2012

Extended data type (EDT) properties are divided into the following groups:

  • Common to all EDTs

  • Available only for certain base data types

Properties Common to All EDTs

Property

Description

New in this version of
 Microsoft Dynamics AX

Alignment

Changes the alignment of the text (Left, Right, Center).

AnalysisDefaultSort

Specifies the default sort order for a field in a report model with this EDT.

AnalysisDefaultTotal

Determines the aggregate function for a measure. Use this property when AnalysisUsage is set to Measure. You can specify one of the following values.

  • Sum - Returns the sum of all the values in a set.

  • Count - Returns the number of non-null items in a set.

  • CountDistinct - Returns the number of distinct non-null items in a set.

  • Min - Returns the minimum value in a set.

  • Max - Returns the maximum value in a set.

  • None - No aggregate function is applied.

  • Auto - Applies to derived EDTs. The value of the AnalysisUsage property for the parent EDT is to be used.

The aggregate function can be overridden at the field level. That is, you can change the aggregate function for the field using the AnalysisDefaultTotal property for the field.

AnalysisGrouping

Specifies whether a field that has this EDT is grouped by default when the field is added to a report using the Report Builder for Microsoft SQL Server Reporting Services.

The property is automatically set to Discouraged for currency amounts. For other fields that are unique, you should set the property to Discouraged. For more information about report models, see "Generate and publish report models" in the Help menu for System and Application Setup.

AnalysisUsage

Identifies the role of the EDT in a cube. This setting is automatically propagated to all table fields that reference the EDT. However, the setting can be overridden on the table field. Specify one of the following values.

  • Attribute - A field that references the EDT is a dimension attribute.

  • Measure - A field that references the EDT is a measure.

  • Both - A field that references the EDT is both a dimension attribute and a measure.

  • None - A field that references the EDT is not a dimension attribute and not a measure.

  • Auto - Applies to derived EDTs. The value of the AnalysisUsage property for the parent EDT is to be used.

Note

EDTs that are based on enumerations cannot be measures.

ArrayLength

Read-only property.

By default, the ArrayLength is 1. To add array elements to the EDT, right-click the Array Element node and select New Array Element. The value of the ArrayLength property will increase to reflect this.

ButtonImage

Specifies the image to be displayed when the EDT is used for a lookup button on a form.

The possible values are as follows:

  • Arrow (default)

  • Mail (possible use: the e-mail type)

  • URL (possible use: the URL type)

  • ThreeDots (...)

  • OpenFile (possible uses: the FilenameOpen and FilenameSave types)

  • Calendar (possible use: date types)

CollectionLabel

Specifies the label that is used to display the plural name of a field that has this EDT.

ConfigurationKey

Specifies the configuration key for the EDT.

CountryRegionCodes

Specifies the country region codes where the menu is applicable or valid. The client uses this property to enable or disable country or region specific features. This is implemented as a comma-separated list of ISO country codes in a single string. The values must match data that is contained in the global address book.

AX 2012

DisplayLength

Specify a maximum number of characters to be displayed in a form or report.

EnumType

Specifies an enumerated data type. If an EDT is of type enum, it is mandatory to set the EnumType property.

Extends

Enables you to base the EDT on another EDT.

FormHelp

Specifies a form that will be used when you perform lookup from a field in a form.

HelpText

Creates a Help string for the EDT. The Help string is displayed when the type is used in a form.

ID

Read-only property.

Label

Specifies a label for the type that is shown when the type is used in a form or report.

Model

Specifies which model the table is in.

A model is a logical grouping of elements in a layer. An element can exist in exactly one model in a layer. Examples of elements are a table or class. The same element can exist in a customized version in a model in a higher layer.

AX 2012

Name

Specifies the name of the type.

The name is used when it refers to the type from X++.

PresenceClass

Identifies the X++ class that will be used with the PresenceMethod to return a PresenceInfo object instance.

AX 2012

PresenceIndicatorAllowed

Specifies whether the control referencing the EDT will use presence. Default value is Yes.

AX 2012

PresenceMethod

Identifies the X++ static class method in PresenceClass to be called with a controls data value; this returns a PresenceInfo object instance that contains the data needed by the Presence indicator.

AX 2012

ReferenceTable

Identifies the table that is referenced by this EDT, and which has the primary key.

Indicates the primary key table which this EDT references.

AX 2012

Style

Changes the default display of the EDT. Options Are:

  • Auto

  • Combo box

  • Radio button

AX 2012

For rules and hints about how to set these properties, see Best Practice for extended data types.

Properties that are only Available for Certain Base Data Types

Leave these properties set to Auto unless specified otherwise in the following table.

Property

Exists for these types:

Description

Adjustment

String

For fixed length strings, this specifies whether the entered characters will be stored on the left or the right side of the padding spaces.

Values are Left or Right. The default value is Left.

AllowNegative

Integer

Int64

Real

Specifies whether the field can accept negative values.

AutoInsSeparator

Real

Specifies whether the system inserts a decimal separator automatically. For example, if you enter 2222, the system automatically shows 2222.00.

ChangeCase

String

Specifies how text entered in a string control should be formatted. This property is not supported for Enterprise Portal.

For example, the text can be formatted as uppercase, or with title capitalization.

DateDay

Date

UtcDateTime

Specifies how the day should be displayed.

DateFormat

Date

UtcDateTime

Specifies the layout of a date.

DateMonth

Date

UtcDateTime

Specifies how the month should be displayed.

DateSeparator

Date

UtcDateTime

Specifies the separators between year, month, and day.

DateYear

Date

UtcDateTime

Specifies how the year should be displayed.

DecimalSeparator

Real

Specifies the decimal separator. The default (Auto) setting is whatever is specified in the system setup.

DisplaceNegative

Integer

Int64

Real

Specifies if negative numbers should be indented to the left.

DisplayHeight

String

Specifies the number of lines to be displayed simultaneously when the EDT is displayed in a form.

EnumType

Enum

Specifies the base enum used to create the EDT.

FormatMST

Real

Specifies how to format master currency values.

The following list contains the possible values for this property:

  • Auto

  • Yes

  • No

The default value is Auto.

NoOfDecimals

Real

Determines the number of decimals when a value displays on a form or a report.

RotateSign

Integer

Int64

Real

Choose this to negate the number, that is, change - to + and + to -.

ShowZero

Integer

Int64

Real

Specifies whether the value zero should be shown as an empty field.

If the value zero in fields of this kind means null/nothing, ShowZero set to No.

SignDisplay

Integer

Int64

Real

Specifies whether the sign of a number should be displayed, if it is a negative number, and also whether the sign should be before or after the number.

Normally set to Auto. Can be set to None if they are used with DisplaceNegative.

StringSize

String

Specifies the maximum size of the string.

ThousandSeparator

Real

Specifies the thousand separator.

TimeFormat

Time

UtcDateTime

Specifies how times should be formatted.

TimeHours

Time

UtcDateTime

Specifies whether hours should be included.

TimeMinute

Time

UtcDateTime

Specifies whether minutes should be included.

TimeSeconds

Time

UtcDateTime

Specifies whether seconds should be included.

TimeSeparator

Time

UtcDateTime

Specifies the separator that must be used when displaying times.

TimezonePreference

UtcDateTime

Specifies the time zone that the value should be converted to from Coordinated Universal Time (UTC).

For more information, see Form Control Properties.

See also

How to: Create an Extended Data Type

Best Practices for Extended Data Type Properties