ListBox.BeginUpdate メソッド

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

ListBox.BeginUpdate メソッド

項目を ListBox に 1 つずつ追加するときにパフォーマンスを維持するには、EndUpdate メソッドが呼び出されるまでコントロールを再描画しないようにします。

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

Visual Basic (宣言)

Public Sub BeginUpdate

Visual Basic (使用法)

Dim instance As ListBox

instance.BeginUpdate

C#

public void BeginUpdate ()

C++

public:
void BeginUpdate ()

J#

public void BeginUpdate ()

JScript

public function BeginUpdate ()

解説

複数の項目を ListBox に追加する場合は、ListBox の Items プロパティを使用してアクセスする、ListBox.ObjectCollection クラスの AddRange メソッドを使用することをお勧めします。この方法を使用すると、項目の配列を 1 回の操作でリストに追加できます。しかし、ListBox.ObjectCollection クラスの Add メソッドを使用して 1 つずつ項目を追加する場合は、BeginUpdate メソッドを使用して、項目がリストに追加されるたびに ListBox が再描画されるという状況を回避できます。項目をリストに追加するタスクが完了した後で、EndUpdate メソッドを呼び出して ListBox を再描画できるようにします。リストに多数の項目を追加する場合は、この方法で項目を追加すると、ListBox を描画するときにちらつきません。

使用例

5,000 の項目を ListBox に追加するときに、BeginUpdate メソッドと EndUpdate メソッドを使用するコード例を次に示します。この例では、listBox1 という名前の ListBox コントロールが Form に追加されており、このメソッドがそのフォーム内に含まれ、そこから呼び出される必要があります。

Visual Basic

Public Sub AddToMyListBox()
    ' Stop the ListBox from drawing while items are added.
    listBox1.BeginUpdate()
       
    ' Loop through and add five thousand new items.
    Dim x As Integer
    For x = 1 To 4999
        listBox1.Items.Add("Item " & x.ToString())
    Next x
    ' End the update process and force a repaint of the ListBox.
    listBox1.EndUpdate()
End Sub

C#

public void AddToMyListBox()
{
   // Stop the ListBox from drawing while items are added.
   listBox1.BeginUpdate();

   // Loop through and add five thousand new items.
   for(int x = 1; x < 5000; x++)
   {
      listBox1.Items.Add("Item " + x.ToString());   
   }
   // End the update process and force a repaint of the ListBox.
   listBox1.EndUpdate();
}

C++

void AddToMyListBox()
{
   // Stop the ListBox from drawing while items are added.
   listBox1->BeginUpdate();

   // Loop through and add five thousand new items.
   for ( int x = 1; x < 5000; x++ )
   {
      listBox1->Items->Add( String::Format( "Item {0}", x ) );
   }
   listBox1->EndUpdate();
}

J#

public void AddToMyListBox()
{
    // Stop the ListBox from drawing while items are added.
    listBox1.BeginUpdate();

    // Loop through and add five thousand new items.
    for (int x = 1; x < 5000; x++) {
        listBox1.get_Items().Add(("Item" + (new Integer(x)).ToString()));
    }

    // End the update process and force a repaint of the ListBox.
    listBox1.EndUpdate();
} //AddToMyListBox

JScript

function AddToMyListBox(){
    // Stop the ListBox from drawing while items are added.
    listBox1.BeginUpdate()
       
    // Loop through and add five thousand new items.
    for(var x = 0; x < 5000; x++)
        listBox1.Items.Add("Item " + x.ToString())
    // End the update process and force a repaint of the ListBox.
    listBox1.EndUpdate()
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, 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、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0

参照

関連項目
ListBox クラス
ListBox メンバ
System.Windows.Forms 名前空間
EndUpdate