DataGridColumn::DisplayIndex Property

 

Gets or sets the display position of the column relative to the other columns in the DataGrid.

Namespace:   System.Windows.Controls
Assembly:  PresentationFramework (in PresentationFramework.dll)

public:
property int DisplayIndex {
	int get();
	void set(int value);
}

Property Value

Type: System::Int32

The zero-based position of the column, as it is displayed in the associated DataGrid. The registered default is -1. For information about what can influence the value, see DependencyProperty.

The DisplayIndex property has a default value of -1 before it is added to the DataGrid::Columns collection. This value is updated when the column is added to the DataGrid.

The DataGrid requires that the DisplayIndex property of each column must be a unique integer from 0 to the Count of Columns -1. Therefore, when the DisplayIndex of one column changes, the change typically causes the DisplayIndex of other columns to also change.

The restrictions on the DisplayIndex value are enforced by a ValidateValueCallback mechanism. If you attempt to set a value that is not valid, a run-time exception is thrown.

When the value of the DisplayIndex property is changed, the DataGrid::ColumnDisplayIndexChanged event is raised.

.NET Framework
Available since 4.0
Silverlight
Available since 2.0
Return to top
Show: