PickerFlyoutBase PickerFlyoutBase PickerFlyoutBase PickerFlyoutBase Class

Definition

Represents a base class for picker controls.

public : class PickerFlyoutBase : FlyoutBase
struct winrt::Windows::UI::Xaml::Controls::Primitives::PickerFlyoutBase : FlyoutBase
public class PickerFlyoutBase : FlyoutBase
Public Class PickerFlyoutBase Inherits FlyoutBase
Inheritance
PickerFlyoutBasePickerFlyoutBasePickerFlyoutBasePickerFlyoutBase
Attributes

Windows 10 requirements

Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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.

Constructors

PickerFlyoutBase() PickerFlyoutBase() PickerFlyoutBase() PickerFlyoutBase()

Provides base-class initialization behavior for classes that are derived from the PickerFlyoutBase 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)
AreOpenCloseAnimationsEnabled AreOpenCloseAnimationsEnabled AreOpenCloseAnimationsEnabled AreOpenCloseAnimationsEnabled

Gets or sets a value that indicates whether animations are played when the flyout is opened or closed.

(Inherited from FlyoutBase)
AreOpenCloseAnimationsEnabledProperty AreOpenCloseAnimationsEnabledProperty AreOpenCloseAnimationsEnabledProperty AreOpenCloseAnimationsEnabledProperty

Identifies the AreOpenCloseAnimationsEnabled 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)
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)
InputDevicePrefersPrimaryCommands InputDevicePrefersPrimaryCommands InputDevicePrefersPrimaryCommands 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)
InputDevicePrefersPrimaryCommandsProperty InputDevicePrefersPrimaryCommandsProperty InputDevicePrefersPrimaryCommandsProperty InputDevicePrefersPrimaryCommandsProperty

Identifies the InputDevicePrefersPrimaryCommands dependency property.

(Inherited from FlyoutBase)
IsConstrainedToRootBounds IsConstrainedToRootBounds IsConstrainedToRootBounds IsConstrainedToRootBounds

Gets a value that indicates whether the flyout is shown within the bounds of the XAML root.

(Inherited from FlyoutBase)
IsOpen IsOpen IsOpen IsOpen

Gets a value that indicates whether the flyout is open.

(Inherited from FlyoutBase)
IsOpenProperty IsOpenProperty IsOpenProperty IsOpenProperty

Identifies the IsOpen dependency property.

(Inherited from FlyoutBase)
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)
ShouldConstrainToRootBounds ShouldConstrainToRootBounds ShouldConstrainToRootBounds ShouldConstrainToRootBounds

Gets or sets a value that indicates whether the flyout should be shown within the bounds of the XAML root.

(Inherited from FlyoutBase)
ShouldConstrainToRootBoundsProperty ShouldConstrainToRootBoundsProperty ShouldConstrainToRootBoundsProperty ShouldConstrainToRootBoundsProperty

Identifies the ShouldConstrainToRootBounds dependency property.

(Inherited from FlyoutBase)
ShowMode ShowMode ShowMode ShowMode

Gets or sets a value that indicates how a flyout behaves when shown.

(Inherited from FlyoutBase)
ShowModeProperty ShowModeProperty ShowModeProperty ShowModeProperty

Identifies the ShowMode dependency property.

(Inherited from FlyoutBase)
Target Target Target Target

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

(Inherited from FlyoutBase)
TargetProperty TargetProperty TargetProperty TargetProperty

Identifies the Target dependency property.

(Inherited from FlyoutBase)
TitleProperty TitleProperty TitleProperty TitleProperty

Gets the identifier for the attached title property.

XamlRoot XamlRoot XamlRoot XamlRoot

Gets or sets the XamlRoot in which this flyout is being viewed.

(Inherited from FlyoutBase)

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.

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.

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.

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.

ShowAt(DependencyObject,FlyoutShowOptions) ShowAt(DependencyObject,FlyoutShowOptions) ShowAt(DependencyObject,FlyoutShowOptions) ShowAt(DependencyObject,FlyoutShowOptions)

Shows the flyout placed in relation to the specified element using the specified options.

(Inherited from FlyoutBase)
ShowAt(FrameworkElement) ShowAt(FrameworkElement) ShowAt(FrameworkElement) ShowAt(FrameworkElement)

Shows the flyout placed in relation to the specified element.

(Inherited from FlyoutBase)
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)
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