ListBox::GetSelected Method (Int32)
Returns a value indicating whether the specified item is selected.
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
Parameters
- index
-
Type:
System::Int32
The zero-based index of the item that determines whether it is selected.
Return Value
Type: System::Booleantrue if the specified item is currently selected in the ListBox; otherwise, false.
| Exception | Condition |
|---|---|
| ArgumentOutOfRangeException | The index parameter is less than zero or greater than or equal to the value of the Count property of the ListBox::ObjectCollection class. |
You can use this method to quickly determine whether a specified item is selected. This method is useful when a specific operation needs to be performed when a specific item in a multiple-selection ListBox is selected.
The following code example demonstrates how to use the GetSelected method to determine which items in a ListBox are selected in order to select the items that are not selected and deselect the items that are selected. The example also demonstrates using the SelectionMode property to enable a ListBox to have more than one selected item and uses the Sorted property to demonstrate how to sort items in a ListBox automatically. This example requires that a ListBox, named listBox1, has been added to a form and that the InitializeMyListBox method defined in the example is called from the Load event of the form.
private: void InitializeMyListBox() { // Add items to the ListBox. listBox1->Items->Add( "A" ); listBox1->Items->Add( "C" ); listBox1->Items->Add( "E" ); listBox1->Items->Add( "F" ); listBox1->Items->Add( "G" ); listBox1->Items->Add( "D" ); listBox1->Items->Add( "B" ); // Sort all items added previously. listBox1->Sorted = true; // Set the SelectionMode to select multiple items. listBox1->SelectionMode = SelectionMode::MultiExtended; // Select three initial items from the list. listBox1->SetSelected( 0, true ); listBox1->SetSelected( 2, true ); listBox1->SetSelected( 4, true ); // Force the ListBox to scroll back to the top of the list. listBox1->TopIndex = 0; } void InvertMySelection() { // Loop through all items the ListBox. for ( int x = 0; x < listBox1->Items->Count; x++ ) { // Select all items that are not selected, // deselect all items that are selected. listBox1->SetSelected( x, !listBox1->GetSelected( x ) ); } listBox1->TopIndex = 0; }
Available since 1.1