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, IListPickerFlyout
struct winrt::Windows::UI::Xaml::Controls::ListPickerFlyout : PickerFlyoutBase, IListPickerFlyout
public sealed class ListPickerFlyout : PickerFlyoutBase, IListPickerFlyout
Public NotInheritable Class ListPickerFlyout Inherits PickerFlyoutBase Implements IListPickerFlyout
Inheritance
ListPickerFlyoutListPickerFlyoutListPickerFlyoutListPickerFlyout
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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.

Properties

AllowFocusOnInteraction AllowFocusOnInteraction AllowFocusOnInteraction AllowFocusOnInteraction

Gets or sets a value that indicates whether the element automatically gets focus when the user interacts with it.

(Inherited from FlyoutBase)
AllowFocusOnInteractionProperty AllowFocusOnInteractionProperty AllowFocusOnInteractionProperty AllowFocusOnInteractionProperty

Identifies the AllowFocusOnInteraction dependency property.

(Inherited from FlyoutBase)
AllowFocusWhenDisabled AllowFocusWhenDisabled AllowFocusWhenDisabled AllowFocusWhenDisabled

Gets or sets a value that specifies whether the control can receive focus when it's disabled.

(Inherited from FlyoutBase)
AllowFocusWhenDisabledProperty AllowFocusWhenDisabledProperty AllowFocusWhenDisabledProperty AllowFocusWhenDisabledProperty

Identifies the AllowFocusWhenDisabled dependency property.

(Inherited from FlyoutBase)
AttachedFlyoutProperty AttachedFlyoutProperty AttachedFlyoutProperty AttachedFlyoutProperty

Identifies the FlyoutBase.AttachedFlyout XAML attached property.

(Inherited from FlyoutBase)
Dispatcher Dispatcher Dispatcher Dispatcher

Gets the CoreDispatcher that this object is associated with. The CoreDispatcher represents a facility that can access the DependencyObject on the UI thread even if the code is initiated by a non-UI thread.

(Inherited from DependencyObject)
DisplayMemberPath DisplayMemberPath DisplayMemberPath DisplayMemberPath

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

DisplayMemberPathProperty DisplayMemberPathProperty DisplayMemberPathProperty DisplayMemberPathProperty

Identifies the DisplayMemberPath dependency property.

ElementSoundMode ElementSoundMode ElementSoundMode ElementSoundMode

Gets or sets a value that specifies the control's preference for whether it plays sounds.

(Inherited from FlyoutBase)
ElementSoundModeProperty ElementSoundModeProperty ElementSoundModeProperty ElementSoundModeProperty

Identifies the ElementSoundMode dependency property.

(Inherited from FlyoutBase)
ItemsSource ItemsSource ItemsSource ItemsSource

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

ItemsSourceProperty ItemsSourceProperty ItemsSourceProperty ItemsSourceProperty

Identifies the ItemsSource dependency property.

ItemTemplate ItemTemplate ItemTemplate ItemTemplate

Gets or sets the DataTemplate used to display each item.

ItemTemplateProperty ItemTemplateProperty ItemTemplateProperty ItemTemplateProperty

Identifies the ItemTemplate dependency property.

LightDismissOverlayMode LightDismissOverlayMode LightDismissOverlayMode LightDismissOverlayMode

Gets or sets a value that specifies whether the area outside of a light-dismiss UI is darkened.

(Inherited from FlyoutBase)
LightDismissOverlayModeProperty LightDismissOverlayModeProperty LightDismissOverlayModeProperty LightDismissOverlayModeProperty

Identifies the LightDismissOverlayMode dependency property.

(Inherited from FlyoutBase)
OverlayInputPassThroughElement OverlayInputPassThroughElement OverlayInputPassThroughElement OverlayInputPassThroughElement

Gets or sets an element that should receive pointer input events even when underneath the flyout's overlay.

(Inherited from FlyoutBase)
OverlayInputPassThroughElementProperty OverlayInputPassThroughElementProperty OverlayInputPassThroughElementProperty OverlayInputPassThroughElementProperty

Identifies the OverlayInputPassThroughElement dependency property.

(Inherited from FlyoutBase)
Placement Placement Placement Placement

Gets or sets the default placement to be used for the flyout, in relation to its placement target.

(Inherited from FlyoutBase)
PlacementProperty PlacementProperty PlacementProperty PlacementProperty

Identifies the Placement dependency property.

(Inherited from FlyoutBase)
SelectedIndex SelectedIndex SelectedIndex SelectedIndex

Gets or sets the index of the selected item.

SelectedIndexProperty SelectedIndexProperty SelectedIndexProperty SelectedIndexProperty

Identifies the SelectedIndex dependency property.

SelectedItem SelectedItem SelectedItem SelectedItem

Gets or sets the selected item.

SelectedItemProperty SelectedItemProperty SelectedItemProperty SelectedItemProperty

Identifies the SelectedItem dependency property.

SelectedItems SelectedItems SelectedItems SelectedItems

Gets the list of currently selected items.

SelectedValue SelectedValue SelectedValue SelectedValue

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

SelectedValuePath SelectedValuePath SelectedValuePath SelectedValuePath

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

SelectedValuePathProperty SelectedValuePathProperty SelectedValuePathProperty SelectedValuePathProperty

Identifies the SelectedValuePath dependency property.

SelectedValueProperty SelectedValueProperty SelectedValueProperty SelectedValueProperty

Identifies the SelectedValue dependency property.

SelectionMode SelectionMode SelectionMode SelectionMode

Gets or sets the selection mode of the picker.

SelectionModeProperty SelectionModeProperty SelectionModeProperty SelectionModeProperty

Identifies the SelectionMode dependency property.

Target Target Target Target

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

(Inherited from FlyoutBase)
TitleProperty TitleProperty TitleProperty TitleProperty

Gets the identifier for the attached title property.

(Inherited from PickerFlyoutBase)

Methods

ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty)

Clears the local value of a dependency property.

(Inherited from DependencyObject)
CreatePresenter CreatePresenter CreatePresenter CreatePresenter

When overridden in a derived class, initializes a control to show the flyout content as appropriate for the derived control. Note: This method has no base class implementation and must be overridden in a derived class.

(Inherited from FlyoutBase)
GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty)

Returns any base value established for a dependency property, which would apply in cases where an animation is not active.

(Inherited from DependencyObject)
GetAttachedFlyout(FrameworkElement) GetAttachedFlyout(FrameworkElement) GetAttachedFlyout(FrameworkElement) GetAttachedFlyout(FrameworkElement)

Gets the flyout associated with the specified element.

(Inherited from FlyoutBase)
GetTitle(DependencyObject) GetTitle(DependencyObject) GetTitle(DependencyObject) GetTitle(DependencyObject)

Gets the title displayed on the picker control.

(Inherited from PickerFlyoutBase)
GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty)

Returns the current effective value of a dependency property from a DependencyObject.

(Inherited from DependencyObject)
Hide Hide Hide Hide

Closes the flyout.

(Inherited from FlyoutBase)
OnConfirmed OnConfirmed OnConfirmed OnConfirmed

Notifies PickerFlyoutBase subclasses when a user has confirmed a selection.

(Inherited from PickerFlyoutBase)
OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs) OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs) OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs) OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs)

Called just before a keyboard shortcut (accelerator) is processed in your app. Invoked whenever application code or internal processes call ProcessKeyboardAccelerators. Override this method to influence the default accelerator handling.

(Inherited from FlyoutBase)
ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty)

Returns the local value of a dependency property, if a local value is set.

(Inherited from DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback)

Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance.

(Inherited from DependencyObject)
SetAttachedFlyout(FrameworkElement,FlyoutBase) SetAttachedFlyout(FrameworkElement,FlyoutBase) SetAttachedFlyout(FrameworkElement,FlyoutBase) SetAttachedFlyout(FrameworkElement,FlyoutBase)

Associates the specified flyout with the specified FrameworkElement.

(Inherited from FlyoutBase)
SetTitle(DependencyObject,String) SetTitle(DependencyObject,String) SetTitle(DependencyObject,String) SetTitle(DependencyObject,String)

Sets the title displayed on a picker control.

(Inherited from PickerFlyoutBase)
SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object)

Sets the local value of a dependency property on a DependencyObject.

(Inherited from DependencyObject)
ShouldShowConfirmationButtons ShouldShowConfirmationButtons ShouldShowConfirmationButtons ShouldShowConfirmationButtons

Gets or sets whether confirmation buttons should be shown in the picker. Note: This method has no base class implementation and must be overridden in a derived class.

(Inherited from PickerFlyoutBase)
ShowAt(FrameworkElement) ShowAt(FrameworkElement) ShowAt(FrameworkElement) ShowAt(FrameworkElement)

Shows the flyout placed in relation to the specified element.

(Inherited from FlyoutBase)
ShowAtAsync(FrameworkElement) ShowAtAsync(FrameworkElement) ShowAtAsync(FrameworkElement) ShowAtAsync(FrameworkElement)

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

ShowAttachedFlyout(FrameworkElement) ShowAttachedFlyout(FrameworkElement) ShowAttachedFlyout(FrameworkElement) ShowAttachedFlyout(FrameworkElement)

Shows the flyout associated with the specified element, if any.

(Inherited from FlyoutBase)
TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs) TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs) TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs) TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs)

Attempts to invoke a keyboard shortcut (accelerator).

(Inherited from FlyoutBase)
UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64)

Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback.

(Inherited from DependencyObject)

Events

Closed Closed Closed Closed

Occurs when the flyout is hidden.

(Inherited from FlyoutBase)
Closing Closing Closing Closing

Occurs when the flyout starts to be hidden.

(Inherited from FlyoutBase)
ItemsPicked ItemsPicked ItemsPicked ItemsPicked

Occurs when the user has selected items.

Opened Opened Opened Opened

Occurs when the flyout is shown.

(Inherited from FlyoutBase)
Opening Opening Opening Opening

Occurs before the flyout is shown.

(Inherited from FlyoutBase)

See Also