ListBox.ObjectCollection.Add(Object) Method

Definition

Adiciona um item à lista de itens para um 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

Parameters

item
Object

Um objeto que representa o item a ser adicionado à coleção.An object representing the item to add to the collection.

Returns

Int32

O índice baseado em zero do item na coleção ou -1, se BeginUpdate() tiver sido chamado.The zero-based index of the item in the collection, or -1 if BeginUpdate() has been called.

Implements

Exceptions

Não há espaço suficiente disponível para adicionar o novo item à lista.There is insufficient space available to add the new item to the list.

item é null.item is null.

Examples

O exemplo de código a seguir demonstra como criar um controle de ListBox que exibe vários itens em colunas e pode ter mais de um item selecionado na lista do controle.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. O código para o exemplo adiciona 50 itens para o ListBox usando o Add método o ListBox.ObjectCollection classe e, em seguida, seleciona três itens da lista usando o SetSelected método.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. Em seguida, o código exibe valores da coleção de ListBox.SelectedObjectCollection (por meio da propriedade SelectedItems) e o ListBox.SelectedIndexCollection (por meio da propriedade SelectedIndices).The code then displays values from the ListBox.SelectedObjectCollection collection (through the SelectedItems property) and the ListBox.SelectedIndexCollection (through the SelectedIndices property). Este exemplo requer que o código esteja localizado em e chamado de um 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

Remarks

Se a propriedade Sorted da ListBox for definida como true, o item será inserido na lista em ordem alfabética.If the Sorted property of the ListBox is set to true, the item is inserted into the list alphabetically. Caso contrário, o item será inserido no final da lista.Otherwise, the item is inserted at the end of the list. Para inserir um item na caixa de listagem em uma posição específica, use o método Insert.To insert an item into the list box at a specific position, use the Insert method. Para adicionar um conjunto de itens à caixa de listagem em uma única operação, use o método AddRange.To add a set of items to the list box in a single operation, use the AddRange method. Se você quiser usar o método Add para adicionar um grande número de itens à lista, use os métodos BeginUpdate e EndUpdate para impedir que o ListBox seja redesenhado cada vez que um item for adicionado à lista até que todos os itens sejam adicionados à lista.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. Ao adicionar itens a um ListBox, é mais eficiente classificar os itens primeiro e, em seguida, adicionar novos itens.When adding items to a ListBox, it is more efficient to sort the items first and then add new items.

Quando um objeto é adicionado à coleção, o ListBox primeiro verifica se a propriedade DisplayMember da classe ListControl tem o nome de um membro do objeto especificado como referência ao obter o texto do item.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. Se a propriedade DisplayMember não tiver um membro especificado, a ListBox chamará o método ToString do objeto para obter o texto a ser exibido na lista.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.

Applies to