Share via


DialogPage Members

Include Protected Members
Include Inherited Members

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.

The DialogPage type exposes the following members.

Constructors

 

Name

Description

Public method

DialogPage

Initializes a new instance of DialogPage.

Top

Methods

 

Name

Description

Public method

CreateObjRef

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)

Public method

Dispose

Overloaded. Releases all resources that are used by a dialog page class.

Public method

Equals

Determines whether the specified Object is equal to the current Object. (Inherited from Object.)

Protected method

Finalize

Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)

Public method

GetHashCode

Serves as a hash function for a particular type. (Inherited from Object.)

Public method

GetLifetimeService

Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)

Protected method

GetService

Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)

Public method

GetType

Gets the type of the current instance. (Inherited from Object.)

Public method

InitializeLifetimeService

Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)

Public method

LoadSettingsFromStorage

Called by Visual Studio to load the settings of a dialog page from local storage, generally the registry.

Public method

LoadSettingsFromXml

Called by Visual Studio to load the settings of a dialog page from the Visual Studio settings storage on disk.

Protected method

MemberwiseClone

Overloaded.

Protected method

OnActivate

Handles Windows Activate messages from the Visual Studio environment.

Protected method

OnApply

Handles Apply messages from the Visual Studio environment.

Protected method

OnClosed

Handles Close messages from the Visual Studio environment.

Protected method

OnDeactivate

Handles Deactive messages from the Visual Studio environment.

Public method

ResetSettings

Should be overridden to reset settings to their default values.

Public method

SaveSettingsToStorage

Called by Visual Studio to store the settings of a dialog page in local storage, typically the registry.

Public method

SaveSettingsToXml

Called by Visual Studio to store the settings of a dialog page to the Visual Studio settings storage on disk.

Public method

ToString

Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)

Top

Properties

 

Name

Description

Public property

AutomationObject

Gets the DTE automation model object for a given instance of a dialog page class.

Protected property

CanRaiseEvents

Gets a value indicating whether the component can raise an event. (Inherited from Component.)

Public property

Container

Gets the IContainer that contains the Component. (Inherited from Component.)

Protected property

DesignMode

Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)

Protected property

Events

Gets the list of event handlers that are attached to this Component. (Inherited from Component.)

Protected property

SettingsRegistryPath

Gets or sets the sub-key under the Visual Studio version-specific root for storing settings data for a dialog page.

Public property

Site

Gets or sets the site of the dialog page. Overrides the implementation inherited from Component. (Overrides Component.Site.)

Protected property

Window

Gets the window that is used as the user interface of the dialog page.

Top

Events

 

Name

Description

Public event

Disposed

Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)

Top

Explicit Interface Implementations

 

Name

Description

Explicit interface implemetationPrivate property

IWin32Window.Handle

Gets the handle of the window of the dialog page.

Top

See Also

Reference

DialogPage Class

Microsoft.VisualStudio.Shell Namespace