DialogWindow DialogWindow DialogWindow DialogWindow Class

Definition

Dialog class to be used as base class for Visual Studio WPF dialogs (non-Gel)

Someone implementing a WPF dialog should derive from this class (to have consistent styling with other VS dialogs, and help support) To display the dialog invoke the ShowModal() function, and that will take care of correctly parenting the dialog in the shell, enabling modal state for the shell while the dialog is displayed, etc.

public ref class DialogWindow : Microsoft::VisualStudio::PlatformUI::DialogWindowBase
public class DialogWindow : Microsoft.VisualStudio.PlatformUI.DialogWindowBase
type DialogWindow = class
    inherit DialogWindowBase
Public Class DialogWindow
Inherits DialogWindowBase
Inheritance
Derived

Constructors

DialogWindow() DialogWindow() DialogWindow() DialogWindow()

Initialize the dialog that does not have Help button

DialogWindow(String) DialogWindow(String) DialogWindow(String) DialogWindow(String)

Initialize a dialog that has Help topic and buttons Use ShowModal() to display the dialog; it will get the parent window automatically from the shell

Methods

InvokeDialogHelp() InvokeDialogHelp() InvokeDialogHelp() InvokeDialogHelp()

Invokes the Help for the dialog window.

OnClosed(EventArgs) OnClosed(EventArgs) OnClosed(EventArgs) OnClosed(EventArgs)

Handles the disposing of resources when the window closes.

(Inherited from DialogWindowBase)
OnDialogThemeChanged() OnDialogThemeChanged() OnDialogThemeChanged() OnDialogThemeChanged()

When overridden in a derived class, handles the event raised when the dialog window theme has changed.

(Inherited from DialogWindowBase)
OnSourceInitialized(EventArgs) OnSourceInitialized(EventArgs) OnSourceInitialized(EventArgs) OnSourceInitialized(EventArgs)

Handles the event raised when the window source has been initialized.

(Inherited from DialogWindowBase)
ShowModal() ShowModal() ShowModal() ShowModal()

Finds the parent/owner of the dialog from the Visual Studio shell and display the dialog Sets the shell in modal state while the dialog is shown, and centers correctly the dialog in the parent window.

Note: If the dialog is parented to a WPF window, ShowDialog() can also be used to display it, but before doing so one will have to initialize correctly the dialog Owner and WindowStartupLocation.

Properties

HasDialogFrame HasDialogFrame HasDialogFrame HasDialogFrame

Determines whether the window has a frame.

(Inherited from DialogWindowBase)
HasHelpButton HasHelpButton HasHelpButton HasHelpButton

Determines whether the window has a help button.

(Inherited from DialogWindowBase)
HasMaximizeButton HasMaximizeButton HasMaximizeButton HasMaximizeButton

Determines whether the window has a maximize button.

(Inherited from DialogWindowBase)
HasMinimizeButton HasMinimizeButton HasMinimizeButton HasMinimizeButton

Determines whether the window has a minimize button.

(Inherited from DialogWindowBase)
IsCloseButtonEnabled IsCloseButtonEnabled IsCloseButtonEnabled IsCloseButtonEnabled

Gets or sets a value indicating whether the close title bar button should be enabled.

(Inherited from DialogWindowBase)

Extension Methods

GetDeviceHeight(Window) GetDeviceHeight(Window) GetDeviceHeight(Window) GetDeviceHeight(Window)

Extension method for Window that returns its Height in device units

GetDeviceLeft(Window) GetDeviceLeft(Window) GetDeviceLeft(Window) GetDeviceLeft(Window)

Extension method for Window that returns its Left coordinate in device units

GetDeviceRect(Window) GetDeviceRect(Window) GetDeviceRect(Window) GetDeviceRect(Window)

Extension method for Window that returns its Rectangle in device units

GetDeviceTop(Window) GetDeviceTop(Window) GetDeviceTop(Window) GetDeviceTop(Window)

Extension method for Window that returns its Top coordinate in device units

GetDeviceWidth(Window) GetDeviceWidth(Window) GetDeviceWidth(Window) GetDeviceWidth(Window)

Extension method for Window that returns its Width in device units

SetDeviceHeight(Window, Double) SetDeviceHeight(Window, Double) SetDeviceHeight(Window, Double) SetDeviceHeight(Window, Double)

Extension method for Window that sets its Height using device units

SetDeviceLeft(Window, Double) SetDeviceLeft(Window, Double) SetDeviceLeft(Window, Double) SetDeviceLeft(Window, Double)

Extension method for Window that sets its Left coordinate using device units

SetDeviceTop(Window, Double) SetDeviceTop(Window, Double) SetDeviceTop(Window, Double) SetDeviceTop(Window, Double)

Extension method for Window that sets its Top coordinate using device units

SetDeviceWidth(Window, Double) SetDeviceWidth(Window, Double) SetDeviceWidth(Window, Double) SetDeviceWidth(Window, Double)

Extension method for Window that sets its Width using device units

Applies to