UIElementDialogPage Class

Provides seamless hosting of Windows Presentation Foundation (WPF) content inside a native dialog running an IsDialogMessage-style message loop. This class enables tabbing into and out of the WPF child window handle (HWND), and enables keyboard navigation within the WPF child HWND.

Inheritance Hierarchy

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      Microsoft.VisualStudio.Shell.DialogPage
        Microsoft.VisualStudio.Shell.UIElementDialogPage

Namespace:  Microsoft.VisualStudio.Shell
Assembly:  Microsoft.VisualStudio.Shell.11.0 (in Microsoft.VisualStudio.Shell.11.0.dll)

Syntax

'Declaration
<ComVisibleAttribute(True)> _
Public MustInherit Class UIElementDialogPage _
    Inherits DialogPage

[ComVisibleAttribute(true)]
public abstract class UIElementDialogPage : DialogPage

The UIElementDialogPage type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	AutomationObject	Gets the DTE automation model object for a given instance of a dialog page class. (Inherited from DialogPage.)
	CanRaiseEvents	Gets a value indicating whether the component can raise an event. (Inherited from Component.)
	Child	Gets the Windows Presentation Foundation (WPF) child element to be hosted inside the dialog page.
	Container	Gets the IContainer that contains the Component. (Inherited from Component.)
	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.)
	SettingsRegistryPath	Gets or sets the sub-key under the Visual Studio version-specific root for storing settings data for a dialog page. (Inherited from DialogPage.)
	Site	Gets or sets the site of the dialog page. Overrides the implementation inherited from Component. (Inherited from DialogPage.)
	Window	Gets the handle to the UI control hosted in the ToolsOption page. (Overrides DialogPage.Window.)

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()	Releases all resources used by the Component. (Inherited from Component.)
	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. (Inherited from DialogPage.)
	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.)
	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.)
	LoadSettingsFromStorage	Called by Visual Studio to load the settings of a dialog page from local storage, generally the registry. (Inherited from DialogPage.)
	LoadSettingsFromXml	Called by Visual Studio to load the settings of a dialog page from the Visual Studio settings storage on disk. (Inherited from DialogPage.)
	MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object.)
	MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
	OnActivate	Handles Windows Activate messages from the Visual Studio environment. (Inherited from DialogPage.)
	OnApply	Handles Apply messages from the Visual Studio environment. (Inherited from DialogPage.)
	OnClosed	Handles Close messages from the Visual Studio environment. (Inherited from DialogPage.)
	OnDeactivate	Handles Deactive messages from the Visual Studio environment. (Inherited from DialogPage.)
	ResetSettings	Should be overridden to reset settings to their default values. (Inherited from DialogPage.)
	SaveSettingsToStorage	Called by Visual Studio to store the settings of a dialog page in local storage, typically the registry. (Inherited from DialogPage.)
	SaveSettingsToXml	Called by Visual Studio to store the settings of a dialog page to the Visual Studio settings storage on disk. (Inherited from DialogPage.)
	ToString	Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)

Top

Events

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

Top

Fields

	Name	Description
	DialogKeyPendingEvent	Routed event used to determine whether or not key input in the dialog should be handled by the dialog or by the content of this page. If this event is marked as handled, the key press is handled by the content and DLGC_WANTALLKEYS is returned from WM_GETDLGCODE. If the event is not handled, then only arrow keys, tabbing, and character input is handled in this dialog page.

Top

Explicit Interface Implementations

	Name	Description
	IWin32Window.Handle	Gets the handle of the window of the dialog page. (Inherited from DialogPage.)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualStudio.Shell Namespace