ListBox.SingleSelectionFollowsFocus Property

Definition

Namespace:

Microsoft.UI.Xaml.Controls

Gets or sets a value that indicates whether item selection changes when keyboard focus changes.

public:
 property bool SingleSelectionFollowsFocus { bool get(); void set(bool value); };

bool SingleSelectionFollowsFocus();

void SingleSelectionFollowsFocus(bool value);

public bool SingleSelectionFollowsFocus { get; set; }

var boolean = listBox.singleSelectionFollowsFocus;
listBox.singleSelectionFollowsFocus = boolean;

Public Property SingleSelectionFollowsFocus As Boolean

<ListBox SingleSelectionFollowsFocus="bool" />

Property Value

Boolean

bool

true if item selection changes when keyboard focus changes; otherwise, false. The default is true.

Remarks

This property is ignored if the list box's SelectionMode property is not set to Single.

By default, when a list box is configured for single selection, when the user moves keyboard focus to an item, the focused item is also selected. For example, if keyboard focus is moved from the first item to the second item, the SelectedIndex property is updated from 0 to 1.

Set this property to false to let a user move focus without the item selection following. For example, if each selection change causes significant UI updates, you might prefer to let the user move focus to a non-adjacent item and then press enter to update selection.

Version compatibility

The SingleSelectionFollowsFocus property is not available prior to Windows 10, version 1607. If your app’s 'minimum platform version' setting in Microsoft Visual Studio is less than the 'introduced version' shown in the Requirements block later in this page, you must design and test your app to account for this. For more info, see Version adaptive code.

To avoid exceptions when your app runs on previous versions of Windows 10, do not set this property in XAML or use it without performing a runtime check. This example shows how to use the ApiInformation class to check for the presence of this property before you set it.

<ListBox x:Name="listBox1" Loaded="ListBox_Loaded"/>

private void ListBox_Loaded(object sender, RoutedEventArgs e)
{
    if (ApiInformation.IsPropertyPresent("Windows.UI.Xaml.Controls.ListBox", "SingleSelectionFollowsFocus"))
    {
        listBox1.SingleSelectionFollowsFocus = false;
    }
}