UIElementDialogPage Class

Definition

Namespace:

Microsoft.VisualStudio.Shell

Assembly:

Microsoft.VisualStudio.Shell.15.0.dll

Package:

Microsoft.VisualStudio.Shell.15.0 v17.12.40392

Class which is used to seamlessly host WPF content inside a native dialog running an IsDialogMessage-style message loop. UIElementDialogPage enables tabbing into and out of the WPF child 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

[<System.Runtime.InteropServices.ComVisible(true)>]
type UIElementDialogPage = class
    inherit DialogPage

Public MustInherit Class UIElementDialogPage
Inherits DialogPage

Inheritance

Component

DialogPage

UIElementDialogPage

Attributes

ComVisibleAttribute

Constructors

UIElementDialogPage()

Initializes a new instance of the UIElementDialogPage class.

Fields

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 keypress should be handled by the content, and DLGC_WANTALLKEYS will be returned from WM_GETDLGCODE. If the event is not handled, then only arrow keys, tabbing, and character input will be handled within this dialog page.

Properties

AutomationObject	Gets the DTE automation model object for a given instance of a dialog page class. (Inherited from DialogPage)
CancellationToken	(Inherited from DialogPage)
Child	Gets the WPF child element to be hosted inside the dialog page.
DpiMode
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	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	Gets or sets the site of the dialog page. Overrides the implementation inherited from Component. (Inherited from DialogPage)
Window	Returns the handle to the UI control hosted in the ToolsOption page.

Methods

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)
DoCancelableOperationWithProgressUI(Action, String)	Executes an operation with cancelable progress UI if invoked on the UI thread when the Options dialog is open. (Inherited from DialogPage)
DoCancelableOperationWithProgressUI(Func<CancellationToken,Task>, String)	(Inherited from DialogPage)
FinishPendingWorkAsync()	(Inherited from DialogPage)
GetDefaultPropertyValue(PropertyDescriptor)	(Inherited from DialogPage)
GetDpiAwareObject()	(Inherited from DialogPage)
GetSharedSettingsStorePath(PropertyDescriptor)	Returns the shared settings store path for the given property. (Inherited from DialogPage)
IsPropertyValueMachineLocal(PropertyDescriptor, Object, String)	Returns 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)	(Inherited from DialogPage)
LoadSettingsFromStorage()	Called by Visual Studio to load the settings of a dialog page from local storage, generally the registry. (Inherited from DialogPage)
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)
MapSerializablePropertyDescriptor(PropertyDescriptor, Object, PropertyDescriptor)	Allows a different property to be observed for changes, instead of the property described by descriptor on the AutomationObject. (Inherited from DialogPage)
OnActivate(CancelEventArgs)	Handles Windows Activate messages from the Visual Studio environment. (Inherited from DialogPage)
OnApply(DialogPage+PageApplyEventArgs)	Handles Apply messages from the Visual Studio environment. (Inherited from DialogPage)
OnClosed(EventArgs)	Handles Close messages from the Visual Studio environment. (Inherited from DialogPage)
OnDeactivate(CancelEventArgs)	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)
SaveSetting(PropertyDescriptor)	(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(IVsSettingsWriter)	Called by Visual Studio to store the settings of a dialog page to the Visual Studio settings storage on disk. (Inherited from DialogPage)
SearchStringChanged(String)	Called when the Tools/Options search box's search term changes or is cleared. Can be overridden to allow pages to filter their options content based on the search term. Base implementation does nothing and does not need to be called. (Inherited from DialogPage)

Explicit Interface Implementations

IWin32Window.Handle

(Inherited from DialogPage)