Export (0) Print
Expand All

AxHierarchicalGridView [AX 2012]

Updated: October 13, 2011

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

The AxHierarchicalGridView component displays data in a grid with a hierarchy. The grid supports drag-and-drop actions.

TipTip

Monitor the amount of data that is being displayed in the AxHierarchicalGridView. The performance can become reduced when a large amount of data is displayed in the control.

The AxHierarchicalGridView component has the following properties:

Accessibility

Property

Description

AccessKey

The keyboard shortcut used by the control. Not used for Enterprise Portal.

Caption

The descriptive caption associated with the control.

CaptionAlign

The alignment of the associated caption.

RowHeaderColumn

The data source field corresponding to the column that is the row header.

TabIndex

The tab order of the control.

UseAccessibleHeader

Indicates that the control should use accessible header cells in its containing table control.

Appearance

Property

Description

BackColor

This property is inherited from the base control. It is not specific to Enterprise Portal.

BackImageUrl

This property is inherited from the base control. It is not specific to Enterprise Portal.

BorderColor

This property is inherited from the base control. It is not specific to Enterprise Portal.

BorderStyle

This property is inherited from the base control. It is not specific to Enterprise Portal.

BorderWidth

This property is inherited from the base control. It is not specific to Enterprise Portal.

CssClass

This property is inherited from the base control. It is not specific to Enterprise Portal.

EmptyDataText

This property is inherited from the base control. It is not specific to Enterprise Portal.

Font

This property is inherited from the base control. It is not specific to Enterprise Portal.

ForeColor

This property is inherited from the base control. It is not specific to Enterprise Portal.

GridLines

This property is inherited from the base control. It is not specific to Enterprise Portal.

ShowFooter

When set to true, the footer containing the paging controls for the grid is displayed.

ShowHeader

When set to true, the header containing the column names is displayed.

Behavior

Property

Description

AllowDelete

When set to true, an X will be displayed on the selected line, allowing the record to be deleted.

AllowDragAndDrop

Specifies whether drag-and-drop actions are allowed for the control.

AllowEdit

When set to true, the data in the selected line can be edited.

AllowIndentation

Specifies whether rows can be indented in the control.

AllowInsert

When set to true, allows a new row to be inserted into the grid.

AllowSelection

When set to true, allows a row to be selected in the grid.

AllowSorting

When set to true, allows the items in the grid be sorted by clicking on the column headers.

AutoGenerateColumns

When set to true, columns will be automatically added to the grid for each column in the data set linked to the grid.

AutoGenerateDeleteButton

When set to true, a Delete link will appear at the beginning of each row in the grid.

AutoGenerateEditButton

When set to true, an Edit link will appear at the beginning of each row in the grid.

AutoGenerateSelectButton

When set to true, a Select link will appear at the beginning of each row in the grid.

ContextMenuName

The name of the Web Menu in the AOT that contains the menu items to be displayed for the context menu.

Enabled

Specifies whether the grid is enabled.

EnableModelValidation

Specifies whether page validation will be performed after validation is done in the model.

EnableSortingAndPagingCallbacks

Indicates whether the client script for sorting and paging should be rendered to browser clients that can support callbacks.

EnableTheming

Indicates whether the control can be themed.

EnableViewState

Specifies whether the control automatically saves its state for use in round-trips.

Filter

Not currently used.

FixedGridHeight

When set to true, specifies that the grid should show a fixed number of rows that is equal to the page size.

HierarchyExpandAtLevelOnFirstLoad

Specifies the level of hierarchy to expand up to when the control first loads data.

MinimumGridHeight

Specifies the minimum number of rows to display in the control.

SetCurrentRowOnSelection

Sets the current row in the data set when the user selects a row in the grid.

ShowContextMenu

When set to true, a context menu will be displayed when the user right-clicks the selected row in the grid.

ShowFilter

When set to true, the filter control for the grid is displayed.

ShowOnlyGridFieldsInFilter

When set to true, the filter will list only the fields that are currently displayed as grid columns.

SkinID

The SkinId of the control skin that provides the skin of the control.

ToolTip

Not used for Enterprise Portal.

UpdateOnPostBack

Indicates whether the component is updated when a postback occurs.

Visible

Indicates whether the control is visible and rendered.

Data

Property

Description

Expressions

The expressions that are bound to properties of the control.

DataKeyNames

A comma separated list of key fields in the data source.

DataMember

The table or view from the data set that is being used for the grid.

DataSourceID

Specifies the AxDataSource component that will be used by the grid to access data.

ExpansionRowProperties

Property

Description

ExpandEditableRow

Specifies whether to expand the editable row when it is displayed.

ExpansionColumnIndexesHidden

A comma-separated list of integers representing which columns to hide from the expansion row. The value 1 indicates the first column.

ExpansionTooltip

The tooltip displayed on the Expansion row link.

GridColumnIndexesHidden

A comma-separated list of integers representing which columns to hide from the main grid. The value 1 indicates the first column.

ShowExpansion

Specifies whether an expansion is available for each row in the control. When set to true, the expansion is available.

Hierarchy

Property

Description

HierarchyIdFieldName

The name of the field that uniquely identifies a row.

HierarchyIndentationWidth

Specifies the amount to indent child rows.

HierarchyParentIdFieldName

The name of the field that identifies the parent of a row.

HierarchyTitleField

The name of the field whose column will be used to render indentation and expand/collapse buttons.

Layout

Property

Description

CellPadding

The padding within cells.

CellSpacing

The spacing between cells.

Height

The height of the control.

HorizontalAlign

The horizontal alignment of the control.

Width

The width of the control.

Microsoft Dynamics AX

Property

Description

AllowPrompting

When set to true, a prompt will be shown to collect missing concrete types.

BodyHeight

Specifies the body height of the grid. Set this property when the body should have a fixed height.

ManagedWebContentItem

Specifies the User Control to display that allows the user to select the record type for the new record they are creating. This occurs only when the new type is part of a table hierarchy. If this property is not specified, the default control to select the new type is displayed.

Misc

Property

Description

ID

The programmatic name of the control.

Columns

The set of columns to be shown in the control. The Bound Field Designer used to select the columns is accessed through this property.

EditIndex

The index of the row shown in edit mode.

SelectedIndex

The index of the currently selected row.

Paging

Property

Description

AllowPaging

Specifies whether paging functionality is enabled for the grid.

PageIndex

Specifies the index of the current page.

PagerSettings

Controls the paging UI settings associated with the control.

PageSize

The number of rows from the data source to display per page.

Styles

These style properties are groups that contain multiple properties.

Property

Description

AlternatingRowStyle

The style applied to alternating rows.

DraggedRowCssClass

The style applied to rows being dragged.

EditRowStyle

The style applied to rows in edit mode.

EmptyDataRowStyle

The style applied to the row that contains the EmptyDataTemplate.

EmptyRowCssClass

Specifies the cascading style sheet class name to use for formatting an empty row.

FooterStyle

The style applied to the footer.

HeaderStyle

The style applied to the header.

PagerStyle

Controls the paging UI style for the grid.

RowStyle

The style applied to rows.

SelectedRowStyle

The style applied to the selected row.

The AxHierarchicalGridView component has the events listed in the following table.

Event

Description

AxRowCreated

Occurs after a new row is created

AxRowCreating

Occurs just before a new row is created.

DataBinding

Occurs when the server control binds to a data source.

DataBound

Occurs after the server control binds to a data source.

Disposed

Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested.

Init

Occurs when the server control is initialized, which is the first step in its lifecycle.

Load

Occurs when the server control is loaded into the System.Web.UI.Page object.

PageIndexChanged

Occurs when the page index of the control has changed.

PageIndexChanging

Occurs just before the page index of the control has changed.

PreRender

Occurs after the System.Web.UI.Control object is loaded but prior to rendering.

RowCancelingEdit

Occurs when a Cancel event is generated within the control.

RowCollapsed

Occurs after a hierarchy row is collapsed.

RowCollapsing

Occurs just before a hierarchy row is collapsed.

RowCommand

Occurs when an event is generated within the control.

RowCreated

Occurs when a row is created in the control.

RowDataBound

Occurs after a row has been data-bound.

RowDeleted

Occurs after a Delete command is executed on the data source.

RowDeleting

Occurs before a Delete command is executed on the data source.

RowDropped

Occurs when the user dropped the row and changes have been made.

RowDropping

Occurs after the user has dropped the row, but changes have not yet been made.

RowEditing

Occurs when an Edit event is generated within the control.

RowExpanded

Occurs after a hierarchy row is expanded.

RowExpanding

Occurs just before a hierarchy row is expanded.

RowIndented

Occurs after a hierarchy row is indented.

RowIndenting

Occurs just before a hierarchy row is indented.

RowInserted

Occurs after an Insert command is executed on the data source.

RowInserting

Occurs just before an Insert command is executed on the data source.

RowOutdented

Occurs after a hierarchy row is outdented.

RowOutdenting

Occurs just before a hierarchy row is outdented.

RowUpdated

Occurs after an Update command is executed on the data source.

RowUpdating

Occurs just before an Update command is executed on the data source.

SelectedIndexChanged

Occurs when a new row is selected in the control, but after the selection is complete.

SelectedIndexChanging

Occurs when a new row is selected in the control, but just before the selection occurs.

Sorted

Occurs when a column is sorted in the control, but after the sort is complete.

Sorting

Occurs when a column is sorted in the control, but before the sort occurs.

Unload

Occurs when the server control is unloaded from memory.

Community Additions

ADD
Show:
© 2014 Microsoft