PickerFlyoutBase Class

Reference

Definition

Namespace:: Microsoft.UI.Xaml.Controls.Primitives

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Represents a base class for picker controls.

public ref class PickerFlyoutBase : FlyoutBase

/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.WinUIContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class PickerFlyoutBase : FlyoutBase

[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.WinUIContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public class PickerFlyoutBase : FlyoutBase

Public Class PickerFlyoutBase
Inherits FlyoutBase

Inheritance: Object Platform::Object IInspectable DependencyObject FlyoutBase PickerFlyoutBase

Derived: Microsoft.UI.Xaml.Controls.DatePickerFlyout

Microsoft.UI.Xaml.Controls.ListPickerFlyout

Microsoft.UI.Xaml.Controls.PickerFlyout

Microsoft.UI.Xaml.Controls.TimePickerFlyout

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Remarks

XAML attached properties

PickerFlyoutBase is the host service class for a XAML attached property.

In order to support XAML processor access to the attached properties, and also to expose equivalent get and set operations to code, each XAML attached property has a pair of Get and Set accessor methods. Another way to get or set the value in code is to use the dependency property system, calling either GetValue or SetValue and passing the identifier field as the dependency property identifier.

Attached property	Description
Title	Gets or sets the title for a picker flyout when it appears. Type: string Identifier field: TitleProperty Accessor methods: GetTitle, SetTitle

Constructors

PickerFlyoutBase()

Provides base-class initialization behavior for classes that are derived from the PickerFlyoutBase 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	Always returns `null` in a Windows App SDK app. Use DispatcherQueue instead. (Inherited from DependencyObject)
DispatcherQueue	Gets the `DispatcherQueue` that this object is associated with. The `DispatcherQueue` 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)
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. This property is always true for Windows App SDK apps. (Inherited from FlyoutBase)
IsOpen	Gets a value that indicates whether the flyout is open. (Inherited from FlyoutBase)
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)
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)
SystemBackdrop	Gets or sets the system backdrop to apply to this flyout. The backdrop is rendered behind the flyout content. (Inherited from FlyoutBase)
Target	Gets the element to use as the flyout's placement target. (Inherited from FlyoutBase)
TitleProperty	Gets the identifier for the attached title property.
XamlRoot	Gets or sets the XamlRoot in which this flyout is being viewed. (Inherited from FlyoutBase)

Attached Properties

Title

Gets or sets the title for a picker flyout when it appears.

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)
GetTitle(DependencyObject)	Gets the title displayed on the picker control.
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.
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)
SetTitle(DependencyObject, String)	Sets the title displayed on a picker control.
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.
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)
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)
Opened	Occurs when the flyout is shown. (Inherited from FlyoutBase)
Opening	Occurs before the flyout is shown. (Inherited from FlyoutBase)

Applies to

Share via