DataGridViewColumnCollection.GetLastColumn メソッド

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

DataGridViewColumnCollection.GetLastColumn メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

指定したフィルタ条件に一致する、表示順における最後の列を返します。

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

Visual Basic (宣言)

Public Function GetLastColumn ( _
    includeFilter As DataGridViewElementStates, _
    excludeFilter As DataGridViewElementStates _
) As DataGridViewColumn

Visual Basic (使用法)

Dim instance As DataGridViewColumnCollection
Dim includeFilter As DataGridViewElementStates
Dim excludeFilter As DataGridViewElementStates
Dim returnValue As DataGridViewColumn

returnValue = instance.GetLastColumn(includeFilter, excludeFilter)

C#

public DataGridViewColumn GetLastColumn (
    DataGridViewElementStates includeFilter,
    DataGridViewElementStates excludeFilter
)

C++

public:
DataGridViewColumn^ GetLastColumn (
    DataGridViewElementStates includeFilter, 
    DataGridViewElementStates excludeFilter
)

J#

public DataGridViewColumn GetLastColumn (
    DataGridViewElementStates includeFilter, 
    DataGridViewElementStates excludeFilter
)

JScript

public function GetLastColumn (
    includeFilter : DataGridViewElementStates, 
    excludeFilter : DataGridViewElementStates
) : DataGridViewColumn

パラメータ

includeFilter

適用する包含フィルタを表す DataGridViewElementStates 値のビットごとの組み合わせ。

excludeFilter

適用する除外フィルタを表す DataGridViewElementStates 値のビットごとの組み合わせ。

戻り値
指定したフィルタ条件に一致する、表示順で最後に表示される列。列が見つからない場合は null 参照 (Visual Basic では Nothing)。

例外

例外の種類	条件
ArgumentException	少なくとも 1 つのフィルタの値が、有効な DataGridViewElementStates 値のビットごとの組み合わせではありません。

解説

表示順における最後の列とは、DisplayIndex 値が最も大きい列です。列が画面に実際に表示されているかどうかは関係ありません。DisplayIndex の最大値を持つ列が複数ある場合、DataGridViewColumnCollection 内の実際のインデックスが最も大きい列が最後の列になります。

このメソッドを使用すると、インデックス値を直接比較せずに、指定した条件に一致する最後の列を判断できます。

使用例

GetLastColumn メソッドを使用して、最後に表示される列と最初に表示される列を入れ替えるコード例を次に示します。

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

参照

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