Report Control Properties

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

The following table describes report control properties. For information about additional properties available for controls, see Form Control Properties.

Property

Description

New in this version of
 Microsoft Dynamics AX

Alignment

Specifies the alignment of a value displayed in a control.

AllowNegative

Specifies whether the control accepts negative values.

This property is available only for integer and real controls.

ArrayIndex

Specifies the array element that displays in a control. The control is based on an extended data with array elements.

This property is not available for text and shape controls.

AutoDeclaration

Specifies whether a variable is created that has the same name as the control.

When you set this property to Yes, it is easier to access the report controls from X++ code, and you can find errors at compile time.

AutoInsSeparator

Specifies whether a decimal separator is displayed.

This property is available only for real controls.

BackgroundColor

Specifies the background color for a color. This property setting can be overridden by using the BackStyle property.

BackStyle

Specifies whether the control background is opaque or transparent.

For bitmap controls, when the property is set to Transparent, pixels that have the same color are transparent. For all other controls, when the property is set to

Transparent, the foreground color is used as the background color.

Bold

Specifies text formatting.

BottomMargin

Specify the margin for a control.

ChangeCase

Specifies the case of text that a user enters.

This property is available only for string, enum, text, and prompt controls.

ChangeLabelCase

Specifies whether the label for the control should be modified when the report is printed. Options are as follows:

  • Auto

  • None

  • UPPER CASE

  • lower case

  • Title Case

The default value is Auto.

AX 2012

ColorScheme

Specifies the color palette for a control.

ConfigurationKey

Enables you to specify a configuration key for the control.

CSSClass

Specifies the cascading style sheet that will be used when rendering the value in HTML.

AX 2012

DataField

Specifies a table field for the control.

This property is not available for text, shape, box, and bitmap controls.

DataMethod

Specifies a display method that displays data in a control.

This property is not available for text, shape, and box controls.

DateDay

Specifies the format for the day.

This property is available only for date controls.

DateFormat

Specifies the format for a date.

This property is available only for date controls.

DateMonth

Specifies the format for the month.

This property is available only for date controls.

DateSeparator

Specifies the separator that appears between the month, day, and year.

This property is available only for date controls.

DateYear

Specifies the format for the year.

This property is available only for date controls.

DecimalSeparator

Specifies the symbol used to separate decimals.

This property is available only for real controls.

DisplaceNegative

Specifies a new position for a value in a grid control when the value is a negative number.

This property is available only for integer and real controls.

DynamicHeight

Specifies whether the control is resized to display additional lines of text. When this property is set to Yes, page headers, page footers, and repeating columns headings are automatically added as needed.

This property is available only for string controls.

ExtendedDataType

Specifies an extended data type on which to base the field associated with the control.

ExtraSumWidth

Modifies the default width allowed for sums.

This property is available only for integer and real controls.

Font

Specifies text formatting.

FontSize

Specifies text formatting.

ForegroundColor

Specifies the foreground color for a control.

FormatMST

Specifies whether values are formatted using standard currency format.

This property is available only for real controls.

Height

Specify the height of a control.

When a control is associated with an extended data type, the Height property of the control overrides the DisplayLength property of the extended data type.

If you set the Height property to Auto for a bitmap control, the size of the control is based on the size of the graphic.

ImageName

Specifies the file name for an image.

This property is available only for bitmap controls.

ImageResource

Specifies an ID for a system resource to display. The resource macro provides a list of these IDs. Macros are in the Application Object Tree (AOT) under the Macros node.

This property is available only for bitmap controls.

Italic

Specifies text formatting.

Label

Enables you to specify a title for the control.

If the label is not specified here, it is inherited from the field.

LabelBold

Sets or returns a value that indicates the bold setting for the label in the control.

AX 2012

LabelCSSClass

Specifies the cascading style sheet that will be used when rendering the label in HTML.

AX 2012

LabelFont

Sets or returns a string data type value that indicates a font for the label text in a form combo box control.

AX 2012

LabelFontSize

Sets or returns the font size in points for the label text in a form combo box control.

AX 2012

LabelItalic

Sets or returns a value that indicates whether the text in the control label should be italic.

AX 2012

LabelLineBelow

Specifies the format of the underline for the control title.

LabelLineThickness

Specifies the format of the line below column headings.

LabelPosition

Sets or returns the position of the label for the control. Valid values are Left or Above.

AX 2012

LabelTabLeader

Specifies whether control labels should be shown with or without a series of dots appended. The options are as follows:

  • Auto

  • Do not append

  • Do append

The default value is Auto.

AX 2012

LabelUnderline

Sets or returns a value that indicates whether the text in the control label is underlined.

AX 2012

LabelWidth

Specifies the width of the label for the control.

AX 2012

Left

Specify the left alignment of a control.

LeftMargin

Specify the margin for a control.

Line

Specifies the appearance of the lines that form a shape.

This property is available only for shape controls.

LineAbove

Specify the type of line for a control border.

If your report has many lines or boxes, consider using a shape control inside the individual sections.

LineBelow

Specify the type of line for a control border.

If your report has many lines or boxes, consider using a shape control inside the individual sections.

LineLeft

Specify the type of line for a control border.

If your report has many lines or boxes, consider using a shape control inside the individual sections.

LineRight

Specify the type of line for a control border.

If your report has many lines or boxes, consider using a shape control inside the individual sections.

MenuItemLabel

Specifies the label for a menu item.

MenuItemName

Specifies the name of the menu item.

The available menu items in the property list vary depending on the setting of the MenuItemType property.

MenuItemType

Specifies whether the menu item is an action, display, or output menu item. A display menu item is for a form, and an output menu item is for a report. An output menu item is for a class, job, or query.

MinNoOfDecimals

Specifies the minimum number of decimals displayed. Trailing zeros are not displayed.

ModelFieldName

Specifies a field that is used to determine the left alignment and width of a control.

NoOfDecimals

Specifies the number of decimals displayed. The default is 20.

This property is available only for real controls.

ResizeBitmap

Specifies whether an image can be resized to fit the dimensions of a control.

This property is available only for bitmap controls.

RightMargin

Specify the margin for a control.

RotateSign

Specifies whether the sign for the control is inverted.

This property is available only for integer and real controls.

ShowLabel

Sets or returns a value that indicates whether the label for the control is displayed on the form. True if the label is set to display; otherwise False.

AX 2012

ShowPicAsText

Specifies whether the file name for an image instead of the image is displayed.

This property is available only for bitmap controls.

ShowZero

Specifies whether a 0 value is displayed.

This property is available only for integer and real controls.

SignDisplay

Specifies how the sign of a number is displayed.

This property is available only for integer and real controls.

SumAll

Specifies whether the sum of all values is calculated.

This property is available only for integer and real controls.

SumNeg

Specifies whether the sum of all negative values is calculated.

This property is available only for integer and real controls.

SumPos

Specifies whether the sum of all positive values is calculated.

This property is available only for integer and real controls.

Table

Specifies a data source for the control.

This property is not available for text, shape, box, and bitmap controls.

Text

Specifies the text string that is displayed in a control.

This property is available only for text controls.

TimeFormat

Specifies a 24-hour or AM/PM format.

This property is available only for time controls.

TimeHours

Specifies whether hours are displayed.

This property is available only for time controls.

TimeMinutes

Specifies whether minutes are displayed.

This property is available only for time controls.

TimeSeconds

Specifies whether seconds are displayed.

This property is available only for time controls.

TimeSeparator

Specifies the symbol used to separate hours, minutes, and seconds.

This property is available only for time controls.

Thickness

Specifies the thickness of a control border.

ThousandSeparator

Specifies the symbol used to separate thousands.

This property is available only for real controls.

Top

Specify the top alignment of a control.

TopMargin

Specify the margin for a control.

Type

Specifies the type of shape that is displayed.

This property is available only for shape controls.

TypeHeaderPrompt

Specifies whether a line of dots is added fill the space between the control title and the control value.

This property is available only for text and prompt controls.

Underline

Specifies text formatting.

Visible

Sets or returns a value that indicates whether the control is visible. True if the control is visible; otherwise, False.

AX 2012

WarnIfMissing

Specifies whether a message is displayed if an image is missing from the report.

This property is available only for bitmap controls.

WebMenuItemName

Specifies the menu item to include in a Web menu. The possible values depend on the WebMenuItemType property setting.

AX 2012

WebMenuItemType

Specifies the type of the menu item. There are two categories of Web menu items:

  • URL

  • Action

Selecting this value first determines the list of menu item names that will appear in the WebMenuItemName drop-down list.

AX 2012

WebTarget

Specifies the location for the control in a Web report.

Width

Specifies the width of a control.

When a control is associated with an extended data type, the Width property of the control overrides the DisplayLength property of the extended data type.

If you set the Width property to Auto for a bitmap control, the size of the control is based on the size of the graphic.

See also

How to: Create Report Links (MorphX Reporting Tools)

Report Design Properties

Report Design Section Properties

Report Properties

Report Query Properties