UIElementDialogPage UIElementDialogPage UIElementDialogPage UIElementDialogPage UIElementDialogPage UIElementDialogPage Class

Definition

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.

public ref class UIElementDialogPage abstract : Microsoft::VisualStudio::Shell::DialogPage
[Windows::Foundation::Metadata::WebHostHidden]
public ref class UIElementDialogPage abstract : Microsoft::VisualStudio::Shell::DialogPage
[Windows::Foundation::Metadata::WebHostHidden]
class UIElementDialogPage abstract : Microsoft::VisualStudio::Shell::DialogPage
[System.Runtime.InteropServices.ComVisible(true)]
public abstract class UIElementDialogPage : Microsoft.VisualStudio.Shell.DialogPage
type UIElementDialogPage = class
    inherit DialogPage
Public MustInherit Class UIElementDialogPage
Inherits DialogPage
Inheritance
UIElementDialogPageUIElementDialogPageUIElementDialogPageUIElementDialogPageUIElementDialogPageUIElementDialogPage
Attributes

Constructors

UIElementDialogPage() UIElementDialogPage() UIElementDialogPage() UIElementDialogPage() UIElementDialogPage() UIElementDialogPage()

Initializes a new instance of the UIElementDialogPage class.

Fields

DialogKeyPendingEvent DialogKeyPendingEvent DialogKeyPendingEvent DialogKeyPendingEvent DialogKeyPendingEvent 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.

Properties

AutomationObject AutomationObject AutomationObject AutomationObject AutomationObject AutomationObject

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

(Inherited from DialogPage)
Child Child Child Child Child Child

Gets the Windows Presentation Foundation (WPF) child element to be hosted inside the dialog page.

IWin32Window.Handle IWin32Window.Handle IWin32Window.Handle IWin32Window.Handle IWin32Window.Handle IWin32Window.Handle Inherited from DialogPage
SettingsRegistryPath SettingsRegistryPath SettingsRegistryPath SettingsRegistryPath SettingsRegistryPath 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)
SharedSettingsStorePath SharedSettingsStorePath SharedSettingsStorePath SharedSettingsStorePath SharedSettingsStorePath 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.

(Inherited from DialogPage)
Site Site Site Site Site Site

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

(Inherited from DialogPage)
Window Window Window Window Window Window

Gets the handle to the UI control hosted in the ToolsOption page.

Methods

Dispose(Boolean) Dispose(Boolean) Dispose(Boolean) Dispose(Boolean) Dispose(Boolean) 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)
FinishPendingWorkAsync() FinishPendingWorkAsync() FinishPendingWorkAsync() FinishPendingWorkAsync() FinishPendingWorkAsync() FinishPendingWorkAsync() Inherited from DialogPage
GetSharedSettingsStorePath(PropertyDescriptor) GetSharedSettingsStorePath(PropertyDescriptor) GetSharedSettingsStorePath(PropertyDescriptor) GetSharedSettingsStorePath(PropertyDescriptor) GetSharedSettingsStorePath(PropertyDescriptor) GetSharedSettingsStorePath(PropertyDescriptor)

Gets the shared settings store path for the given property.

(Inherited from DialogPage)
IsPropertyValueMachineLocal(PropertyDescriptor, Object, String) IsPropertyValueMachineLocal(PropertyDescriptor, Object, String) IsPropertyValueMachineLocal(PropertyDescriptor, Object, String) IsPropertyValueMachineLocal(PropertyDescriptor, Object, String) IsPropertyValueMachineLocal(PropertyDescriptor, Object, String) IsPropertyValueMachineLocal(PropertyDescriptor, Object, String)

Determine whether a given value from a property on the AutomationObject is local to this machine (vs. being roamable to other machines),

(Inherited from DialogPage)
LoadSettingFromStorage(PropertyDescriptor) LoadSettingFromStorage(PropertyDescriptor) LoadSettingFromStorage(PropertyDescriptor) LoadSettingFromStorage(PropertyDescriptor) LoadSettingFromStorage(PropertyDescriptor) LoadSettingFromStorage(PropertyDescriptor) Inherited from DialogPage
LoadSettingsFromStorage() LoadSettingsFromStorage() LoadSettingsFromStorage() LoadSettingsFromStorage() LoadSettingsFromStorage() LoadSettingsFromStorage()

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

(Inherited from DialogPage)
LoadSettingsFromXml(IVsSettingsReader) LoadSettingsFromXml(IVsSettingsReader) LoadSettingsFromXml(IVsSettingsReader) LoadSettingsFromXml(IVsSettingsReader) LoadSettingsFromXml(IVsSettingsReader) LoadSettingsFromXml(IVsSettingsReader)

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

(Inherited from DialogPage)
OnActivate(CancelEventArgs) OnActivate(CancelEventArgs) OnActivate(CancelEventArgs) OnActivate(CancelEventArgs) OnActivate(CancelEventArgs) OnActivate(CancelEventArgs)

Handles Windows Activate messages from the Visual Studio environment.

(Inherited from DialogPage)
OnApply(DialogPage+PageApplyEventArgs) OnApply(DialogPage+PageApplyEventArgs) OnApply(DialogPage+PageApplyEventArgs) OnApply(DialogPage+PageApplyEventArgs) OnApply(DialogPage+PageApplyEventArgs) OnApply(DialogPage+PageApplyEventArgs)

Handles Apply messages from the Visual Studio environment.

(Inherited from DialogPage)
OnClosed(EventArgs) OnClosed(EventArgs) OnClosed(EventArgs) OnClosed(EventArgs) OnClosed(EventArgs) OnClosed(EventArgs)

Handles Close messages from the Visual Studio environment.

(Inherited from DialogPage)
OnDeactivate(CancelEventArgs) OnDeactivate(CancelEventArgs) OnDeactivate(CancelEventArgs) OnDeactivate(CancelEventArgs) OnDeactivate(CancelEventArgs) OnDeactivate(CancelEventArgs)

Handles Deactive messages from the Visual Studio environment.

(Inherited from DialogPage)
ResetSettings() ResetSettings() ResetSettings() ResetSettings() ResetSettings() ResetSettings()

Should be overridden to reset settings to their default values.

(Inherited from DialogPage)
SaveSetting(PropertyDescriptor) SaveSetting(PropertyDescriptor) SaveSetting(PropertyDescriptor) SaveSetting(PropertyDescriptor) SaveSetting(PropertyDescriptor) SaveSetting(PropertyDescriptor) Inherited from DialogPage
SaveSettingsToStorage() SaveSettingsToStorage() SaveSettingsToStorage() SaveSettingsToStorage() SaveSettingsToStorage() SaveSettingsToStorage()

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

(Inherited from DialogPage)
SaveSettingsToXml(IVsSettingsWriter) SaveSettingsToXml(IVsSettingsWriter) SaveSettingsToXml(IVsSettingsWriter) SaveSettingsToXml(IVsSettingsWriter) SaveSettingsToXml(IVsSettingsWriter) SaveSettingsToXml(IVsSettingsWriter)

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

(Inherited from DialogPage)

Applies to