Selector.SelectedItem Property (System.Windows.Controls.Primitives)

Switch View

SelectedItem Property

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

Selector..::.SelectedItem Property

Gets or sets the first item in the current selection or returns null if the selection is empty This is a dependency property.

Namespace: System.Windows.Controls.Primitives
Assembly: PresentationFramework (in PresentationFramework.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation

Syntax

Visual Basic (Declaration)

<BindableAttribute(True)> _
Public Property SelectedItem As Object

Visual Basic (Usage)

Dim instance As Selector
Dim value As Object

value = instance.SelectedItem

instance.SelectedItem = value

[BindableAttribute(true)]
public Object SelectedItem { get; set; }

Visual C++

[BindableAttribute(true)]
public:
property Object^ SelectedItem {
    Object^ get ();
    void set (Object^ value);
}

JScript

public function get SelectedItem () : Object
public function set SelectedItem (value : Object)

XAML Property Element Usage

<object>
  <object.SelectedItem>
    <Object .../>
  </object.SelectedItem>
</object>

Property Value

Type: System..::.Object
The first item in the current selection or nullNothingnullptra null reference (Nothing in Visual Basic) if the selection is empty.

Dependency Property Information

Identifier field	SelectedItemProperty
Metadata properties set to true	BindsTwoWayByDefault, Journal

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.

Examples

The following example gets the SelectedItem from a ListBox.

Visual Basic

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

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

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0

Reference

Selector Class

Selector Members

System.Windows.Controls.Primitives Namespace

Other Resources

Controls Overview

Control Library