DataGridViewBand.Index Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets the relative position of the band within the DataGridView control.
public:
property int Index { int get(); };
[System.ComponentModel.Browsable(false)]
public int Index { get; }
[<System.ComponentModel.Browsable(false)>]
member this.Index : int
Public ReadOnly Property Index As Integer
Property Value
The zero-based position of the band in the DataGridViewRowCollection or DataGridViewColumnCollection that it is contained within. The default is -1, indicating that there is no associated DataGridView control.
- Attributes
Examples
The following code example uses the Index property to set column labels. The band's Index property is accessed through a DataGridViewColumn.
Note
If visual styles are enabled, the current theme overrides the display style properties for row and column headers.
// Style and number columns.
void Button8_Click( Object^ /*sender*/, EventArgs^ /*args*/ )
{
DataGridViewCellStyle^ style = gcnew DataGridViewCellStyle;
style->Alignment = DataGridViewContentAlignment::MiddleCenter;
style->ForeColor = Color::IndianRed;
style->BackColor = Color::Ivory;
IEnumerator^ myEnum1 = dataGridView->Columns->GetEnumerator();
while ( myEnum1->MoveNext() )
{
DataGridViewColumn^ column = safe_cast<DataGridViewColumn^>(myEnum1->Current);
column->HeaderCell->Value = column->Index.ToString();
column->HeaderCell->Style = style;
}
}
// Style and number columns.
private void Button8_Click(object sender,
EventArgs args)
{
DataGridViewCellStyle style = new DataGridViewCellStyle();
style.Alignment =
DataGridViewContentAlignment.MiddleCenter;
style.ForeColor = Color.IndianRed;
style.BackColor = Color.Ivory;
foreach (DataGridViewColumn column in dataGridView.Columns)
{
column.HeaderCell.Value = column.Index.ToString();
column.HeaderCell.Style = style;
}
}
' Style and number columns.
Private Sub Button8_Click(ByVal sender As Object, _
ByVal args As EventArgs) Handles Button8.Click
Dim style As DataGridViewCellStyle = _
New DataGridViewCellStyle()
style.Alignment = _
DataGridViewContentAlignment.MiddleCenter
style.ForeColor = Color.IndianRed
style.BackColor = Color.Ivory
For Each column As DataGridViewColumn _
In dataGridView.Columns
column.HeaderCell.Value = _
column.Index.ToString
column.HeaderCell.Style = style
Next
End Sub
Remarks
The value of this property does not necessarily correspond to the current visual position of the band within the collection. For example, if the user reorders columns in a DataGridView at run time (assuming the AllowUserToOrderColumns property is set to true
), the value of the Index property of each column will not change. Instead, the column DisplayIndex values change. Sorting rows, however, does change their Index values.