ListBox::ObjectCollection Class
Represents the collection of items in a ListBox.
System.Windows.Forms::ListBox::ObjectCollection
System.Windows.Forms::CheckedListBox::ObjectCollection
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
The ListBox::ObjectCollection type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | ListBox::ObjectCollection(ListBox) | Initializes a new instance of ListBox::ObjectCollection. |
![]() | ListBox::ObjectCollection(ListBox, array<Object>) | Initializes a new instance of ListBox::ObjectCollection containing an array of objects. |
![]() | ListBox::ObjectCollection(ListBox, ListBox::ObjectCollection) | Initializes a new instance of ListBox::ObjectCollection based on another ListBox::ObjectCollection. |
| Name | Description | |
|---|---|---|
![]() | Count | Gets the number of items in the collection. |
![]() | IsReadOnly | Gets a value indicating whether the collection is read-only. |
![]() | Item | Gets or sets the item at the specified index within the collection. |
| Name | Description | |
|---|---|---|
![]() | Add | Adds an item to the list of items for a ListBox. |
![]() | AddRange(ListBox::ObjectCollection) | Adds the items of an existing ListBox::ObjectCollection to the list of items in a ListBox. |
![]() | AddRange(array<Object>) | Adds an array of items to the list of items for a ListBox. |
![]() | Clear | Removes all items from the collection. |
![]() | Contains | Determines whether the specified item is located within the collection. |
![]() | CopyTo | Copies the entire collection into an existing array of objects at a specified location within the array. |
![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetEnumerator | Returns an enumerator to use to iterate through the item collection. |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | IndexOf | Returns the index within the collection of the specified item. |
![]() | Insert | Inserts an item into the list box at the specified index. |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | Remove | Removes the specified object from the collection. |
![]() | RemoveAt | Infrastructure. Removes the item at the specified index within the collection. |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Name | Description | |
|---|---|---|
![]() | AsParallel | Enables parallelization of a query. (Defined by ParallelEnumerable.) |
![]() | AsQueryable | Converts an IEnumerable to an IQueryable. (Defined by Queryable.) |
![]() | Cast<TResult> | Casts the elements of an IEnumerable to the specified type. (Defined by Enumerable.) |
![]() | OfType<TResult> | Filters the elements of an IEnumerable based on a specified type. (Defined by Enumerable.) |
| Name | Description | |
|---|---|---|
![]() ![]() | ICollection::CopyTo | Infrastructure. Copies the elements of the collection to an array, starting at a particular array index. |
![]() ![]() | ICollection::IsSynchronized | Infrastructure. For a description of this member, see ICollection::IsSynchronized. |
![]() ![]() | ICollection::SyncRoot | Infrastructure. For a description of this member, see ICollection::SyncRoot. |
![]() ![]() | IList::Add | Infrastructure. Adds an object to the ListBox class. |
![]() ![]() | IList::IsFixedSize | Infrastructure. For a description of this member, see IList::IsFixedSize. |
The ListBox::ObjectCollection class stores the items displayed in the ListBox. There are two other collections defined within the ListBox class that enable you to determine what items are selected within this collection. The ListBox::SelectedObjectCollection class provides properties and methods for determining what items are selected within the ListBox::ObjectCollection, while the ListBox::SelectedIndexCollection class enables you to determine what indexes within the ListBox::ObjectCollection are selected.
There are a number of ways to add items to the collection. The Add method provides the ability to add a single object to the collection. To add a number of objects to the collection, you create an array of items and assign it to the AddRange method. If you want to insert an object at a specific location within the collection, you can use the Insert method. To remove items, you can use either the Remove method or the RemoveAt method if you know where the item is located within the collection. The Clear method enables you to remove all items from the collection instead of using the Remove method to remove a single item at a time.
You can also manipulate the items of a ListBox by using the DataSource property. If you use the DataSource property to add items to a ListBox, you can view the items in the ListBox using the Items property but you cannot add or remove items from the list using the methods of the ListBox::ObjectCollection.
In addition to methods and properties for adding and removing items, the ListBox::ObjectCollection also provides methods to find items within the collection. The Contains method enables you to determine whether an object is a member of the collection. Once you know that the item is located within the collection, you can use the IndexOf method to determine where the item is located within the collection.
The following code example demonstrates an owner-drawn ListBox by setting the DrawMode property to the OwnerDrawVariable value and handling the DrawItem and MeasureItem events. It also demonstrates setting the BorderStyle and ScrollAlwaysVisible properties and using the AddRange method.
To run this example, paste it into an empty form that imports the System.Drawing namespace and the System.Windows.Forms namespace. Call InitializeOwnerDrawnListBox from the form's constructor or Load method.
internal: System::Windows::Forms::ListBox^ ListBox1; private: void InitializeOwnerDrawnListBox() { this->ListBox1 = gcnew System::Windows::Forms::ListBox; // Set the location and size. ListBox1->Location = Point(20,20); ListBox1->Size = System::Drawing::Size( 240, 240 ); // Populate the ListBox.ObjectCollection property // with several strings, using the AddRange method. array<Object^>^temp0 = {"System.Windows.Forms","System.Drawing","System.Xml","System.Net","System.Runtime.Remoting","System.Web"}; this->ListBox1->Items->AddRange( temp0 ); // Turn off the scrollbar. ListBox1->ScrollAlwaysVisible = false; // Set the border style to a single, flat border. ListBox1->BorderStyle = BorderStyle::FixedSingle; // Set the DrawMode property to the OwnerDrawVariable value. // This means the MeasureItem and DrawItem events must be // handled. ListBox1->DrawMode = DrawMode::OwnerDrawVariable; ListBox1->MeasureItem += gcnew MeasureItemEventHandler( this, &Form1::ListBox1_MeasureItem ); ListBox1->DrawItem += gcnew DrawItemEventHandler( this, &Form1::ListBox1_DrawItem ); this->Controls->Add( this->ListBox1 ); } // Handle the DrawItem event for an owner-drawn ListBox. void ListBox1_DrawItem( Object^ /*sender*/, DrawItemEventArgs^ e ) { // If the item is the selected item, then draw the rectangle // filled in blue. The item is selected when a bitwise And // of the State property and the DrawItemState.Selected // property is true. if ( (e->State & DrawItemState::Selected) == DrawItemState::Selected ) { e->Graphics->FillRectangle( Brushes::CornflowerBlue, e->Bounds ); } else { // Otherwise, draw the rectangle filled in beige. e->Graphics->FillRectangle( Brushes::Beige, e->Bounds ); } // Draw a rectangle in blue around each item. e->Graphics->DrawRectangle( Pens::Blue, e->Bounds ); // Draw the text in the item. e->Graphics->DrawString( ListBox1->Items[ e->Index ]->ToString(), this->Font, Brushes::Black, (float)e->Bounds.X, (float)e->Bounds.Y ); // Draw the focus rectangle around the selected item. e->DrawFocusRectangle(); } // Handle the MeasureItem event for an owner-drawn ListBox. void ListBox1_MeasureItem( Object^ sender, MeasureItemEventArgs^ e ) { // Cast the sender object back to ListBox type. ListBox^ theListBox = dynamic_cast<ListBox^>(sender); // Get the string contained in each item. String^ itemString = dynamic_cast<String^>(theListBox->Items[ e->Index ]); // Split the string at the " . " character. array<Char>^temp1 = {'.'}; array<String^>^resultStrings = itemString->Split( temp1 ); // If the string contains more than one period, increase the // height by ten pixels; otherwise, increase the height by // five pixels. if ( resultStrings->Length > 2 ) { e->ItemHeight += 10; } else { e->ItemHeight += 5; } }
an owner-drawn ListBox by setting the the DrawMode property to OwnerDrawVariable value and handling the DrawItem and MeasureItem events. It also demonstrates setting the BorderStyle and ScrollAlwaysVisible properties and using the AddRange method. To run this example paste it in an empty form that imports the System.Drawing namespace and the System.Windows.Forms namespace.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

