DialogWindow Class

Definition

The base class for all Visual Studio WPF (non-Gel) dialogs. When you implement a WPF dialog, you should derive from this class in order to have consistent styling with other Visual Studio dialogs, as well as help support. To display the dialog, call the ShowModal() method, which correctly parents the dialog in the shell, puts the shell in a modal state while the dialog is displayed, and other features.

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
DialogWindow
Derived

Constructors

DialogWindow()

Initializes a DialogWindow without a Help button.

DialogWindow(String)

Initializes a T:Microsoft.VisualStudio.PlatformUI.DialogWindow that has a Help topic and a button.

Properties

HasDialogFrame

Determines whether the window has a frame.

(Inherited from DialogWindowBase)
HasHelpButton

Determines whether the window has a help button.

(Inherited from DialogWindowBase)
HasMaximizeButton

Determines whether the window has a maximize button.

(Inherited from DialogWindowBase)
HasMinimizeButton

Determines whether the window has a minimize button.

(Inherited from DialogWindowBase)
IsCloseButtonEnabled

Determines whether the close title bar button should be enabled.

(Inherited from DialogWindowBase)

Methods

InvokeDialogHelp()

Invokes the Help for the dialog window.

OnClosed(EventArgs)

Handles the disposing of resources when the window closes.

(Inherited from DialogWindowBase)
OnDialogThemeChanged()

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

(Inherited from DialogWindowBase)
OnSourceInitialized(EventArgs)

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

(Inherited from DialogWindowBase)
ShowModal()

Gets the parent or owner of the dialog from the Visual Studio shell and displays the dialog window. It also puts the shell in a modal state while the dialog is displayed, and centers the dialog window correctly in the parent window.

Applies to