TextCommandBarFlyout Class

Definition

Represents a specialized command bar flyout that contains commands for editing text.

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 458752)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class TextCommandBarFlyout : CommandBarFlyout
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 458752)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public class TextCommandBarFlyout : CommandBarFlyout
Public Class TextCommandBarFlyout
Inherits CommandBarFlyout
Inheritance
Object IInspectable DependencyObject FlyoutBase CommandBarFlyout TextCommandBarFlyout
Attributes

Windows requirements

Device family
Windows 10, version 1809 (introduced in 10.0.17763.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v7.0)

Constructors

TextCommandBarFlyout()

Initializes a new instance of the TextCommandBarFlyout class.

Properties

AllowFocusOnInteraction

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

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.AllowFocusOnInteraction.

(Inherited from FlyoutBase)
AllowFocusWhenDisabled

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

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.AllowFocusWhenDisabled.

(Inherited from FlyoutBase)
AreOpenCloseAnimationsEnabled

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

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.AreOpenCloseAnimationsEnabled.

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

Equivalent WinUI property: Microsoft.UI.Xaml.DependencyObject.Dispatcher.

(Inherited from DependencyObject)
ElementSoundMode

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

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.ElementSoundMode.

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

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.InputDevicePrefersPrimaryCommands.

(Inherited from FlyoutBase)
IsConstrainedToRootBounds

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

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.IsConstrainedToRootBounds.

(Inherited from FlyoutBase)
IsOpen

Gets a value that indicates whether the flyout is open.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.IsOpen.

(Inherited from FlyoutBase)
LightDismissOverlayMode

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

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.LightDismissOverlayMode.

(Inherited from FlyoutBase)
OverlayInputPassThroughElement

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

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.OverlayInputPassThroughElement.

(Inherited from FlyoutBase)
Placement

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

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.Placement.

(Inherited from FlyoutBase)
PrimaryCommands

Gets the collection of primary command elements for the CommandBarFlyout.

(Inherited from CommandBarFlyout)
SecondaryCommands

Gets the collection of secondary command elements for the CommandBarFlyout.

(Inherited from CommandBarFlyout)
ShouldConstrainToRootBounds

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

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.ShouldConstrainToRootBounds.

(Inherited from FlyoutBase)
ShowMode

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

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.ShowMode.

(Inherited from FlyoutBase)
Target

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

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.Target.

(Inherited from FlyoutBase)
XamlRoot

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

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.XamlRoot.

(Inherited from FlyoutBase)

Methods

ClearValue(DependencyProperty)

Clears the local value of a dependency property.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.ClearValue.

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

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.CreatePresenter.

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

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.GetAnimationBaseValue.

(Inherited from DependencyObject)
GetValue(DependencyProperty)

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

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.GetValue.

(Inherited from DependencyObject)
Hide()

Closes the flyout.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.Hide.

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

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.OnProcessKeyboardAccelerators.

(Inherited from FlyoutBase)
ReadLocalValue(DependencyProperty)

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

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.ReadLocalValue.

(Inherited from DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)

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

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.RegisterPropertyChangedCallback.

(Inherited from DependencyObject)
SetValue(DependencyProperty, Object)

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

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.SetValue.

(Inherited from DependencyObject)
ShowAt(DependencyObject, FlyoutShowOptions)

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

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.ShowAt.

(Inherited from FlyoutBase)
ShowAt(FrameworkElement)

Shows the flyout placed in relation to the specified element.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.ShowAt.

(Inherited from FlyoutBase)
TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs)

Attempts to invoke a keyboard shortcut (accelerator).

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.TryInvokeKeyboardAccelerator.

(Inherited from FlyoutBase)
UnregisterPropertyChangedCallback(DependencyProperty, Int64)

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

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.UnregisterPropertyChangedCallback.

(Inherited from DependencyObject)

Events

Closed

Occurs when the flyout is hidden.

Equivalent WinUI event: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.Closed.

(Inherited from FlyoutBase)
Closing

Occurs when the flyout starts to be hidden.

Equivalent WinUI event: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.Closing.

(Inherited from FlyoutBase)
Opened

Occurs when the flyout is shown.

Equivalent WinUI event: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.Opened.

(Inherited from FlyoutBase)
Opening

Occurs before the flyout is shown.

Equivalent WinUI event: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.Opening.

(Inherited from FlyoutBase)

Applies to