SettingsPane.CommandsRequested Event

  • Reference

Definition

Namespace:
Windows.UI.ApplicationSettings
Edit

Note

SettingsPane is deprecated, and might not work on all versions of Windows 10. Instead of using a SettingsPane, integrate settings options into the app experience. For more info, see Guidelines for app settings.

Occurs when the user opens the settings pane. Listening for this event lets the app initialize the setting commands and pause its UI until the user closes the pane.

During this event, append your SettingsCommand objects to the available ApplicationCommands vector to make them available to the SettingsPaneUI.

/// [add: Windows.Foundation.Metadata.Deprecated("SettingsPane is deprecated and might not work on all platforms. For more info, see MSDN.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, Windows.UI.ApplicationSettings.ApplicationsSettingsContract)]
/// [remove: Windows.Foundation.Metadata.Deprecated("SettingsPane is deprecated and might not work on all platforms. For more info, see MSDN.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, Windows.UI.ApplicationSettings.ApplicationsSettingsContract)]
// Register
event_token CommandsRequested(TypedEventHandler<SettingsPane, SettingsPaneCommandsRequestedEventArgs const&> const& handler) const;

// Revoke with event_token
void CommandsRequested(event_token const* cookie) const;

// Revoke with event_revoker
SettingsPane::CommandsRequested_revoker CommandsRequested(auto_revoke_t, TypedEventHandler<SettingsPane, SettingsPaneCommandsRequestedEventArgs const&> const& handler) const;
/// [add: Windows.Foundation.Metadata.Deprecated("SettingsPane is deprecated and might not work on all platforms. For more info, see MSDN.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, "Windows.UI.ApplicationSettings.ApplicationsSettingsContract")]
/// [remove: Windows.Foundation.Metadata.Deprecated("SettingsPane is deprecated and might not work on all platforms. For more info, see MSDN.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, "Windows.UI.ApplicationSettings.ApplicationsSettingsContract")]
// Register
event_token CommandsRequested(TypedEventHandler<SettingsPane, SettingsPaneCommandsRequestedEventArgs const&> const& handler) const;

// Revoke with event_token
void CommandsRequested(event_token const* cookie) const;

// Revoke with event_revoker
SettingsPane::CommandsRequested_revoker CommandsRequested(auto_revoke_t, TypedEventHandler<SettingsPane, SettingsPaneCommandsRequestedEventArgs const&> const& handler) const;
[add: Windows.Foundation.Metadata.Deprecated("SettingsPane is deprecated and might not work on all platforms. For more info, see MSDN.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, typeof(Windows.UI.ApplicationSettings.ApplicationsSettingsContract))]
[remove: Windows.Foundation.Metadata.Deprecated("SettingsPane is deprecated and might not work on all platforms. For more info, see MSDN.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, typeof(Windows.UI.ApplicationSettings.ApplicationsSettingsContract))]
public event TypedEventHandler<SettingsPane,SettingsPaneCommandsRequestedEventArgs> CommandsRequested;
[add: Windows.Foundation.Metadata.Deprecated("SettingsPane is deprecated and might not work on all platforms. For more info, see MSDN.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, "Windows.UI.ApplicationSettings.ApplicationsSettingsContract")]
[remove: Windows.Foundation.Metadata.Deprecated("SettingsPane is deprecated and might not work on all platforms. For more info, see MSDN.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, "Windows.UI.ApplicationSettings.ApplicationsSettingsContract")]
public event TypedEventHandler<SettingsPane,SettingsPaneCommandsRequestedEventArgs> CommandsRequested;
function onCommandsRequested(eventArgs) { /* Your code */ }
settingsPane.addEventListener("commandsrequested", onCommandsRequested);
settingsPane.removeEventListener("commandsrequested", onCommandsRequested);
- or -
settingsPane.oncommandsrequested = onCommandsRequested;
Public Custom Event CommandsRequested As TypedEventHandler(Of SettingsPane, SettingsPaneCommandsRequestedEventArgs)

Event Type

TypedEventHandler<SettingsPane,SettingsPaneCommandsRequestedEventArgs>
Attributes
DeprecatedAttribute

Applies to