ListPickerFlyout Class

Definition

Namespace:

Windows.UI.Xaml.Controls

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

public ref class ListPickerFlyout sealed : PickerFlyoutBase

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
class ListPickerFlyout final : PickerFlyoutBase

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
public sealed class ListPickerFlyout : PickerFlyoutBase

Public NotInheritable Class ListPickerFlyout
Inherits PickerFlyoutBase

Inheritance

Object Platform::Object IInspectable DependencyObject FlyoutBase PickerFlyoutBase ListPickerFlyout

Attributes

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

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()

Initializes a new instance of the ListPickerFlyout class.

Properties

AllowFocusOnInteraction	Gets or sets a value that indicates whether the element automatically gets focus when the user interacts with it. (Inherited from FlyoutBase)
AllowFocusWhenDisabled	Gets or sets a value that specifies whether the control can receive focus when it's disabled. (Inherited from FlyoutBase)
AreOpenCloseAnimationsEnabled	Gets or sets a value that indicates whether animations are played when the flyout is opened or closed. (Inherited from FlyoutBase)
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	Gets or sets the name or path of the property that is displayed for each data item
DisplayMemberPathProperty	Identifies the DisplayMemberPath dependency property.
ElementSoundMode	Gets or sets a value that specifies the control's preference for whether it plays sounds. (Inherited from FlyoutBase)
InputDevicePrefersPrimaryCommands	Gets a value that indicates whether the input device used to open the flyout does not easily open the secondary commands. (Inherited from FlyoutBase)
IsConstrainedToRootBounds	Gets a value that indicates whether the flyout is shown within the bounds of the XAML root. (Inherited from FlyoutBase)
IsOpen	Gets a value that indicates whether the flyout is open. (Inherited from FlyoutBase)
ItemsSource	Gets or sets an object source used to generate the content of the control.
ItemsSourceProperty	Identifies the ItemsSource dependency property.
ItemTemplate	Gets or sets the DataTemplate used to display each item.
ItemTemplateProperty	Identifies the ItemTemplate dependency property.
LightDismissOverlayMode	Gets or sets a value that specifies whether the area outside of a light-dismiss UI is darkened. (Inherited from FlyoutBase)
OverlayInputPassThroughElement	Gets or sets an element that should receive pointer input events even when underneath the flyout's overlay. (Inherited from FlyoutBase)
Placement	Gets or sets the default placement to be used for the flyout, in relation to its placement target. (Inherited from FlyoutBase)
SelectedIndex	Gets or sets the index of the selected item.
SelectedIndexProperty	Identifies the SelectedIndex dependency property.
SelectedItem	Gets or sets the selected item.
SelectedItemProperty	Identifies the SelectedItem dependency property.
SelectedItems	Gets the list of currently selected items.
SelectedValue	Gets or sets the value of the selected item, obtained by using the SelectedValuePath
SelectedValuePath	Gets or sets the property path that is used to get the SelectedValue property of the SelectedItem property.
SelectedValuePathProperty	Identifies the SelectedValuePath dependency property.
SelectedValueProperty	Identifies the SelectedValue dependency property.
SelectionMode	Gets or sets the selection mode of the picker.
SelectionModeProperty	Identifies the SelectionMode dependency property.
ShouldConstrainToRootBounds	Gets or sets a value that indicates whether the flyout should be shown within the bounds of the XAML root. (Inherited from FlyoutBase)
ShowMode	Gets or sets a value that indicates how a flyout behaves when shown. (Inherited from FlyoutBase)
Target	Gets the element to use as the flyout's placement target. (Inherited from FlyoutBase)
XamlRoot	Gets or sets the XamlRoot in which this flyout is being viewed. (Inherited from FlyoutBase)

Methods

ClearValue(DependencyProperty)	Clears the local value of a dependency property. (Inherited from DependencyObject)
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)	Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject)
GetValue(DependencyProperty)	Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject)
Hide()	Closes the flyout. (Inherited from FlyoutBase)
OnConfirmed()	Notifies PickerFlyoutBase subclasses when a user has confirmed a selection. (Inherited from PickerFlyoutBase)
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)	Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)	Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance. (Inherited from DependencyObject)
SetValue(DependencyProperty, Object)	Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject)
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(DependencyObject, FlyoutShowOptions)	Shows the flyout placed in relation to the specified element using the specified options. (Inherited from FlyoutBase)
ShowAt(FrameworkElement)	Shows the flyout placed in relation to the specified element. (Inherited from FlyoutBase)
ShowAtAsync(FrameworkElement)	Begins an asynchronous operation to show the flyout placed in relation to the specified element.
TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs)	Attempts to invoke a keyboard shortcut (accelerator). (Inherited from FlyoutBase)
UnregisterPropertyChangedCallback(DependencyProperty, Int64)	Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback. (Inherited from DependencyObject)

Events

Closed	Occurs when the flyout is hidden. (Inherited from FlyoutBase)
Closing	Occurs when the flyout starts to be hidden. (Inherited from FlyoutBase)
ItemsPicked	Occurs when the user has selected items.
Opened	Occurs when the flyout is shown. (Inherited from FlyoutBase)
Opening	Occurs before the flyout is shown. (Inherited from FlyoutBase)

See also

• PickerFlyoutBase