VsUIDialogWindow Class

Definition

Namespace:

Microsoft.VisualStudio.PlatformUI

Assembly:

Microsoft.VisualStudio.Shell.15.0.dll

Package:

Microsoft.VisualStudio.Shell.15.0 v17.12.40392

Dialog class to be used as base class for Visual Studio dialogs used with IVsUIDataSources

Someone implementing a dialog derived from this class should define a UI Factory (IVsUIFactory implementer) and expose the dialog as an UI Element creatable by the factory. Whomever wants to display the dialog should create a data source for the dialog (IVsUIDataSource implementer) possibly by using a data source factory. Use WindowHelper.AddHelpTopic function to add a help topic to the data source. Then call WindowHelper.ShowModalElement() and provide the element ID and the data source.

public ref class VsUIDialogWindow : Microsoft::VisualStudio::PlatformUI::DialogWindowBase

public class VsUIDialogWindow : Microsoft.VisualStudio.PlatformUI.DialogWindowBase

type VsUIDialogWindow = class
    inherit DialogWindowBase

Public Class VsUIDialogWindow
Inherits DialogWindowBase

Inheritance

Window

DialogWindowBase

VsUIDialogWindow

Remarks

When you implement a dialog derived from this class, you should define a IVsUIFactory and expose the dialog as an IVsUIElement created by the factory. If you want to display the dialog, you should create a data source for the dialog (IVsUIDataSource), possibly by using a data source factory. Use the <xref:Microsoft.Internal.VisualStudio.PlatformUI.WindowHelper.AddHelpTopic%2A> method to add a help topic to the data source. Then call <xref:Microsoft.Internal.VisualStudio.PlatformUI.WindowHelper.ShowModalElement%2A> and provide the element ID and the data source.

Constructors

VsUIDialogWindow()

Initializes a new instance of VsUIDialogWindow.

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	Gets or sets a value indicating whether the close title bar button should be enabled. (Inherited from DialogWindowBase)

Methods

InvokeDialogHelp()	Invokes Help for the dialog window.
InvokeVerb(String, String)	Microsoft internal use only.
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)