DataGridViewColumn.DisplayIndex プロパティ

.NET Framework クラス ライブラリ リファレンス

DataGridViewColumn.DisplayIndex プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

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

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

Public Property DisplayIndex As
 Integer

Visual Basic (使用法)

Dim instance As DataGridViewColumn
Dim value As Integer

value = instance.DisplayIndex

instance.DisplayIndex = value

C#

public int DisplayIndex { get;
 set; }

C++

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

J#

/** @property */
public int get_DisplayIndex ()

/** @property */
public void set_DisplayIndex (int
 value)

JScript

public function get DisplayIndex
 () : int

public function set DisplayIndex
 (value : int)

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

例外

例外の種類	条件
ArgumentOutOfRangeException	DataGridViewElement.DataGridView が null 参照 (Visual Basic では Nothing) でなく、このプロパティの設定時に指定された値が 0 未満またはコントロール内に含まれている列数以上です。 または DataGridViewElement.DataGridView が null 参照 (Visual Basic では Nothing) で、このプロパティの設定時に指定された値が -1 未満です。 または このプロパティの設定時に指定された値が、Int32.MaxValue と同じ値です。

解説

Index プロパティとは異なり、DisplayIndex プロパティは、ユーザー インターフェイス (UI) によって表示される列の現在位置に対応します。既定では、各列の DisplayIndex には、列が追加された順序を反映する昇順の番号が設定されます。

コントロール内のすべての列には、一意の DisplayIndex 値があります。この値は 0 から始まり、値を飛ばすことなく番号順に大きくなります。列の DisplayIndex 値を変更すると、新しい順序を反映するように、他の列の DisplayIndex 値が変更されます。

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

使用例

DisplayIndex プロパティを使用して、最初と最後の列の表示位置を交換するコード例を次に示します。挿入は、DisplayIndex の手前で行われます。このコード例は、DataGridViewColumn クラスのトピックで取り上げているコード例の一部分です。

Visual Basic

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

    ' Since display indexes are not necessarily unique to 
    ' each column (for example, multiple columns may have a 
    ' display index of zero) do the below to retrieve the
    ' first and last column, rather than just swap the column
    ' with DisplayIndex 0 with the column of the highest 
    ' DisplayIndex.

    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

C#

// Swap the last column with the first.
private void Button10_Click(object sender,
 EventArgs args)
{
    // Since display indexes are not necessarily unique to 
    // each column (for example, multiple columns may have a 
    // display index of zero) do the below to retrieve the
    // first and last column, rather than just swap the column
    // with DisplayIndex 0 with the column of the highest 
    // DisplayIndex.

    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;
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
DataGridViewColumn クラス
DataGridViewColumn メンバ
System.Windows.Forms 名前空間
DataGridView クラス
DataGridViewBand.Index プロパティ