DialogPage Class

Definition

Namespace:

Microsoft.VisualStudio.Shell

Assembly:

Microsoft.VisualStudio.Shell.15.0.dll

Package:

Microsoft.VisualStudio.Shell.15.0 v17.12.40392

Provides a standard dialog box functionality for implementing Toolbox property sheets, ToolsOptions pages, or custom UI dialog boxes, with support for the Visual Studio automation model, Windows Forms, and state persistence by using the Visual Studio settings mechanism.

public ref class DialogPage : System::ComponentModel::Component, Microsoft::VisualStudio::Shell::IProfileManager, System::Windows::Forms::IWin32Window

[System.Runtime.InteropServices.ComVisible(true)]
public class DialogPage : System.ComponentModel.Component, Microsoft.VisualStudio.Shell.IProfileManager, System.Windows.Forms.IWin32Window

[<System.Runtime.InteropServices.ComVisible(true)>]
type DialogPage = class
    inherit Component
    interface IWin32Window
    interface IProfileManager

Public Class DialogPage
Inherits Component
Implements IProfileManager, IWin32Window

Inheritance

Component

DialogPage

Derived

Microsoft.VisualStudio.Shell.UIElementDialogPage

Microsoft.VisualStudio.TextTemplating.VSHost.OrchestratorOptionsPage

Attributes

ComVisibleAttribute

Implements

IProfileManager IWin32Window

Remarks

Notes for Implementers

Implement classes derived from DialogPage when you create a user dialog box, especially a Tools Options page or a Toolbox property page.

Notes for Callers

The simplest implementation of DialogPage requires only the definition of public properties on the implementing class. The property types must support conversion to and from strings through TypeConverter.

The base implementation of DialogPage provides default handlers for standard windows events, and implements the Component, IWin32Window, and IProfileManager.

Classes derived from DialogPage have the following:

• Automatic support for component sharing through the Visual Studio DTE automation object model.

  • Any instance of DialogPage is an automation object, because the class inherits the Component interface implementation.

  • Applications that must access the automation object of the class use the AutomationObject property.

    The AutomationObject property returns this (Me in Visual Basic), because the implementation of DialogPage is already an automation object by default.

  • An implementation of DialogPage can offer an automation object other than itself by overriding the base AutomationObject implementation. For example, this might be done to provide separate user interface and the object models.

• Support for the Visual Studio settings mechanism, based on the public properties of the automation object of the derived class.

  • For an object derived from DialogPage to provide persistence, it must be registered by using ProvideProfileAttribute.

  • Types derived from DialogPage inherit a default persistence implementation of IProfileManager.

  • The default implementation persists all public properties of the automation object of the dervied class, which is the object that is returned by AutomationObject and that supports conversion to and from strings through TypeConverter.

  • This behavior can be changed by overriding LoadSettingsFromXml, SaveSettingsToXml, LoadSettingsFromStorage, and SaveSettingsToStorage.

• A default user interface that is based on the public properties of the automation object of the derived class.

  • For a dialog page implementation to provide a Tools Options page, it must be registered by using ProvideOptionPageAttribute.

  • For a dialog page implementation to provide a Toolbox dialog page, it must be registered by using ProvideToolboxPageAttribute.

  • Dialog pages use Window to return a IWin32Window, which provides a handle to the window that provides the user interface of the class.

  • By default, the window that is referenced by Window is a property grid, which is implemented by an instance of PropertyGrid by selecting the automation object.

  • The DialogPage base class uses its implementation of AutomationObject to obtain the automation object of the class and the public properties of that automation object.

  • Changes to public properties made through the user interface of a dialog page are automatically saved to local storage (typically the registry) by a call to the SaveSettingsToStorage method.

  • A dialog page implementation can change its user interface by overriding Window.

Note

Typically, an instance of a dialog page class is its own automation object. Therefore, properties that are persisted or displayed are those of the class that is derived from DialogPage. However, if AutomationObject returns another object, it is that object's properties, not the class's, that are persisted or displayed.

Constructors

DialogPage()	Initializes a new instance of DialogPage.
DialogPage(JoinableTaskContext)	Creates an instance of DialogPage.

Properties

AutomationObject	Gets the DTE automation model object for a given instance of a dialog page class.
CancellationToken
DpiMode
SettingsRegistryPath	Gets or sets the sub-key under the Visual Studio version-specific root for storing settings data for a dialog page.
SharedSettingsStorePath	Gets the location where the settings are stored in the shared settings store. It's based on the SharedSettingsAttribute on your AutomationObject, or the full type name if the attribute is not specified.
Site	Gets or sets the site of the dialog page. Overrides the implementation inherited from Component.
Window	Gets the window that is used as the user interface of the dialog page.

Methods

Dispose(Boolean)	Releases the unmanaged resources that are used by a dialog page class and optionally releases the managed resources; the parent class, Component supports unmanaged resources.
DoCancelableOperationWithProgressUI(Action, String)	Executes an operation with cancelable progress UI if invoked on the UI thread when the Options dialog is open.
DoCancelableOperationWithProgressUI(Func<CancellationToken,Task>, String)
FinishPendingWorkAsync()
GetDefaultPropertyValue(PropertyDescriptor)
GetDpiAwareObject()
GetSharedSettingsStorePath(PropertyDescriptor)	Returns the shared settings store path for the given property.
IsPropertyValueMachineLocal(PropertyDescriptor, Object, String)	Returns whether a given value from a property on the AutomationObject is local to this machine (vs. being roamable to other machines)
LoadSettingFromStorage(PropertyDescriptor)
LoadSettingsFromStorage()	Called by Visual Studio to load the settings of a dialog page from local storage, generally the registry.
LoadSettingsFromXml(IVsSettingsReader)	Called by Visual Studio to load the settings of a dialog page from the Visual Studio settings storage on disk.
MapSerializablePropertyDescriptor(PropertyDescriptor, Object, PropertyDescriptor)	Allows a different property to be observed for changes, instead of the property described by descriptor on the AutomationObject.
OnActivate(CancelEventArgs)	Handles Windows Activate messages from the Visual Studio environment.
OnApply(DialogPage+PageApplyEventArgs)	Handles Apply messages from the Visual Studio environment.
OnClosed(EventArgs)	Handles Close messages from the Visual Studio environment.
OnDeactivate(CancelEventArgs)	Handles Deactive messages from the Visual Studio environment.
ResetSettings()	Should be overridden to reset settings to their default values.
SaveSetting(PropertyDescriptor)
SaveSettingsToStorage()	Called by Visual Studio to store the settings of a dialog page in local storage, typically the registry.
SaveSettingsToXml(IVsSettingsWriter)	Called by Visual Studio to store the settings of a dialog page to the Visual Studio settings storage on disk.
SearchStringChanged(String)	Called when the Tools/Options search box's search term changes or is cleared. Can be overridden to allow pages to filter their options content based on the search term. Base implementation does nothing and does not need to be called.

Explicit Interface Implementations

IWin32Window.Handle