Best Practices: List Pages

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

Microsoft Dynamics AX conducts a best practices check of new or modified list pages. The best practice checks seek to establish a common look and behavior for all list pages. For more information about best practice checks, see Best Practices for Microsoft Dynamics AX Development.

Best Practice Checks

The following table lists the best practices error messages for list pages.

Message

Message type

How to fix the error or warning

List Pages must have a name that ends with "ListPage".

Warning

Append ListPage to the value of the form Name property.

List Pages must have their TopMargin property set to "Auto".

Warning

Set the value of the TopMargin property in the form Design node to Auto.

List Pages must have their BottomMargin property set to "Auto".

Warning

Set the value of the BottomMargin property in the form Design node to Auto.

List Pages must have their LeftMargin property set to "Auto".

Warning

Set the value of the LeftMargin property in the form Design node to Auto.

List Pages must have their RightMargin property set to "Auto".

Warning

Set the value of the RightMargin property in the form Design node to Auto.

List Page datasources must have their AllowEdit property set to "No".

Warning

Set the value of the AllowEdit property in the list page data source to No.

List Page datasources must have their AllowCreate property set to "No".

Warning

Set the value of the AllowCreate property in the list page data source to No.

List Page datasources must have their StartPosition property set to "First".

Warning

Set the value of the StartPosition property in the list page data source to First.

A List Page must have a single Action Pane.

Warning

If the list page does not include an ActionPane, add an ActionPane control to the Design node of that list page.

If the list page includes more than one ActionPane, remove all except one ActionPane control from the Design node of that list page.

An Action Pane should not be present on a form that isn't a List Page or Content Page.

Warning

Remove the ActionPane control from the Design node of the form. Or, set the WindowType property in the Design node of the form to ListPage or ContentPage.

A List Page must have a grid.

Warning

Add a Grid control to the Design node of the list page.

List Page grids must have their AllowEdit property set to "No".

Warning

Set the value of the AllowEdit property of the Grid control to No.

List Page grids must have their Width property set to "Column width".

Warning

Set the value of the Width property of the Grid control to Column width.

List Page grids must have their Height property set to "Column height".

Warning

Set the value of the Height property of the Grid control to Column height.

List Page grids must have their ShowRowLabels property set to "Yes".

Warning

Set the value of the ShowRowLabels property of the Grid control to Yes.

List Page grids must have their Datasource property set to a valid datasource.

Warning

Set the value of the DataSource property of the Grid control to the name of a data source for that list page.

List Page grids must have their DefaultAction property set to a button on the form. The DefaultAction property should normally point to a button that performs the "Open" action.

Warning

Set the value of the DefaultAction property of the Grid control. Specify the name of an action pane button.

List Page Action Panes must have their Width property set to "Column width".

Warning

Set the value of the Width property of the ActionPane control to Column width.

A document handling button on an Action Pane should use the label @SYS114630 for its Text property.

Warning

Use the specified Label ID value for the Text property of a document handling button.

A document handling button on an Action Pane should have its Name property set to "Attachments".

Warning

Set the value of the Name property of the document handling button to Attachments.

All buttons on an Action Pane should have their ShowShortcut properties set to "No" to suppress the addition of extra characters for mnemonic usage.

Warning

Set the value of the ShowShortcut property of the action pane button control to No.

List Page controls must not have any vertical spacing between them.

Warning

Set the value of the VerticalSpacing property of the control to Auto or 0. Use Auto whenever possible.

List Pages must have their TitleDatasource property set.

Warning

Set the value of the TitleDataSource property in the form Design node to the name of a list page data source.

List Page Action Panes must have their VerticalSpacing property set to zero.

Warning

Set the value of the VerticalSpacing property of the ActionPane control to Auto or 0. Use Auto whenever possible.

See also

List Page Overview

How to: Create a List Page Form

How to: Add a Data Source to a Primary List Page

How to: Add Fields to the List Page Grid

Walkthrough: Creating a List Page and Adding an Action Pane

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