Selector.SelectedItem Property

Reference

Definition

Namespace:: System.Windows.Controls.Primitives

Assembly:: PresentationFramework.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the first item in the current selection or returns null if the selection is empty.

public:
 property System::Object ^ SelectedItem { System::Object ^ get(); void set(System::Object ^ value); };

[System.ComponentModel.Bindable(true)]
public object SelectedItem { get; set; }

[<System.ComponentModel.Bindable(true)>]
member this.SelectedItem : obj with get, set

Public Property SelectedItem As Object

Property Value

Object

The first item in the current selection or null if the selection is empty.

Attributes: BindableAttribute

Examples

The following example gets the SelectedItem from a ListBox.

void PrintText(object sender, SelectionChangedEventArgs args)
{
    ListBoxItem lbi = ((sender as ListBox).SelectedItem as ListBoxItem);
    tb.Text = "   You selected " + lbi.Content.ToString() + ".";
}

Private Sub PrintText(ByVal sender As Object, ByVal e As SelectionChangedEventArgs)

    Dim lbsender As ListBox
    Dim li As ListBoxItem

    lbsender = CType(sender, ListBox)
    li = CType(lbsender.SelectedItem, ListBoxItem)
    tb.Text = "   You selected " & li.Content.ToString & "."
End Sub

Remarks

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

Setting SelectedItem in a Selector that supports multiple selections clears existing selected items and sets the selection to the item specified.

Dependency Property Information

Item	Value
Identifier field	SelectedItemProperty
Metadata properties set to `true`	BindsTwoWayByDefault, Journal

Applies to

Jaa