DialogBase Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Modeling.Shell

Assembly:: Microsoft.VisualStudio.Modeling.Sdk.Shell.15.0.dll

Assembly:: Microsoft.VisualStudio.Modeling.Sdk.Shell.dll

Package:: Microsoft.VisualStudio.Modeling.Sdk.Shell v17.10.40171

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Base class for dialogs that will be hosted in the VS shell.

public ref class DialogBase abstract : System::Windows::Forms::Form

public abstract class DialogBase : System.Windows.Forms.Form

type DialogBase = class
    inherit Form

Public MustInherit Class DialogBase
Inherits Form

Inheritance: Form
DialogBase

Constructors

DialogBase(IServiceProvider)

Constructor take a service provider. The dialog owner will eb the main VS window.

Properties

CreateParams
DialogFont	The font that Dialogs should use according to IUIService, based on system and application settings.
DisableSafeWindowTargetHardeningCheck	Returns whether to disable SafeWindowTarget hardening check in the debug build. By default, DialogBase derived forms will check each and every child control to make sure it's hardened
EnableModeless	Gets modless property on the form. Form modal by default. Provided override functionality instead of allowing to set the property as this is used in CreateParams, which is called before constructor as well.
F1Keyword	Override to specify the F1 keyword for this dialog.
FormBorderStyle	Hide base implementation here so we can provide appropriate handling of FormBorderStyle.Sizable.
ServiceProvider	Service provider used to get shell services.

Methods

OnClosed(EventArgs)	Cleans up resources being used.
OnHelpRequested(HelpEventArgs)	Override to show help via the Visual Studio help system
OnLoad(EventArgs)
OnUserPreferenceChanged(Object, UserPreferenceChangedEventArgs)
ProcessDialogChar(Char)	Overridden to make sure that only critical exceptions ripple up to the base class. Any exceptions which reach there will result invoke the WinForms unhandled exeption dlg. In Whidbey that menas an IDE crash.
ProcessDialogKey(Keys)	Overridden to make sure that only critical exceptions ripple up to the base class. Any exceptions which reach there will result invoke the WinForms unhandled exeption dlg. In Whidbey that menas an IDE crash.
WndProc(Message)	Process window messages for the dialog. Translates clicks on the "?" button to F1 help requests.

Applies to

Compartilhar via