DataGridViewRowCollection.InsertRange メソッドとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

DataGridViewRowCollection.InsertRange メソッド

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

このメソッドは、.NET Framework インフラストラクチャをサポートします。独自に作成したコードから直接使用するためのものではありません。

コレクション内の指定した位置に DataGridViewRow オブジェクトを挿入します。

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

Visual Basic (宣言)

Public Overridable Sub InsertRange
 ( _
    rowIndex As Integer, _
    ParamArray dataGridViewRows As DataGridViewRow()
 _
)

Visual Basic (使用法)

Dim instance As DataGridViewRowCollection
Dim rowIndex As Integer
Dim dataGridViewRows As DataGridViewRow()

instance.InsertRange(rowIndex, dataGridViewRows)

public virtual void InsertRange (
    int rowIndex,
    params DataGridViewRow[] dataGridViewRows
)

C++

public:
virtual void InsertRange (
    int rowIndex, 
    ... array<DataGridViewRow^>^ dataGridViewRows
)

public void InsertRange (
    int rowIndex, 
    DataGridViewRow[] dataGridViewRows
)

JScript

public function InsertRange (
    rowIndex : int, 
    ... dataGridViewRows : DataGridViewRow[]
)

パラメータ

rowIndex: 行を挿入する位置。

dataGridViewRows: DataGridViewRowCollection に追加する DataGridViewRow オブジェクトの配列。

例外

例外の種類	条件
ArgumentNullException	dataGridViewRows が null 参照 (Visual Basic では Nothing) です。
ArgumentOutOfRangeException	rowIndex が 0 未満か、コレクションに含まれる行数を上回っています。
ArgumentException	dataGridViewRows が 1 つだけ行を格納し、格納されている行にコントロールの列数を超える数のセルがあります。
InvalidOperationException	関連付けられた DataGridView コントロールが次のいずれかのアクションを実行しているため、一時的に新しい行が追加できない状態にあります。コントロールのすべてのセルを選択している。選択範囲をクリアしている。またはこのメソッドが、次のいずれかに該当する DataGridView イベントのハンドラから呼び出されています。 CellEnter CellLeave CellValidating CellValidated RowEnter RowLeave RowValidated RowValidating または rowIndex がコレクションに含まれる行数と同じであり、DataGridView.AllowUserToAddRows が true です。または DataGridView の DataSource プロパティが null 参照 (Visual Basic では Nothing) ではありません。または dataGridViewRows 配列内の最低 1 つのエントリが null 参照 (Visual Basic では Nothing) です。または DataGridView に列がありません。または dataGridViewRows 配列の最低 1 つの行の DataGridView プロパティに null 参照 (Visual Basic では Nothing) 以外の値が設定されています。または dataGridViewRows 配列の最低 1 つの行の Selected プロパティ値が true に設定されています。または dataGridViewRows 配列の 2 つ以上の行が同じです。または dataGridViewRows 配列の最低 1 つの行に、コントロール内の対応する列の型と互換性のない型のセルが 1 つ以上含まれています。または dataGridViewRows 配列の最低 1 つの行に、コントロールの列数を超える数のセルがあります。またはこの操作を実行すると、固定されていない行の後に固定された行が挿入されるか、または固定された行の前に固定されていない行が挿入されます。

解説

InsertRange メソッドは、可能な場合は、DataGridViewRowCollection に共有行を追加します。共有行を追加できない場合、新しい行は非共有となります。詳細については、「Windows フォーム DataGridView コントロールを拡張するための推奨される手順」を参照してください。

新しい行の追加時にコントロール内の行が自動的に並べ替えられることはありません。新しい行を並べ替えた上で正しい位置に挿入するには、DataGridView.RowsAdded イベントハンドラで System.Windows.Forms.DataGridView.Sort メソッドを呼び出します。また、CellValueChanged イベントハンドラで System.Windows.Forms.DataGridView.Sort メソッドを呼び出すことにより、セルがユーザーによって変更されたときに行を並べ替えることもできます。

重要 :
rowIndex よりも大きいインデックスを持つ行を選択した場合、InsertRange メソッドのバグが原因で、アプリケーションが応答停止になります。このバグを回避するには、このメソッドを呼び出す前に行の選択をキャンセルし、メソッドを呼び出した後で行を再選択する必要があります。詳細については、このトピックのコード例を参照してください。

重要 :

rowIndex よりも大きいインデックスを持つ行を選択した場合、InsertRange メソッドのバグが原因で、アプリケーションが応答停止になります。このバグを回避するには、このメソッドを呼び出す前に行の選択をキャンセルし、メソッドを呼び出した後で行を再選択する必要があります。詳細については、このトピックのコード例を参照してください。

使用例

InsertRange メソッドを使用して、選択した行の前に行を挿入し、「解説」セクションに記載されているバグを回避する方法を次のコード例に示します。

Visual Basic

' Workaround for bug that prevents DataGridViewRowCollection.InsertRange
' from working when any rows before the insertion index are selected.
Private Sub InsertRows(ByVal
 index As Integer, _
    ByVal ParamArray rows As
 DataGridViewRow())

    Dim selectedIndexes As New
 System.Collections.Generic.List(Of Integer)

    For Each row As DataGridViewRow
 In dataGridView1.SelectedRows
        If row.Index >= index Then
            selectedIndexes.Add(row.Index)
            row.Selected = False
        End If
    Next row

    dataGridView1.Rows.InsertRange(index, rows)

    For Each selectedIndex As
 Integer In selectedIndexes
        dataGridView1.Rows(selectedIndex).Selected = True
    Next selectedIndex

End Sub

// Workaround for bug that prevents DataGridViewRowCollection.InsertRange
// from working when any rows before the insertion index are selected.
private void InsertRows(int
 index, params DataGridViewRow[] rows)
{
    System.Collections.Generic.List<int> selectedIndexes
 =
        new System.Collections.Generic.List<int>();
    foreach (DataGridViewRow row in dataGridView1.SelectedRows)
    {
        if (row.Index >= index)
        {
            selectedIndexes.Add(row.Index);
            row.Selected = false;
        }
    }
    dataGridView1.Rows.InsertRange(index, rows);
    foreach (int selectedIndex in
 selectedIndexes)
    {
        dataGridView1.Rows[selectedIndex].Selected = true;
    }
}