DataGridViewColumn.DisplayIndex プロパティ

  • リファレンス

定義

名前空間:
System.Windows.Forms
アセンブリ:
System.Windows.Forms.dll

現在表示されている列を基準とした列の表示順序を設定または取得します。

public:
 property int DisplayIndex { int get(); void set(int value); };
[System.ComponentModel.Browsable(false)]
public int DisplayIndex { get; set; }
[<System.ComponentModel.Browsable(false)>]
member this.DisplayIndex : int with get, set
Public Property DisplayIndex As Integer

プロパティ値

Int32

関連付けられた DataGridView に列が表示されるときの 0 から始まる位置。バンドがコントロール内に含まれていない場合は -1。

属性
BrowsableAttribute

例外

ArgumentOutOfRangeException

DataGridView が null でなく、このプロパティの設定時に指定された値が 0 未満またはコントロール内に含まれている列数以上です。

- または -

DataGridView が null で、このプロパティの設定時に指定された値が -1 未満です。

- または -

このプロパティを設定するときに指定した値は 、Int32.MaxValue と等しくなります。

例

次のコード例では、 プロパティを DisplayIndex 使用して、最初の列と最後の列の視覚的な位置を入れ替えます。 挿入は の前に行われることに注意してください DisplayIndex。 このコード例は、DataGridViewColumn クラスのために提供されている大規模な例の一部です。

// Swap the last column with the first.
void Button10_Click( Object^ /*sender*/, EventArgs^ /*args*/ )
{
   DataGridViewColumnCollection^ columnCollection = dataGridView->Columns;
   DataGridViewColumn^ firstDisplayedColumn = columnCollection->GetFirstColumn( DataGridViewElementStates::Visible );
   DataGridViewColumn^ lastDisplayedColumn = columnCollection->GetLastColumn( DataGridViewElementStates::Visible, DataGridViewElementStates::None );
   int firstColumn_sIndex = firstDisplayedColumn->DisplayIndex;
   firstDisplayedColumn->DisplayIndex = lastDisplayedColumn->DisplayIndex;
   lastDisplayedColumn->DisplayIndex = firstColumn_sIndex;
}

// Swap the last column with the first.
private void Button10_Click(object sender, EventArgs args)
{
    DataGridViewColumnCollection columnCollection = dataGridView.Columns;

    DataGridViewColumn firstVisibleColumn =
        columnCollection.GetFirstColumn(DataGridViewElementStates.Visible);
    DataGridViewColumn lastVisibleColumn =
        columnCollection.GetLastColumn(
            DataGridViewElementStates.Visible, DataGridViewElementStates.None);

    int firstColumn_sIndex = firstVisibleColumn.DisplayIndex;
    firstVisibleColumn.DisplayIndex = lastVisibleColumn.DisplayIndex;
    lastVisibleColumn.DisplayIndex = firstColumn_sIndex;
}

' Swap the last column with the first.
Private Sub Button10_Click(ByVal sender As Object, _
    ByVal args As EventArgs) Handles Button10.Click

    Dim columnCollection As DataGridViewColumnCollection = _
        dataGridView.Columns

    Dim firstVisibleColumn As DataGridViewColumn = _
        columnCollection.GetFirstColumn(DataGridViewElementStates.Visible)
    Dim lastVisibleColumn As DataGridViewColumn = _
        columnCollection.GetLastColumn(DataGridViewElementStates.Visible, _
        Nothing)

    Dim firstColumn_sIndex As Integer = firstVisibleColumn.DisplayIndex
    firstVisibleColumn.DisplayIndex = _
        lastVisibleColumn.DisplayIndex
    lastVisibleColumn.DisplayIndex = firstColumn_sIndex
End Sub

注釈

Indexプロパティとは異なり、 プロパティはDisplayIndex、ユーザー インターフェイス (UI) によって表示される列の現在の位置に対応します。 既定では、各列の DisplayIndex は増加する順序の数に設定され、追加された順序が反映されます。 プロパティ値は Visible 値に DisplayIndex 影響しません。 表示または他の状態に基づいて列の表示位置を確認するには、 クラスの GetFirstColumn、 GetLastColumn、または GetNextColumn メソッドを DataGridViewColumnCollection 使用します。

コントロール内のすべての列に一意 DisplayIndex の値があります。 値は 0 から始まり、値をスキップせずに数値順に進みます。 列の値を DisplayIndex 変更すると、新しい順序を DisplayIndex 反映するように他の列の値が変更されます。

列にコントロールが関連付けられている DataGridView 場合、このプロパティを設定すると、コントロール自体が再描画されます。

適用対象

こちらもご覧ください