DialogPage.OnApply(DialogPage+PageApplyEventArgs) Method

Definition

Handles Apply messages from the Visual Studio environment.

protected:
 virtual void OnApply(Microsoft::VisualStudio::Shell::DialogPage::PageApplyEventArgs ^ e);
protected virtual void OnApply (Microsoft.VisualStudio.Shell.DialogPage.PageApplyEventArgs e);
abstract member OnApply : Microsoft.VisualStudio.Shell.DialogPage.PageApplyEventArgs -> unit
override this.OnApply : Microsoft.VisualStudio.Shell.DialogPage.PageApplyEventArgs -> unit
Protected Overridable Sub OnApply (e As DialogPage.PageApplyEventArgs)

Parameters

e
DialogPage.PageApplyEventArgs

[in] Arguments to event handler.

Remarks

This method is a handler for Windows-based events, and is not a managed delegate.

An Apply message is sent, and this method is called when properties have been modified through the user interface of the dialog page and the user interface has been dismissed, or when the user interface explicitly generates an apply single, for example, in response to a user clicking an Apply button.

The default implementation saves the current state to local storage (typically the registry) by calling SaveSettingsToStorage.

To ensure that state is properly saved, overriding implementations should either call the base implementation of the method, or explicitly save the state itself.

Applies to