DataGridViewBand.Index プロパティ

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

DataGridViewBand.Index プロパティ

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

DataGridView コントロール内のバンドの相対位置を取得します。

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

Visual Basic (宣言)

Public ReadOnly Property
 Index As Integer

Visual Basic (使用法)

Dim instance As DataGridViewBand
Dim value As Integer

value = instance.Index

C#

public int Index { get;
 }

C++

public:
property int Index {
    int get ();
}

J#

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

JScript

public function get Index
 () : int

プロパティ値
格納されている DataGridViewRowCollection または DataGridViewColumnCollection 内のバンドの 0 から始まる位置。既定値は -1 で、関連付けられた DataGridView コントロールがないことを示します。

解説

このプロパティの値は、コレクション内にあるバンドの現在の表示位置に、必ずしも対応してはいません。たとえば、ユーザーが実行時に DataGridView 内の列を並べ替えた場合 (AllowUserToOrderColumns プロパティが true に設定されていることを前提とする)、各列の Index プロパティの値は変更されません。代わりに、列の DisplayIndex 値が変更されます。ただし、行を並べ替えると、Index 値が変更されます。

使用例

Index プロパティを使用して列ラベルを設定するコード例を次に示します。バンドの Index プロパティにアクセスするには、DataGridViewColumn を使用します。

Visual Basic

' 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

C#

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

プラットフォーム

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

参照

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