Form Design Properties

  • Article

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

Most properties on the form Design node also exist on the individual controls, for example, the Width and Height properties.

When you set a property on the Design node, however, as opposed to setting it on a control, the setting affects the entire form.

A few properties exist only on the Design node. They are described in the following table.

Property

Description

New in this version of
 Microsoft Dynamics AX

AlignChild

Specifies whether a control within a group follows the AlignChildren property setting for the group or the overall form design. For example, if AlignChildren is set to Yes on the form Design node, you might not want a particular group to be arranged with the other groups. In that case, set AlignChild for that group to No.

AX 2012

AlignChildren

Aligns the child controls within a container.

AX 2012

AllowDocking

Specifies whether or not a form may be attached to the client workspace. The default value is No.

AX 2012

AllowFormCompanyChange

Specifies whether the form supports company changes when used as a child form with a cross-company dynalink. The default value is No.

AX 2012

AllowUserSetUp

Specifies whether a user can move controls on a form, and whether a user can change the value of control properties. This property is also found on the design of a form. The property has the following values: AllowUserSetup

  • No – users cannot customize any controls in this container.

  • Restricted – users can change properties of individual controls, but cannot move controls.

  • Yes – no restrictions on user setup.

The default value is Yes.

Caution

Full user setup is not allowed if any of the parent containers for the control have restrictions on the user setup level. The AllowAdd property on form data sources determines whether a user can add a field to a form.

AX 2012

AlwaysOnTop

Specifies whether the form is always displayed on top of other windows in the z-order. The default value is No.

AX 2012

ArrangeMethod

Specifies whether child field groups should be arranged in columns or in rows.

AX 2012

ArrangeWhen

Specifies when to arrange the controls in the container. The options are as follows:

  • Startup

  • On demand

  • Never

  • Default

  • Auto

The default value is Startup.

AX 2012

BackgroundColor

Determines the color used for the background of the control. To set the background to opaque or transparent, use the BackStyle property.

AX 2012

BottomMargin

Sets in pixels the bottom margin of the form. The default value is Auto.

AX 2012

Caption

Specifies the heading for grouped controls. Use a label for this property.

AX 2012

ColorScheme

Specifies the color palette for the control. To change the color palette for an entire form, set the ColorScheme property for the largest container and keep the default values for the individual controls.

AX 2012

Columns

Specifies the number of columns that display the information.

Caution

Field groups on the underlying table are never split into more than one column.

AX 2012

ColumnSpace

Sets the amount of space between columns in container controls.

AX 2012

DataSource

Determines which table data is displayed from in the control. To set a particular field within this table, use the DataField property. If the control opens another form, relations between the data source specified here for the control and the data source on the other form will ensure that records in the second form are dynamically selected. For example, if a customer is selected in one form, and the control opens up a form showing customer transactions, a range of customer transactions applying to the current customer would be displayed in the second form.

Caution

If you set the DataSource and DataField properties, this will override any settings made on the DataMethod or ExtendedDataType properties.

AX 2012

Font

Enables you to select another font for the control by opening the Font dialog. Use the dialog to specify the Font, Font style, , and Size properties of the font.

AX 2012

Frame

Specifies the frame style used by the form.

Height

Specifies the height of the form or control. The height is specified in pixels.

AX 2012

HideIfEmpty

Enables you to hide a container control if it is empty. This property has no affect if the container control has its Width and Height properties set to Auto because the size of the control is then zero.

AX 2012

HideToolBar

Hides form-specific buttons on the toolbar.

ImageMode

Defines how the bitmap specified by the ImageName property appears in a control. The options are as follows:

  • Normal

  • Size to fit

  • Side by side

  • Center

The default value is Normal.

AX 2012

ImageName

Specifies the image that is displayed for a control. You can select only .bmp files. To use one of the Microsoft Dynamics AX resource files, use the ImageResource property instead.

AX 2012

ImageResource

Specifies the image from the image resource file that is displayed for a control. Specify the ID of the image. You can select only an image from the integrated resource file. To use another file type, use the ImageName property.

AX 2012

LabelFont

Changes the font for the text supplied in the Label property.

AX 2012

Left

Changes the position of the uppermost left corner of the form. There are a number of predefined settings. You can also specify an exact position in pixels. The predefined settings include the following:

  • Auto (left)

  • Auto (right)

  • Left edge

  • Right edge

  • Center

The default value is Auto (left).

AX 2012

LeftMargin

Changes the default left margin of the form The margin is specified in pixels.

AX 2012

MaximizeBox

Specifies whether to include the maximize box in the upper-right corner of the enclosing window. The default value is Yes.

AX 2012

MinimizeBox

Specifies whether to include the minimize box in the upper-right corner of the enclosing window. The default value is Yes.

AX 2012

Mode

Determines the data entry mode for the form.

Model

Specifies the model that the form is in.

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

AX 2012

RightMargin

Changes the default right margin of the form. The margin is specified in pixels.

AX 2012

SaveSize

The size of the form is saved if the property is set to Yes.

AX 2012

ScrollBars

Determines whether scroll bars are enabled on the form.

AX 2012

SetCompany

Causes the system to change the company when the form gets focus.

Note

If the SaveDataPerCompany property on a table is set to Yes, the SetCompany property on a form design that uses the table as a data source must also be set to Yes.

StatusBarStyle

Determines how to display the status bar on a form. Use this property to hide the status bar, display only help information, display status bar elements based on the WindowType, or to always display the full status bar.

Note

Forms with a WindowType of ListPage, ContentPage, or Workspace ignore this property.

Style

Specifies the style of the form. This property controls the form design pattern being used with the form. The styles include the following:

  • Auto

  • DetailsFormMaster

  • DetailsFormTransaction

  • Dialog

  • DropDialog

  • FormPart

  • ListPage

  • Lookup

  • SimpleList

  • SimpleListDetails

  • TableOfContents

The default is Auto.

AX 2012

TitleDataSource

Determines the data source to be used in the form caption.

Top

Changes the position of the top of the form. There are a number of predefined settings or you can specify in pixels an exact position. The predefined settings are as follows:

  • Auto

  • Top edge

  • Bottom edge

  • Center

The default value is Auto.

AX 2012

TopMargin

Sets in pixels the top margin of the form. The default value is Auto.

AX 2012

UseCaptionFromMenuItem

Specifies whether to replace the form caption with the label from the calling menu item.

Enables the caption of the form to be changed when the form is opened. The default value is No.

AX 2012

ViewEditMode

Specifies whether the form opens in a read-only mode or as a form that allows you to change fields. The options are as follows:

  • View - Opens as read-only.

  • Edit - Opens in edit mode.

  • Auto - Opens in appropriate mode.

The default is Auto.

AX 2012

Visible

Enables you to hide the Form.

Caution

You cannot use the Visible property to enforce access restrictions. The user can change the visibility for the controls in the Form Setup dialog. Use the Enabled and NeededAccessLevel properties instead.

AX 2012

Width

Changes the width in pixels of the form.

AX 2012

WindowResize

Determines whether forms can be resized.

WindowType

Specifies the window type.

WorkflowDataSource

Sets root data source for workflow on a form. This should be the same root data source specified in the query used for the Document property on the workflow template. For more information, see How to: Create a Workflow Document Class.

WorkflowEnabled

Enables the workflow menu bar on the form when set to Yes. The default value is No.

WorkflowType

Specifies the workflow type, which determines the following items:

  • The workflow document to use. The workflow document exposes calculated fields and identifies the query that exposes data fields for the workflow.

  • Whether tasks and approvals can be configured by the end user.

  • The Workflow categories to use when assigning a workflow type to a specific module.

  • Menu items and event handlers.

AX 2012

See also

Form Control Properties

Best Practices for Form Design Properties

Announcements: New book: "Inside Microsoft Dynamics AX 2012 R3" now available. Get your copy at the MS Press Store.