SettingsPane Classe

Definizione

Spazio dei nomi:

Windows.UI.ApplicationSettings

Nota

SettingsPane è deprecato e potrebbe non funzionare in tutte le versioni di Windows 10. Anziché usare un SettingsPane, integrare le opzioni delle impostazioni nell'esperienza dell'app. Per altre informazioni, vedere Linee guida per le impostazioni dell'app.

Classe statica che consente all'app di controllare il riquadro Accesso impostazioni. L'app può aggiungere o rimuovere comandi, ricevere una notifica quando l'utente apre il riquadro o aprire il riquadro a livello di codice.

public ref class SettingsPane sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.UI.ApplicationSettings.ApplicationsSettingsContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.None)]
/// [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")]
class SettingsPane final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.UI.ApplicationSettings.ApplicationsSettingsContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.None)]
[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 sealed class SettingsPane

Public NotInheritable Class SettingsPane

Ereditarietà

Object Platform::Object IInspectable SettingsPane

Attributi

ContractVersionAttribute DeprecatedAttribute MarshalingBehaviorAttribute

Requisiti Windows

Famiglia di dispositivi	Windows Desktop Extension SDK (è stato introdotto in 10.0.10240.0) Xbox One Extensions for the UWP (è stato introdotto in 10.0.10586.0)
API contract	Windows.UI.ApplicationSettings.ApplicationsSettingsContract (è stato introdotto in v1.0)

Esempio

Il codice seguente illustra come aggiungere comandi dell'app usando le classi SettingsPane e SettingsCommand . Per l'esempio completo, vedere Esempio di impostazioni dell'app.

using Windows.UI.ApplicationSettings;
using Windows.UI.Popups;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Navigation;
using System;

// This is the click handler for the 'addSettingsScenarioAdd' button.  
// Replace this with your own handler if you have a button or buttons on this page.
void addSettingsScenarioAdd_Click(object sender, RoutedEventArgs e)
{
    Button b = sender as Button;
    if (b != null)
    {
        rootPage.NotifyUser(
            "You selected the " + b.Content + " button", 
            NotifyType.StatusMessage);

        if (!this.isEventRegistered)
        {
            SettingsPane.GetForCurrentView().CommandsRequested += onCommandsRequested;
            this.isEventRegistered = true;
        }
    }
}

void onSettingsCommand(IUICommand command)
{
    SettingsCommand settingsCommand = (SettingsCommand)command;
    rootPage.NotifyUser(
        "You selected the " + settingsCommand.Label + " settings command from the " + 
        SettingsPane.Edge.ToString(), NotifyType.StatusMessage);

}

void onCommandsRequested(
    SettingsPane settingsPane, 
    SettingsPaneCommandsRequestedEventArgs eventArgs)
{
    UICommandInvokedHandler handler = new UICommandInvokedHandler(onSettingsCommand);

    SettingsCommand generalCommand = new SettingsCommand(
        "generalSettings", "General", handler);
    eventArgs.Request.ApplicationCommands.Add(generalCommand);

    SettingsCommand helpCommand = new SettingsCommand("helpPage", "Help", handler);
    eventArgs.Request.ApplicationCommands.Add(helpCommand);
}

Imports Windows.UI.ApplicationSettings
Imports Windows.UI.Popups
Imports Windows.UI.Xaml
Imports Windows.UI.Xaml.Controls
Imports Windows.UI.Xaml.Navigation
Imports System

    '' This is the click handler for the 'addSettingsScenarioAdd' button.  
    '' Replace this with your own handler if you have a button or buttons on this page.
    Private Sub addSettingsScenarioAdd_Click(sender As Object, e As RoutedEventArgs)
        Dim b As Button = TryCast(sender, Button)
        If b IsNot Nothing Then
            rootPage.NotifyUser("You selected the " & b.Content & " button", _
                NotifyType.StatusMessage)
            If Not Me.isEventRegistered Then
                AddHandler SettingsPane.GetForCurrentView.CommandsRequested, _
                    AddressOf onCommandsRequested
                Me.isEventRegistered = True
            End If
        End If
    End Sub

    Private Sub onSettingsCommand(command As IUICommand)
        Dim settingsCommand As SettingsCommand = DirectCast(command, SettingsCommand)
        rootPage.NotifyUser( _
        "You selected the " & settingsCommand.Label & " command from the " & SettingsPane.Edge.ToString(), _
        NotifyType.StatusMessage)
    End Sub

    Private Sub onCommandsRequested(settingsPane As SettingsPane, _
        eventArgs As SettingsPaneCommandsRequestedEventArgs)
        Dim handler As New UICommandInvokedHandler(AddressOf onSettingsCommand)

        Dim generalCommand As New SettingsCommand("generalSettings", "General", handler)
        eventArgs.Request.ApplicationCommands.Add(generalCommand)

        Dim helpCommand As New SettingsCommand("helpPage", "Help", handler)
        eventArgs.Request.ApplicationCommands.Add(helpCommand)
    End Sub


    '' This is the click handler for the 'addSettingsScenarioShow' button.  
    '' Replace this with your own handler if you have a button or buttons on this page.
    Private Sub addSettingsScenarioShow_Click(sender As Object, e As RoutedEventArgs)
        Dim b As Button = TryCast(sender, Button)
        If b IsNot Nothing Then
            rootPage.NotifyUser("You selected the " & b.Content & " button", _
                NotifyType.StatusMessage)
            SettingsPane.Show()
        End If
    End Sub

#include "pch.h"
#include "AddSettingsScenario.xaml.h"

using namespace ApplicationSettings;

using namespace Windows::Foundation;
using namespace Windows::UI::Xaml;
using namespace Windows::UI::Xaml::Controls;
using namespace Windows::UI::Xaml::Navigation;
using namespace Windows::UI::ApplicationSettings;
using namespace Windows::UI::Popups;

void ApplicationSettings::AddSettingsScenario::addSettingsScenarioAdd_Click(
    Platform::Object^ sender, Windows::UI::Xaml::RoutedEventArgs^ e)
{
    Button^ b = safe_cast<Button^>(sender);
    if (b != nullptr)
    {
        rootPage->NotifyUser("You selected the " + b->Content + " button", 
            NotifyType::StatusMessage);
        if (!this->isEventRegistered)
        {
            this->commandsRequestedEventRegistrationToken = 
                SettingsPane::GetForCurrentView()->CommandsRequested += 
                    ref new TypedEventHandler<SettingsPane^, 
                    SettingsPaneCommandsRequestedEventArgs^>(this, 
                        &AddSettingsScenario::onCommandsRequested);
            this->isEventRegistered = true;
        }
    }
}

void ApplicationSettings::AddSettingsScenario::onSettingsCommand(
    Windows::UI::Popups::IUICommand^ command)
{
    SettingsCommand^ settingsCommand = safe_cast<SettingsCommand^>(command);
    rootPage->NotifyUser(
        "You selected the " + settingsCommand->Label + " settings command from the " + 
        SettingsPane::Edge.ToString(), NotifyType::StatusMessage);
}

void ApplicationSettings::AddSettingsScenario::onCommandsRequested(
    Windows::UI::ApplicationSettings::SettingsPane^ settingsPane,
    Windows::UI::ApplicationSettings::SettingsPaneCommandsRequestedEventArgs^ eventArgs)
{
    UICommandInvokedHandler^ handler = ref new UICommandInvokedHandler(
        this, &AddSettingsScenario::onSettingsCommand);

    SettingsCommand^ generalCommand = ref new SettingsCommand(
        "generalSettings", "General", handler);
    eventArgs->Request->ApplicationCommands->Append(generalCommand);

    SettingsCommand^ helpCommand = ref new SettingsCommand("helpPage", "Help", handler);
    eventArgs->Request->ApplicationCommands->Append(helpCommand);
}

Commenti

Nota

Questa classe non è agile, il che significa che è necessario considerare il relativo modello di threading e il comportamento di marshalling. Per altre informazioni, vedere Threading e marshalling (C++/CX) eUso di oggetti Windows Runtime in un ambiente multithreaded (.NET).

Proprietà

Edge

Nota SettingsPane è deprecato e potrebbe non funzionare in tutte le versioni di Windows 10. Anziché usare un SettingsPane, integrare le opzioni delle impostazioni nell'esperienza dell'app. Per altre informazioni, vedere Linee guida per le impostazioni dell'app. Ottiene un valore che indica se l'accesso Impostazioni viene visualizzato sul bordo sinistro o destro dello schermo.

Metodi

GetForCurrentView()	Nota SettingsPane è deprecato e potrebbe non funzionare in tutte le versioni di Windows 10. Anziché usare un SettingsPane, integrare le opzioni delle impostazioni nell'esperienza dell'app. Per altre informazioni, vedere Linee guida per le impostazioni dell'app. Ottiene un oggetto SettingsPane associato alla visualizzazione app corrente, ovvero con CoreWindow.
Show()	Nota SettingsPane è deprecato e potrebbe non funzionare in tutte le versioni di Windows 10. Anziché usare un SettingsPane, integrare le opzioni delle impostazioni nell'esperienza dell'app. Per altre informazioni, vedere Linee guida per le impostazioni dell'app. Visualizza il riquadro Accesso impostazioni all'utente.

Eventi

CommandsRequested

Nota SettingsPane è deprecato e potrebbe non funzionare in tutte le versioni di Windows 10. Anziché usare un SettingsPane, integrare le opzioni delle impostazioni nell'esperienza dell'app. Per altre informazioni, vedere Linee guida per le impostazioni dell'app. Si verifica quando l'utente apre il riquadro delle impostazioni. L'ascolto di questo evento consente all'app di inizializzare i comandi dell'impostazione e sospendere l'interfaccia utente fino a quando l'utente chiude il riquadro. Durante questo evento, aggiungere gli oggetti SettingsCommand al vettore ApplicationCommands disponibile per renderli disponibili all'interfaccia utente SettingsPane.

Vedi anche

• SettingsCommand
• Esempio di impostazioni dell'app