ListBox.ObjectCollection.Add(Object) ListBox.ObjectCollection.Add(Object) ListBox.ObjectCollection.Add(Object) ListBox.ObjectCollection.Add(Object) Method

定義

ListBox の項目のリストに項目を追加します。Adds an item to the list of items for a ListBox.

public:
 int Add(System::Object ^ item);
public int Add (object item);
member this.Add : obj -> int
Public Function Add (item As Object) As Integer

パラメーター

item
Object Object Object Object

コレクションに追加する項目を表すオブジェクト。An object representing the item to add to the collection.

戻り値

コレクション内の項目の 0 から始まるインデックス。BeginUpdate() が呼び出された場合は -1。The zero-based index of the item in the collection, or -1 if BeginUpdate() has been called.

実装

例外

新しい項目をリストに追加するための空き領域が不足しています。There is insufficient space available to add the new item to the list.

次のコード例では、複数のListBox項目を1つの列に表示し、コントロールの一覧で複数の項目を選択できるコントロールを作成する方法を示します。The following code example demonstrates how to create a ListBox control that displays multiple items in columns and can have more than one item selected in the control's list. この例のコードでListBoxは、 ListBox.ObjectCollectionクラスのAddメソッドを使用してに50項目を追加し、 SetSelectedメソッドを使用してリストから3つの項目を選択します。The code for the example adds 50 items to the ListBox using the Add method of the ListBox.ObjectCollection class and then selects three items from the list using the SetSelected method. ListBox.SelectedObjectCollectionに、プロパティをSelectedItems使用してコレクションの値とListBox.SelectedIndexCollection (プロパティをSelectedIndices通じて) を表示します。The code then displays values from the ListBox.SelectedObjectCollection collection (through the SelectedItems property) and the ListBox.SelectedIndexCollection (through the SelectedIndices property). この例では、コードがに配置され、からForm呼び出される必要があります。This example requires that the code is located in and called from a Form.

void button1_Click( Object^ /*sender*/, System::EventArgs^ /*e*/ )
{
   
   // Create an instance of the ListBox.
   ListBox^ listBox1 = gcnew ListBox;
   
   // Set the size and location of the ListBox.
   listBox1->Size = System::Drawing::Size( 200, 100 );
   listBox1->Location = System::Drawing::Point( 10, 10 );
   
   // Add the ListBox to the form.
   this->Controls->Add( listBox1 );
   
   // Set the ListBox to display items in multiple columns.
   listBox1->MultiColumn = true;
   
   // Set the selection mode to multiple and extended.
   listBox1->SelectionMode = SelectionMode::MultiExtended;
   
   // Shutdown the painting of the ListBox as items are added.
   listBox1->BeginUpdate();
   
   // Loop through and add 50 items to the ListBox.
   for ( int x = 1; x <= 50; x++ )
   {
      listBox1->Items->Add( String::Format( "Item {0}", x ) );

   }
   listBox1->EndUpdate();
   
   // Select three items from the ListBox.
   listBox1->SetSelected( 1, true );
   listBox1->SetSelected( 3, true );
   listBox1->SetSelected( 5, true );
   
   #if defined(DEBUG)
   // Display the second selected item in the ListBox to the console.
   System::Diagnostics::Debug::WriteLine( listBox1->SelectedItems[ 1 ] );
   
   // Display the index of the first selected item in the ListBox.
   System::Diagnostics::Debug::WriteLine( listBox1->SelectedIndices[ 0 ] );
   #endif
}

private void button1_Click(object sender, System.EventArgs e)
{
   // Create an instance of the ListBox.
   ListBox listBox1 = new ListBox();
   // Set the size and location of the ListBox.
   listBox1.Size = new System.Drawing.Size(200, 100);
   listBox1.Location = new System.Drawing.Point(10,10);
   // Add the ListBox to the form.
   this.Controls.Add(listBox1);
   // Set the ListBox to display items in multiple columns.
   listBox1.MultiColumn = true;
   // Set the selection mode to multiple and extended.
   listBox1.SelectionMode = SelectionMode.MultiExtended;
 
   // Shutdown the painting of the ListBox as items are added.
   listBox1.BeginUpdate();
   // Loop through and add 50 items to the ListBox.
   for (int x = 1; x <= 50; x++)
   {
      listBox1.Items.Add("Item " + x.ToString());
   }
   // Allow the ListBox to repaint and display the new items.
   listBox1.EndUpdate();
      
   // Select three items from the ListBox.
   listBox1.SetSelected(1, true);
   listBox1.SetSelected(3, true);
   listBox1.SetSelected(5, true);

   // Display the second selected item in the ListBox to the console.
   System.Diagnostics.Debug.WriteLine(listBox1.SelectedItems[1].ToString());
   // Display the index of the first selected item in the ListBox.
   System.Diagnostics.Debug.WriteLine(listBox1.SelectedIndices[0].ToString());             
}

Private Sub button1_Click(sender As Object, e As System.EventArgs)
    ' Create an instance of the ListBox.
    Dim listBox1 As New ListBox()
    ' Set the size and location of the ListBox.
    listBox1.Size = New System.Drawing.Size(200, 100)
    listBox1.Location = New System.Drawing.Point(10, 10)
    ' Add the ListBox to the form.
    Me.Controls.Add(listBox1)
    ' Set the ListBox to display items in multiple columns.
    listBox1.MultiColumn = True
    ' Set the selection mode to multiple and extended.
    listBox1.SelectionMode = SelectionMode.MultiExtended
    
    ' Shutdown the painting of the ListBox as items are added.
    listBox1.BeginUpdate()
    ' Loop through and add 50 items to the ListBox.
    Dim x As Integer
    For x = 1 To 50
        listBox1.Items.Add("Item " & x.ToString())
    Next x
    ' Allow the ListBox to repaint and display the new items.
    listBox1.EndUpdate()
    
    ' Select three items from the ListBox.
    listBox1.SetSelected(1, True)
    listBox1.SetSelected(3, True)
    listBox1.SetSelected(5, True)
       
    ' Display the second selected item in the ListBox to the console.
    System.Diagnostics.Debug.WriteLine(listBox1.SelectedItems(1).ToString())
    ' Display the index of the first selected item in the ListBox.
    System.Diagnostics.Debug.WriteLine(listBox1.SelectedIndices(0).ToString())
End Sub

注釈

のプロパティがにtrue設定されている場合、項目はアルファベット順にリストに挿入されます。 ListBox SortedIf the Sorted property of the ListBox is set to true, the item is inserted into the list alphabetically. それ以外の場合は、リストの末尾に項目が挿入されます。Otherwise, the item is inserted at the end of the list. リストボックス内の特定の位置に項目を挿入するには、 Insertメソッドを使用します。To insert an item into the list box at a specific position, use the Insert method. 1回の操作でリストボックスに一連の項目を追加するには、 AddRangeメソッドを使用します。To add a set of items to the list box in a single operation, use the AddRange method. Addメソッドを使用して多数の項目を一覧に追加する場合は、メソッドBeginUpdateEndUpdateメソッドを使用して、リストListBoxに項目が追加されるたびに、リストにすべての項目が追加されるまでを再描画しないようにします。If you want to use the Add method to add a large number of items to the list, use the BeginUpdate and EndUpdate methods to prevent the ListBox from repainting each time an item is added to the list until all items are added to the list. ListBox項目を追加する場合は、まず項目を並べ替えてから、新しい項目を追加する方が効率的です。When adding items to a ListBox, it is more efficient to sort the items first and then add new items.

オブジェクトがコレクションに追加されると、最初ListBoxには、 ListControlクラスのDisplayMemberプロパティに、項目テキストを取得するときに参照するように指定されたオブジェクトのメンバーの名前があるかどうかを確認します。When an object is added to the collection, the ListBox first checks to see if the DisplayMember property of the ListControl class has the name of a member from the object specified to reference when obtaining the item text. プロパティにDisplayMemberメンバーが指定されていない場合ListBox 、はオブジェクトToStringのメソッドを呼び出して、リストに表示するテキストを取得します。If the DisplayMember property does not have a member specified, the ListBox then calls the ToString method of the object to obtain the text to display in the list.

適用対象