SelectedIndex Property
Collapse the table of content
Expand the table of content

Selector::SelectedIndex Property

 

Gets or sets the index of the first item in the current selection or returns negative one (-1) if the selection is empty.

Namespace:   System.Windows.Controls.Primitives
Assembly:  PresentationFramework (in PresentationFramework.dll)

public:
[BindableAttribute(true)]
[LocalizabilityAttribute(LocalizationCategory::NeverLocalize)]
property int SelectedIndex {
	int get();
	void set(int value);
}

Property Value

Type: System::Int32

The index of first item in the current selection. The default value is negative one (-1).

If a Selector supports selecting a single item, the SelectedIndex property returns the index of the selected item. If a Selector supports multiple selections, SelectedIndex returns the index of the item that the user selected first.

Setting SelectedIndex in a Selector that supports multiple selections clears existing selected items and sets the selection to the item specified by the index. SelectedIndex returns -1 if selection is empty.

If you set SelectedIndex to a value less that -1, an ArgumentException is thrown. If you set SelectedIndex to a value equal or greater than the number of child elements, the value is ignored.

The following example creates a ListBox and sets the SelectedIndex property to 1, which selects the second item in the ListBox.

<ListBox Margin="10,0,0,5" SelectedIndex="1"
  Name="listBox1" VerticalAlignment="Top" Grid.Column="0" Grid.Row="4">
  <ListBoxItem>Item 0</ListBoxItem>
  <ListBoxItem>Item 1</ListBoxItem>
  <ListBoxItem>Item 2</ListBoxItem>
  <ListBoxItem>Item 3</ListBoxItem>
</ListBox>

The following example uses the SelectedIndex property to determine whether the item at index 0 is the first item in the selection.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 3.0
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Return to top
Show:
© 2016 Microsoft