CoreWindowFlyout CoreWindowFlyout CoreWindowFlyout CoreWindowFlyout Class

Definition

Defines a child flyout of an app window.

public : sealed class CoreWindowFlyout : ICoreWindowFlyout
public sealed class CoreWindowFlyout : ICoreWindowFlyout
Public NotInheritable Class CoreWindowFlyout Implements ICoreWindowFlyout
var coreWindowFlyout = new coreWindowFlyout(position);
Attributes
Windows 10 requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.10240.0)
API contract
Windows.UI.Core.CoreWindowDialogsContract (introduced v1)

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

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

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

public : CoreWindowFlyout(Point position)
public CoreWindowFlyout(Point position)
Public Sub New(position As Point)
var coreWindowFlyout = new coreWindowFlyout(position);
Parameters
position
Point Point Point Point

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

See Also

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, Platform::String title)
public CoreWindowFlyout(Point position, String title)
Public Sub New(position As Point, title As String)
var coreWindowFlyout = new coreWindowFlyout(position, title);
Parameters
position
Point Point Point Point

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

title
Platform::String String String String

The title of the flyout.

See Also

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 UICommandInvokedHandler
var uiCommandInvokedHandler = coreWindowFlyout.backButtonCommand;
coreWindowFlyout.backButtonCommand = uiCommandInvokedHandler;
Value
UICommandInvokedHandler UICommandInvokedHandler UICommandInvokedHandler UICommandInvokedHandler

The delegate called when the back button on the flyout is selected.

Commands Commands Commands Commands

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

public : IVector<IUICommand> Commands { get; }
public IList<IUICommand> Commands { get; }
Public ReadOnly Property Commands As IList<IUICommand>
var iList = coreWindowFlyout.commands;
Value
IVector<IUICommand> IList<IUICommand> IList<IUICommand> IList<IUICommand>

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 : unsigned int DefaultCommandIndex { get; set; }
public uint DefaultCommandIndex { get; set; }
Public ReadWrite Property DefaultCommandIndex As uint
var uint = coreWindowFlyout.defaultCommandIndex;
coreWindowFlyout.defaultCommandIndex = uint;
Value
unsigned int 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 int
var int = coreWindowFlyout.isInteractionDelayed;
coreWindowFlyout.isInteractionDelayed = int;
Value
int 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 Size
var size = coreWindowFlyout.maxSize;
Value
Size Size Size Size

The maximum size of the flyout, in pixels.

MinSize MinSize MinSize MinSize

Gets the minimum size of the flyout.

public : Size MinSize { get; }
public Size MinSize { get; }
Public ReadOnly Property MinSize As Size
var size = coreWindowFlyout.minSize;
Value
Size Size Size Size

The minimum size of the flyout, in pixels.

Title Title Title Title

Gets or sets the title of the flyout.

public : Platform::String Title { get; set; }
public string Title { get; set; }
Public ReadWrite Property Title As string
var string = coreWindowFlyout.title;
coreWindowFlyout.title = string;
Value
Platform::String 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 )
var iAsyncOperation = coreWindowFlyout.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 Showing<CoreWindow,  CoreWindowPopupShowingEventArgs>
public event TypedEventHandler Showing<CoreWindow,  CoreWindowPopupShowingEventArgs>
Public Event TypedEventHandler Showing( Of ( Of CoreWindow ), ( Of  CoreWindowPopupShowingEventArgs ))
function onShowing(eventArgs){/* Your code */}


coreWindowFlyout.addEventListener("showing", onShowing);
coreWindowFlyout.removeEventListener("showing", onShowing);