ComboBox.SelectedIndex Property (System.Windows.Forms)

SelectedIndex Property

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2010/.NET Framework 4

Other versions are also available for the following:

.NET Framework Class Library

ComboBox..::.SelectedIndex Property

Gets or sets the index specifying the currently selected item.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)

Syntax

Visual Basic

<BrowsableAttribute(False)> _
Public Overrides Property SelectedIndex As Integer

[BrowsableAttribute(false)]
public override int SelectedIndex { get; set; }

Visual C++

[BrowsableAttribute(false)]
public:
virtual property int SelectedIndex {
    int get () override;
    void set (int value) override;
}

[<BrowsableAttribute(false)>]
abstract SelectedIndex : int with get, set
[<BrowsableAttribute(false)>]
override SelectedIndex : int with get, set

Property Value

Type: System..::.Int32
A zero-based index of the currently selected item. A value of negative one (-1) is returned if no item is selected.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	The specified index is less than or equal to -2. -or- The specified index is greater than or equal to the number of items in the combo box.

Exception

Condition

ArgumentOutOfRangeException

The specified index is less than or equal to -2.

-or-

The specified index is greater than or equal to the number of items in the combo box.

Remarks

This property indicates the zero-based index of the currently selected item in the combo box list. Setting a new index raises the SelectedIndexChanged event.

SelectedIndex, SelectedValue, and FormattingEnabled are related as follows:

If FormattingEnabled is false, SelectedIndex will not be set to -1 when SelectedValue is blank.
If FormattingEnabled is true, SelectedIndex will be set to -1 when SelectedValue is blank.

Note
To deselect the currently selected item, set the SelectedIndex to -1. You cannot set the SelectedIndex of a ComboBox item to -1 if the item is a data-bound item.

Examples

The following code example show how to use the FindString method and SelectedIndex property. The example is part of a complete example in the ComboBox class overview.

Visual Basic

Private Sub findButton_Click(ByVal sender As Object, ByVal e As System.EventArgs)
    Dim index As Integer
    index = comboBox1.FindString(textBox2.Text)
    comboBox1.SelectedIndex = index
End Sub

private void findButton_Click(object sender, System.EventArgs e) {
    int index = comboBox1.FindString(textBox2.Text);
    comboBox1.SelectedIndex = index;
}

Visual C++

void findButton_Click( Object^ sender, System::EventArgs^ e )
{
   int index = comboBox1->FindString( textBox2->Text );
   comboBox1->SelectedIndex = index;
}

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

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.

Reference

ComboBox Class

System.Windows.Forms Namespace

Position

FormattingEnabled

SelectedValue