Class DialogHost
[TemplatePart(Name = "PART_Popup", Type = typeof(Popup))]
[TemplatePart(Name = "PART_Popup", Type = typeof(ContentControl))]
[TemplatePart(Name = "PART_ContentCoverGrid", Type = typeof(Grid))]
[TemplateVisualState(GroupName = "PopupStates", Name = "Open")]
[TemplateVisualState(GroupName = "PopupStates", Name = "Closed")]
public class DialogHost : ContentControl, IAnimatable, ISupportInitialize, IFrameworkInputElement, IInputElement, IQueryAmbient, IAddChild- Inheritance
-
DialogHost
- Implements
- Inherited Members
- Extension Methods
Constructors
DialogHost()
public DialogHost()Fields
CloseDialogCommand
Routed command to be used inside dialog content to close a dialog. Use a Button.CommandParameter to indicate the result of the parameter.
public static RoutedCommand CloseDialogCommandField Value
CloseOnClickAwayParameterProperty
public static readonly DependencyProperty CloseOnClickAwayParameterPropertyField Value
CloseOnClickAwayProperty
public static readonly DependencyProperty CloseOnClickAwayPropertyField Value
ClosedStateName
public const string ClosedStateName = "Closed"Field Value
ContentCoverGridName
public const string ContentCoverGridName = "PART_ContentCoverGrid"Field Value
DialogClosingAttachedProperty
Attached property which can be used on the Button which instigated the OpenDialogCommand to process the closing event.
public static readonly DependencyProperty DialogClosingAttachedPropertyField Value
DialogClosingCallbackProperty
public static readonly DependencyProperty DialogClosingCallbackPropertyField Value
DialogClosingEvent
public static readonly RoutedEvent DialogClosingEventField Value
DialogContentProperty
public static readonly DependencyProperty DialogContentPropertyField Value
DialogContentStringFormatProperty
public static readonly DependencyProperty DialogContentStringFormatPropertyField Value
DialogContentTemplateProperty
public static readonly DependencyProperty DialogContentTemplatePropertyField Value
DialogContentTemplateSelectorProperty
public static readonly DependencyProperty DialogContentTemplateSelectorPropertyField Value
DialogMarginProperty
public static readonly DependencyProperty DialogMarginPropertyField Value
DialogOpenedAttachedProperty
Attached property which can be used on the Button which instigated the OpenDialogCommand to process the event.
public static readonly DependencyProperty DialogOpenedAttachedPropertyField Value
DialogOpenedCallbackProperty
public static readonly DependencyProperty DialogOpenedCallbackPropertyField Value
DialogOpenedEvent
public static readonly RoutedEvent DialogOpenedEventField Value
IdentifierProperty
public static readonly DependencyProperty IdentifierPropertyField Value
IsOpenProperty
public static readonly DependencyProperty IsOpenPropertyField Value
OpenDialogCommand
Routed command to be used somewhere inside an instance to trigger showing of the dialog. Content can be passed to the dialog via a Button.CommandParameter.
public static RoutedCommand OpenDialogCommandField Value
OpenDialogCommandDataContextSourceProperty
public static readonly DependencyProperty OpenDialogCommandDataContextSourcePropertyField Value
OpenStateName
public const string OpenStateName = "Open"Field Value
PopupContentPartName
public const string PopupContentPartName = "PART_PopupContentElement"Field Value
PopupPartName
public const string PopupPartName = "PART_Popup"Field Value
PopupStyleProperty
public static readonly DependencyProperty PopupStylePropertyField Value
SnackbarMessageQueueProperty
public static readonly DependencyProperty SnackbarMessageQueuePropertyField Value
Properties
CloseOnClickAway
Indicates whether the dialog will close if the user clicks off the dialog, on the obscured background.
public bool CloseOnClickAway { get; set; }Property Value
CloseOnClickAwayParameter
Parameter to provide to close handlers if an close due to click away is instigated.
public object CloseOnClickAwayParameter { get; set; }Property Value
DialogClosingCallback
Callback fired when the DialogClosing event is fired, allowing the event to be processed from a binding/view model.
public DialogClosingEventHandler DialogClosingCallback { get; set; }Property Value
DialogContent
public object DialogContent { get; set; }Property Value
DialogContentStringFormat
public string DialogContentStringFormat { get; set; }Property Value
DialogContentTemplate
public DataTemplate DialogContentTemplate { get; set; }Property Value
DialogContentTemplateSelector
public DataTemplateSelector DialogContentTemplateSelector { get; set; }Property Value
DialogMargin
public Thickness DialogMargin { get; set; }Property Value
DialogOpenedCallback
Callback fired when the DialogOpened event is fired, allowing the event to be processed from a binding/view model.
public DialogOpenedEventHandler DialogOpenedCallback { get; set; }Property Value
Identifier
Identifier which is used in conjunction with Show(object) to determine where a dialog should be shown.
public object Identifier { get; set; }Property Value
IsOpen
public bool IsOpen { get; set; }Property Value
OpenDialogCommandDataContextSource
Defines how a data context is sourced for a dialog if a FrameworkElement is passed as the command parameter when using OpenDialogCommand.
public DialogHostOpenDialogCommandDataContextSource OpenDialogCommandDataContextSource { get; set; }Property Value
PopupStyle
public Style PopupStyle { get; set; }Property Value
SnackbarMessageQueue
Allows association of a snackbar, so that notifications can be paused whilst a dialog is being displayed.
public SnackbarMessageQueue SnackbarMessageQueue { get; set; }Property Value
Methods
CloseIndenfer(string)
public static void CloseIndenfer(string dialogIdentifier)Parameters
dialogIdentifierstring
GetDialogClosingAttached(DependencyObject)
public static DialogClosingEventHandler GetDialogClosingAttached(DependencyObject element)Parameters
elementDependencyObject
Returns
GetDialogOpenedAttached(DependencyObject)
public static DialogOpenedEventHandler GetDialogOpenedAttached(DependencyObject element)Parameters
elementDependencyObject
Returns
IsOpened()
public static bool IsOpened()Returns
OnApplyTemplate()
When overridden in a derived class, is invoked whenever application code or internal processes call ApplyTemplate().
public override void OnApplyTemplate()OnDialogClosing(DialogClosingEventArgs)
protected void OnDialogClosing(DialogClosingEventArgs eventArgs)Parameters
eventArgsDialogClosingEventArgs
OnDialogOpened(DialogClosedEventArgs)
protected void OnDialogOpened(DialogClosedEventArgs eventArgs)Parameters
eventArgsDialogClosedEventArgs
OnPreviewMouseDown(MouseButtonEventArgs)
Invoked when an unhandled System.Windows.Input.Mouse.PreviewMouseDown attached routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.
protected override void OnPreviewMouseDown(MouseButtonEventArgs e)Parameters
eMouseButtonEventArgsThe MouseButtonEventArgs that contains the event data. The event data reports that one or more mouse buttons were pressed.
SetDialogClosingAttached(DependencyObject, DialogClosingEventHandler)
public static void SetDialogClosingAttached(DependencyObject element, DialogClosingEventHandler value)Parameters
elementDependencyObjectvalueDialogClosingEventHandler
SetDialogOpenedAttached(DependencyObject, DialogOpenedEventHandler)
public static void SetDialogOpenedAttached(DependencyObject element, DialogOpenedEventHandler value)Parameters
elementDependencyObjectvalueDialogOpenedEventHandler
Show(object)
Shows a modal dialog. To use, a DialogHost instance must be in a visual tree (typically this may be specified towards the root of a Window's XAML).
public static Task<object> Show(object content)Parameters
contentobjectContent to show (can be a control or view model).
Returns
- Task<object>
Task result is the parameter used to close the dialog, typically what is passed to the CloseDialogCommand command.
Show(object, DialogClosingEventHandler)
Shows a modal dialog. To use, a DialogHost instance must be in a visual tree (typically this may be specified towards the root of a Window's XAML).
public static Task<object> Show(object content, DialogClosingEventHandler closingEventHandler)Parameters
contentobjectContent to show (can be a control or view model).
closingEventHandlerDialogClosingEventHandlerAllows access to closing event which would otherwise have been subscribed to on a instance.
Returns
- Task<object>
Task result is the parameter used to close the dialog, typically what is passed to the CloseDialogCommand command.
Show(object, DialogOpenedEventHandler)
Shows a modal dialog. To use, a DialogHost instance must be in a visual tree (typically this may be specified towards the root of a Window's XAML).
public static Task<object> Show(object content, DialogOpenedEventHandler openedEventHandler)Parameters
contentobjectContent to show (can be a control or view model).
openedEventHandlerDialogOpenedEventHandlerAllows access to opened event which would otherwise have been subscribed to on a instance.
Returns
- Task<object>
Task result is the parameter used to close the dialog, typically what is passed to the CloseDialogCommand command.
Show(object, DialogOpenedEventHandler, DialogClosingEventHandler)
Shows a modal dialog. To use, a DialogHost instance must be in a visual tree (typically this may be specified towards the root of a Window's XAML).
public static Task<object> Show(object content, DialogOpenedEventHandler openedEventHandler, DialogClosingEventHandler closingEventHandler)Parameters
contentobjectContent to show (can be a control or view model).
openedEventHandlerDialogOpenedEventHandlerAllows access to opened event which would otherwise have been subscribed to on a instance.
closingEventHandlerDialogClosingEventHandlerAllows access to closing event which would otherwise have been subscribed to on a instance.
Returns
- Task<object>
Task result is the parameter used to close the dialog, typically what is passed to the CloseDialogCommand command.
Show(object, object)
Shows a modal dialog. To use, a DialogHost instance must be in a visual tree (typically this may be specified towards the root of a Window's XAML).
public static Task<object> Show(object content, object dialogIdentifier)Parameters
contentobjectContent to show (can be a control or view model).
dialogIdentifierobjectIdentifier of the instance where the dialog should be shown. Typically this will match an identifer set in XAML.
nullis allowed.
Returns
- Task<object>
Task result is the parameter used to close the dialog, typically what is passed to the CloseDialogCommand command.
Show(object, object, DialogOpenedEventHandler, DialogClosingEventHandler)
Shows a modal dialog. To use, a DialogHost instance must be in a visual tree (typically this may be specified towards the root of a Window's XAML).
public static Task<object> Show(object content, object dialogIdentifier, DialogOpenedEventHandler openedEventHandler, DialogClosingEventHandler closingEventHandler)Parameters
contentobjectContent to show (can be a control or view model).
dialogIdentifierobjectIdentifier of the instance where the dialog should be shown. Typically this will match an identifer set in XAML.
nullis allowed.openedEventHandlerDialogOpenedEventHandlerAllows access to opened event which would otherwise have been subscribed to on a instance.
closingEventHandlerDialogClosingEventHandlerAllows access to closing event which would otherwise have been subscribed to on a instance.
Returns
- Task<object>
Task result is the parameter used to close the dialog, typically what is passed to the CloseDialogCommand command.
ShowIndenfer(string)
public static void ShowIndenfer(string dialogIdentifier)Parameters
dialogIdentifierstring
ShowWithClose(object, object, DialogClosingEventHandler)
Shows a modal dialog. To use, a DialogHost instance must be in a visual tree (typically this may be specified towards the root of a Window's XAML).
public static Task<object> ShowWithClose(object content, object dialogIdentifier, DialogClosingEventHandler closingEventHandler)Parameters
contentobjectContent to show (can be a control or view model).
dialogIdentifierobjectIdentifier of the instance where the dialog should be shown. Typically this will match an identifer set in XAML.
nullis allowed.closingEventHandlerDialogClosingEventHandlerAllows access to closing event which would otherwise have been subscribed to on a instance.
Returns
- Task<object>
Task result is the parameter used to close the dialog, typically what is passed to the CloseDialogCommand command.
ShowWithOpen(object, object, DialogOpenedEventHandler)
Shows a modal dialog. To use, a DialogHost instance must be in a visual tree (typically this may be specified towards the root of a Window's XAML).
public static Task<object> ShowWithOpen(object content, object dialogIdentifier, DialogOpenedEventHandler openedEventHandler)Parameters
contentobjectContent to show (can be a control or view model).
dialogIdentifierobjectIdentifier of the instance where the dialog should be shown. Typically this will match an identifer set in XAML.
nullis allowed.openedEventHandlerDialogOpenedEventHandlerAllows access to opened event which would otherwise have been subscribed to on a instance.
Returns
- Task<object>
Task result is the parameter used to close the dialog, typically what is passed to the CloseDialogCommand command.
Events
DialogClosing
Raised just before a dialog is closed.
public event DialogClosingEventHandler DialogClosingEvent Type
DialogOpened
Raised when a dialog is opened.
public event DialogOpenedEventHandler DialogOpened