Compartilhar via


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

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

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

Syntax

'Declaration
<ComVisibleAttribute(True)> _
Public MustInherit Class UIElementDialogPage _
    Inherits DialogPage
[ComVisibleAttribute(true)]
public abstract class UIElementDialogPage : DialogPage
[ComVisibleAttribute(true)]
public ref class UIElementDialogPage abstract : public DialogPage
[<AbstractClass>]
[<ComVisibleAttribute(true)>]
type UIElementDialogPage =  
    class 
        inherit DialogPage 
    end
public abstract class UIElementDialogPage extends DialogPage

The UIElementDialogPage type exposes the following members.

Constructors

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

Top

Properties

  Name Description
Public property AutomationObject Gets the DTE automation model object for a given instance of a dialog page class. (Inherited from DialogPage.)
Protected property CanRaiseEvents Gets a value indicating whether the component can raise an event. (Inherited from Component.)
Protected property Child Gets the Windows Presentation Foundation (WPF) child element to be hosted inside the dialog page.
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. (Inherited from DialogPage.)
Public property Site Gets or sets the site of the dialog page. Overrides the implementation inherited from Component. (Inherited from DialogPage.)
Protected property Window Gets the handle to the UI control hosted in the ToolsOption page. (Overrides DialogPage.Window.)

Top

Methods

  Name Description
Public method CreateObjRef Security Critical. 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 Releases all resources used by the Component. (Inherited from Component.)
Protected method 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.)
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 the default hash function. (Inherited from Object.)
Public method GetLifetimeService Security Critical. 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 Security Critical. 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. (Inherited from DialogPage.)
Public method LoadSettingsFromXml Called by Visual Studio to load the settings of a dialog page from the Visual Studio settings storage on disk. (Inherited from DialogPage.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method MemberwiseClone(Boolean) Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Protected method OnActivate Handles Windows Activate messages from the Visual Studio environment. (Inherited from DialogPage.)
Protected method OnApply Handles Apply messages from the Visual Studio environment. (Inherited from DialogPage.)
Protected method OnClosed Handles Close messages from the Visual Studio environment. (Inherited from DialogPage.)
Protected method OnDeactivate Handles Deactive messages from the Visual Studio environment. (Inherited from DialogPage.)
Public method ResetSettings Should be overridden to reset settings to their default values. (Inherited from DialogPage.)
Public method SaveSettingsToStorage Called by Visual Studio to store the settings of a dialog page in local storage, typically the registry. (Inherited from DialogPage.)
Public method SaveSettingsToXml Called by Visual Studio to store the settings of a dialog page to the Visual Studio settings storage on disk. (Inherited from DialogPage.)
Public method 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
Public event Disposed Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)

Top

Fields

  Name Description
Public fieldStatic member 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
Explicit interface implemetationPrivate property 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