OptionPage Members

Article
06/18/2009

Include Protected Members
Include Inherited Members

Used with the Visual Studio Tools Option page to simplify the implementation for any derived option page class.

The OptionPage type exposes the following members.

Constructors

	Name	Description
	OptionPage	Initializes a new instance of the OptionPage class.

Top

Methods

	Name	Description
	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.)
	Dispose	Overloaded. Releases resources.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	GetService	Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
	GetSettingsRegistryPath	Helper method to get the registry path for this setting.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	LoadSettingsFromRegistry	Helper method to handle loading settings from the registry.
	LoadSettingsFromStorage	Loads settings from registry of this setting, sets the values to the Settings class, updates the user control with the latest settings, and raises events if new setting values are different from old setting values. (Overrides DialogPage.LoadSettingsFromStorage().)
	LoadSettingsFromXml	Called by Visual Studio when a user chooses to import settings and points to a vssettings file. This method loads settings from a vssettings file, sets the values to the SettingsBase class, updates the user control with the latest settings, and raises events if new setting values are different from old settings. (Overrides DialogPage.LoadSettingsFromXml(IVsSettingsReader).)
	LoadSingleSettingFromStorage	Loads a single setting from the registry.
	MemberwiseClone	Overloaded.
	OnActivate	(Inherited from DialogPage.)
	OnApply	(Inherited from DialogPage.)
	OnClosed	(Inherited from DialogPage.)
	OnDeactivate	(Inherited from DialogPage.)
	ResetSettings	Resets settings associated with this OptionPage. (Overrides DialogPage.ResetSettings().)
	SaveSettingsToStorage	Called when the user modifies settings in Visual Studio by choosing Options from the Tools menu, and chooses to save the settings. Gets the latest value from the user control, loads all setting values from the SettingsBase class, and saves the settings to the registry. (Overrides DialogPage.SaveSettingsToStorage().)
	SaveSettingsToXml	Called when the user chooses to export these settings to a vssettings file. Gets the latest value from the user control, loads all setting values from the SettingsBase class, and saves the settings to the passed-in IvsSettingWriter. (Overrides DialogPage.SaveSettingsToXml(IVsSettingsWriter).)
	SaveSingleSettingToStorage	Writes a single setting to the registry.
	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
	AutomationObject	Gets the automation object for this option page. (Overrides DialogPage.AutomationObject.)
	CanRaiseEvents	Gets a value indicating whether the component can raise an event. (Inherited from Component.)
	Container	Gets the IContainer that contains the Component. (Inherited from Component.)
	Control	Gets the user control for this option page.
	DesignMode	Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
	Events	Gets the list of event handlers that are attached to this Component. (Inherited from Component.)
	Settings	Gets the SettingsBase for this OptionPage.
	SettingsRegistryPath	(Inherited from DialogPage.)
	Site	(Inherited from DialogPage.)
	Window	Gets the window this dialog page will use for its UI. (Overrides DialogPage.Window.)