CoreWindowDialog CoreWindowDialog CoreWindowDialog CoreWindowDialog Class

Definition

Defines a child dialog of an app window.

public : sealed class CoreWindowDialog : ICoreWindowDialogpublic sealed class CoreWindowDialog : ICoreWindowDialogPublic NotInheritable Class CoreWindowDialog Implements ICoreWindowDialog// This API is not available in Javascript.
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

CoreWindowDialog() CoreWindowDialog() CoreWindowDialog() CoreWindowDialog()

Creates a default instance of the CoreWindowDialog class.

public : CoreWindowDialog()public CoreWindowDialog()Public Sub New()// This API is not available in Javascript.
See Also

CoreWindowDialog(String) CoreWindowDialog(String) CoreWindowDialog(String) CoreWindowDialog(String)

Creates an instance of the CoreWindowDialog class with the supplied title.

public : CoreWindowDialog(PlatForm::String title)public CoreWindowDialog(String title)Public Sub New(title As String)// This API is not available in Javascript.
Parameters
title
PlatForm::String String String String

The title of the dialog.

Properties

BackButtonCommand BackButtonCommand BackButtonCommand BackButtonCommand

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

public : UICommandInvokedHandler BackButtonCommand { get; set; }public UICommandInvokedHandler BackButtonCommand { get; set; }Public ReadWrite Property BackButtonCommand As UICommandInvokedHandler// This API is not available in Javascript.
Value
UICommandInvokedHandler UICommandInvokedHandler UICommandInvokedHandler UICommandInvokedHandler

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

CancelCommandIndex CancelCommandIndex CancelCommandIndex CancelCommandIndex

Gets and sets the command index value for the dialog cancel operation.

public : unsigned int CancelCommandIndex { get; set; }public uint CancelCommandIndex { get; set; }Public ReadWrite Property CancelCommandIndex As uint// This API is not available in Javascript.
Value
unsigned int uint uint uint

The command index value for the dialog cancel operation.

Commands Commands Commands Commands

Gets the set of user interface commands (UI) available on the dialog.

public : IVector<IUICommand> Commands { get; }public IList<IUICommand> Commands { get; }Public ReadOnly Property Commands As IList<IUICommand>// This API is not available in Javascript.
Value
IVector<IUICommand> IList<IUICommand> IList<IUICommand> IList<IUICommand>

The set of UI commands available on the dialog.

DefaultCommandIndex DefaultCommandIndex DefaultCommandIndex DefaultCommandIndex

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

public : unsigned int DefaultCommandIndex { get; set; }public uint DefaultCommandIndex { get; set; }Public ReadWrite Property DefaultCommandIndex As uint// This API is not available in Javascript.
Value
unsigned int uint uint uint

The index value of the dialog 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 dialog window.

public : int IsInteractionDelayed { get; set; }public int IsInteractionDelayed { get; set; }Public ReadWrite Property IsInteractionDelayed As int// This API is not available in Javascript.
Value
int int int int

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

Remarks

Set this property to true when the dialog 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 dialog.

public : Size MaxSize { get; }public Size MaxSize { get; }Public ReadOnly Property MaxSize As Size// This API is not available in Javascript.
Value
Size Size Size Size

The maximum size of the dialog, in pixels.

MinSize MinSize MinSize MinSize

Gets the minimum size of the dialog.

public : Size MinSize { get; }public Size MinSize { get; }Public ReadOnly Property MinSize As Size// This API is not available in Javascript.
Value
Size Size Size Size

The minimum size of the dialog, in pixels.

Title Title Title Title

Gets or sets the title of the dialog.

public : PlatForm::String Title { get; set; }public string Title { get; set; }Public ReadWrite Property Title As string// This API is not available in Javascript.
Value
PlatForm::String string string string

The title of the dialog.

Methods

ShowAsync() ShowAsync() ShowAsync() ShowAsync()

Displays the dialog 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 )// This API is not available in Javascript.
Returns

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

Events

Showing Showing Showing Showing

Is fired when the dialog is displayed.

public : event TypedEventHandler Showing<CoreWindow,  CoreWindowPopupShowingEventArgs>public event TypedEventHandler Showing<CoreWindow,  CoreWindowPopupShowingEventArgs>Public Event Showing<CoreWindow,  CoreWindowPopupShowingEventArgs>// This API is not available in Javascript.