CoreWindowFlyout CoreWindowFlyout CoreWindowFlyout Class

Defines a child flyout of an app window.

Syntax

Declaration

public sealed class CoreWindowFlyoutpublic sealed class CoreWindowFlyoutPublic NotInheritable Class CoreWindowFlyout

Remarks

Note

: This class is not agile, which means that you need to consider its threading model and marshaling behavior. For more info, see Threading and Marshaling (C++/CX).

Constructors summary

Creates an instance of the CoreWindowFlyout class at the supplied position.

Creates an instance of the CoreWindowFlyout class at the specified position with the supplied title.

Properties summary

Gets or sets the delegate called when the back button on the flyout is selected.

Gets the set of user interface commands available on the flyout.

Gets or sets the index of the flyout window's default command.

Gets or sets a value that indicates whether any UI interaction event message is slightly delayed or not. This delay prevents a user from accidentally invoking an action on the flyout window.

Gets the maximum size of the flyout.

Gets the minimum size of the flyout.

Gets or sets the title of the flyout.

Methods summary

Displays the flyout and asynchronously waits for the user to take an action.

Events summary

Is fired when the flyout is displayed.

Constructors

  • CoreWindowFlyout(Point)
    CoreWindowFlyout(Point)
    CoreWindowFlyout(Point)
    CoreWindowFlyout(Point)

    Creates an instance of the CoreWindowFlyout class at the supplied position.

    public CoreWindowFlyout(Point position)public New(Point position)Public Sub New(position As Point)public CoreWindowFlyout(Point position)

    Parameters

    • position

      The pixel position on the screen where the flyout is to originate. The position provides the upper-leftmost corner of the flyout.

  • CoreWindowFlyout(Point, String)
    CoreWindowFlyout(Point, String)
    CoreWindowFlyout(Point, String)
    CoreWindowFlyout(Point, String)

    Creates an instance of the CoreWindowFlyout class at the specified position with the supplied title.

    public CoreWindowFlyout(Point position, String title)public New(Point position, String title)Public Sub New(position As Point, title As String)public CoreWindowFlyout(Point position, String title)

    Parameters

    • position

      The pixel position on the screen where the flyout is to originate. The position provides the upper-leftmost corner of the flyout.

    • title
      System.String
      System.String
      System.String

      The title of the flyout.

Properties

  • BackButtonCommand
    BackButtonCommand
    BackButtonCommand
    BackButtonCommand

    Gets or sets the delegate called when the back button on the flyout is selected.

    public UICommandInvokedHandler BackButtonCommand { get; set; }public UICommandInvokedHandler BackButtonCommand { get; set; }Public ReadWrite Property BackButtonCommand As UICommandInvokedHandlerpublic UICommandInvokedHandler BackButtonCommand { get; set; }

    Property Value

  • Commands
    Commands
    Commands
    Commands

    Gets the set of user interface commands available on the flyout.

    public IVector<IUICommand> Commands { get; }public IVector<IUICommand> Commands { get; }Public ReadOnly Property Commands As IVector<IUICommand>public IVector<IUICommand> Commands { get; }

    Property Value

    • The set of user interface commands available on the flyout.

  • DefaultCommandIndex
    DefaultCommandIndex
    DefaultCommandIndex
    DefaultCommandIndex

    Gets or sets the index of the flyout window's default command.

    public uint DefaultCommandIndex { get; set; }public uint DefaultCommandIndex { get; set; }Public ReadWrite Property DefaultCommandIndex As uintpublic uint DefaultCommandIndex { get; set; }

    Property Value

    • uint
      uint
      uint

      The index value of the flyout window's default command (such as OK).

  • IsInteractionDelayed
    IsInteractionDelayed
    IsInteractionDelayed
    IsInteractionDelayed

    Gets or sets a value that indicates whether any UI interaction event message is slightly delayed or not. This delay prevents a user from accidentally invoking an action on the flyout window.

    public int IsInteractionDelayed { get; set; }public int IsInteractionDelayed { get; set; }Public ReadWrite Property IsInteractionDelayed As intpublic int IsInteractionDelayed { get; set; }

    Property Value

    • int
      int
      int

      true if a fractional delay is introduced to any interactions with the flyout; false if it is not.

    Remarks

    Set this property to true when the flyout is asking the user for permission to perform some action which could affect the user’s privacy, security, or data.

  • MaxSize
    MaxSize
    MaxSize
    MaxSize

    Gets the maximum size of the flyout.

    public Size MaxSize { get; }public Size MaxSize { get; }Public ReadOnly Property MaxSize As Sizepublic Size MaxSize { get; }

    Property Value

  • MinSize
    MinSize
    MinSize
    MinSize

    Gets the minimum size of the flyout.

    public Size MinSize { get; }public Size MinSize { get; }Public ReadOnly Property MinSize As Sizepublic Size MinSize { get; }

    Property Value

  • Title
    Title
    Title
    Title

    Gets or sets the title of the flyout.

    public string Title { get; set; }public string Title { get; set; }Public ReadWrite Property Title As stringpublic string Title { get; set; }

    Property Value

    • string
      string
      string

      The title of the flyout.

Methods

  • ShowAsync()
    ShowAsync()
    ShowAsync()
    ShowAsync()

    Displays the flyout and asynchronously waits for the user to take an action.

    public IAsyncOperation<IUICommand> ShowAsync()public IAsyncOperation<IUICommand> ShowAsync()Public Function ShowAsync() As IAsyncOperation( Of IUICommand )public IAsyncOperation<IUICommand> ShowAsync()

    Returns

    • The action performed by the user on the flyout, as well as information about the action.

Events

  • Showing
    Showing
    Showing
    Showing

    Is fired when the flyout is displayed.

    public event TypedEventHandler Showingpublic event TypedEventHandler ShowingPublic Event Showingpublic event TypedEventHandler Showing

Device family

Windows Desktop Extension SDK (introduced v10.0.10240.0)

API contract

Windows.UI.Core.CoreWindowDialogsContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ActivatableAttribute
Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.MarshalingBehaviorAttribute
Windows.Foundation.Metadata.MuseAttribute
Windows.Foundation.Metadata.WebHostHiddenAttribute

Details

Assembly

Windows.UI.Core.dll