ListPickerFlyout ListPickerFlyout ListPickerFlyout ListPickerFlyout Class

Definition

Represents a control that allows a user to pick one or more items from a list. See Remarks.

public : sealed class ListPickerFlyout : PickerFlyoutBase, IListPickerFlyoutpublic sealed class ListPickerFlyout : PickerFlyoutBase, IListPickerFlyoutPublic NotInheritable Class ListPickerFlyout Inherits PickerFlyoutBase Implements IListPickerFlyout// This API is not available in Javascript.
Inheritance
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Inherited Members

Inherited properties

Inherited methods

Inherited events

Remarks

Important

ListPickerFlyout is not supported for use in Universal Windows Platform (UWP) app for Windows 10. Instead, to let a user to pick one item from a list use a MenuFlyout. To let a user pick multiple items, use a Flyout with a list that has multiple-selection enabled.

Constructors

ListPickerFlyout() ListPickerFlyout() ListPickerFlyout() ListPickerFlyout()

Initializes a new instance of the ListPickerFlyout class.

public : ListPickerFlyout()public ListPickerFlyout()Public Sub New()// This API is not available in Javascript.

Properties

DisplayMemberPath DisplayMemberPath DisplayMemberPath DisplayMemberPath

Gets or sets the name or path of the property that is displayed for each data item

public : PlatForm::String DisplayMemberPath { get; set; }public string DisplayMemberPath { get; set; }Public ReadWrite Property DisplayMemberPath As string// This API is not available in Javascript.
Value
PlatForm::String string string string

The name or path of the property that is displayed for each the data item in the control. The default is an empty string ("").

DisplayMemberPathProperty DisplayMemberPathProperty DisplayMemberPathProperty DisplayMemberPathProperty

Identifies the DisplayMemberPath dependency property.

public : static DependencyProperty DisplayMemberPathProperty { get; }public static DependencyProperty DisplayMemberPathProperty { get; }Public Static ReadOnly Property DisplayMemberPathProperty As DependencyProperty// This API is not available in Javascript.

ItemsSource ItemsSource ItemsSource ItemsSource

Gets or sets an object source used to generate the content of the control.

public : PlatForm::Object ItemsSource { get; set; }public object ItemsSource { get; set; }Public ReadWrite Property ItemsSource As object// This API is not available in Javascript.
Value
PlatForm::Object object object object

The object that is used to generate the content of the control. The default is null.

ItemsSourceProperty ItemsSourceProperty ItemsSourceProperty ItemsSourceProperty

Identifies the ItemsSource dependency property.

public : static DependencyProperty ItemsSourceProperty { get; }public static DependencyProperty ItemsSourceProperty { get; }Public Static ReadOnly Property ItemsSourceProperty As DependencyProperty// This API is not available in Javascript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the ItemsSource dependency property.

ItemTemplate ItemTemplate ItemTemplate ItemTemplate

Gets or sets the DataTemplate used to display each item.

public : DataTemplate ItemTemplate { get; set; }public DataTemplate ItemTemplate { get; set; }Public ReadWrite Property ItemTemplate As DataTemplate// This API is not available in Javascript.
Value
DataTemplate DataTemplate DataTemplate DataTemplate

The template that specifies the visualization of the data objects. The default is null.

ItemTemplateProperty ItemTemplateProperty ItemTemplateProperty ItemTemplateProperty

Identifies the ItemTemplate dependency property.

public : static DependencyProperty ItemTemplateProperty { get; }public static DependencyProperty ItemTemplateProperty { get; }Public Static ReadOnly Property ItemTemplateProperty As DependencyProperty// This API is not available in Javascript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the ItemTemplate dependency property.

SelectedIndex SelectedIndex SelectedIndex SelectedIndex

Gets or sets the index of the selected item.

public : int SelectedIndex { get; set; }public int SelectedIndex { get; set; }Public ReadWrite Property SelectedIndex As int// This API is not available in Javascript.
Value
int int int int

The index of the selected item. The default is -1.

SelectedIndexProperty SelectedIndexProperty SelectedIndexProperty SelectedIndexProperty

Identifies the SelectedIndex dependency property.

public : static DependencyProperty SelectedIndexProperty { get; }public static DependencyProperty SelectedIndexProperty { get; }Public Static ReadOnly Property SelectedIndexProperty As DependencyProperty// This API is not available in Javascript.

SelectedItem SelectedItem SelectedItem SelectedItem

Gets or sets the selected item.

public : PlatForm::Object SelectedItem { get; set; }public object SelectedItem { get; set; }Public ReadWrite Property SelectedItem As object// This API is not available in Javascript.
Value
PlatForm::Object object object object

The selected item. The default is null.

SelectedItemProperty SelectedItemProperty SelectedItemProperty SelectedItemProperty

Identifies the SelectedItem dependency property.

public : static DependencyProperty SelectedItemProperty { get; }public static DependencyProperty SelectedItemProperty { get; }Public Static ReadOnly Property SelectedItemProperty As DependencyProperty// This API is not available in Javascript.

SelectedItems SelectedItems SelectedItems SelectedItems

Gets the list of currently selected items.

public : IVector<object> SelectedItems { get; }public IList<object> SelectedItems { get; }Public ReadOnly Property SelectedItems As IList<object>// This API is not available in Javascript.
Value
IVector<PlatForm::Object> IList<object> IList<object> IList<object>

The list of currently selected items.

SelectedValue SelectedValue SelectedValue SelectedValue

Gets or sets the value of the selected item, obtained by using the SelectedValuePath

public : PlatForm::Object SelectedValue { get; set; }public object SelectedValue { get; set; }Public ReadWrite Property SelectedValue As object// This API is not available in Javascript.
Value
PlatForm::Object object object object

The value of the selected item, obtained by using the SelectedValuePath, or null if no item is selected. The default value is null.

SelectedValuePath SelectedValuePath SelectedValuePath SelectedValuePath

Gets or sets the property path that is used to get the SelectedValue property of the SelectedItem property.

public : PlatForm::String SelectedValuePath { get; set; }public string SelectedValuePath { get; set; }Public ReadWrite Property SelectedValuePath As string// This API is not available in Javascript.
Value
PlatForm::String string string string

The property path that is used to get the SelectedValue property of the SelectedItem property. The default is String.Empty.

SelectedValuePathProperty SelectedValuePathProperty SelectedValuePathProperty SelectedValuePathProperty

Identifies the SelectedValuePath dependency property.

public : static DependencyProperty SelectedValuePathProperty { get; }public static DependencyProperty SelectedValuePathProperty { get; }Public Static ReadOnly Property SelectedValuePathProperty As DependencyProperty// This API is not available in Javascript.

SelectedValueProperty SelectedValueProperty SelectedValueProperty SelectedValueProperty

Identifies the SelectedValue dependency property.

public : static DependencyProperty SelectedValueProperty { get; }public static DependencyProperty SelectedValueProperty { get; }Public Static ReadOnly Property SelectedValueProperty As DependencyProperty// This API is not available in Javascript.

SelectionMode SelectionMode SelectionMode SelectionMode

Gets or sets the selection mode of the picker.

public : ListPickerFlyoutSelectionMode SelectionMode { get; set; }public ListPickerFlyoutSelectionMode SelectionMode { get; set; }Public ReadWrite Property SelectionMode As ListPickerFlyoutSelectionMode// This API is not available in Javascript.

SelectionModeProperty SelectionModeProperty SelectionModeProperty SelectionModeProperty

Identifies the SelectionMode dependency property.

public : static DependencyProperty SelectionModeProperty { get; }public static DependencyProperty SelectionModeProperty { get; }Public Static ReadOnly Property SelectionModeProperty As DependencyProperty// This API is not available in Javascript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier of the SelectionMode dependency property.

Methods

ShowAtAsync(FrameworkElement) ShowAtAsync(FrameworkElement) ShowAtAsync(FrameworkElement) ShowAtAsync(FrameworkElement)

Begins an asynchronous operation to show the flyout placed in relation to the specified element.

public : IAsyncOperation<IVectorView<PlatForm::Object>> ShowAtAsync(FrameworkElement target)public IAsyncOperation<IReadOnlyList<object>> ShowAtAsync(FrameworkElement target)Public Function ShowAtAsync(target As FrameworkElement) As IAsyncOperation( Of IReadOnlyListobject )// This API is not available in Javascript.
Parameters
target
FrameworkElement FrameworkElement FrameworkElement FrameworkElement

The element to use as the flyout's placement target.

Returns
IAsyncOperation<IVectorView<PlatForm::Object>> IAsyncOperation<IReadOnlyList<object>> IAsyncOperation<IReadOnlyList<object>> IAsyncOperation<IReadOnlyList<object>>

An asynchronous operation.

Events

ItemsPicked ItemsPicked ItemsPicked ItemsPicked

Occurs when the user has selected items.

public : event TypedEventHandler ItemsPicked<ListPickerFlyout,  ItemsPickedEventArgs>public event TypedEventHandler ItemsPicked<ListPickerFlyout,  ItemsPickedEventArgs>Public Event ItemsPicked<ListPickerFlyout,  ItemsPickedEventArgs>// This API is not available in Javascript.

See Also