SettingsPane Klasse

Definition

Namespace:

Windows.UI.ApplicationSettings

Hinweis

SettingsPane ist veraltet und funktioniert möglicherweise nicht in allen Versionen von Windows 10. Anstatt eine Einstellungsspanne zu verwenden, integrieren Sie Einstellungsoptionen in die App-Benutzeroberfläche. Weitere Informationen finden Sie unter Richtlinien für App-Einstellungen.

Eine statische Klasse, die es der App ermöglicht, den Bereich Charm "Einstellungen" zu steuern. Die App kann Befehle hinzufügen oder entfernen, eine Benachrichtigung erhalten, wenn der Benutzer den Bereich öffnet, oder den Bereich programmgesteuert öffnen.

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

Vererbung

Object Platform::Object IInspectable SettingsPane

Attribute

ContractVersionAttribute DeprecatedAttribute MarshalingBehaviorAttribute

Windows-Anforderungen

Gerätefamilie	Windows Desktop Extension SDK (eingeführt in 10.0.10240.0) Xbox One Extensions for the UWP (eingeführt in 10.0.10586.0)
API contract	Windows.UI.ApplicationSettings.ApplicationsSettingsContract (eingeführt in v1.0)

Beispiele

Der folgende Code zeigt, wie App-Befehle mithilfe der Klassen SettingsPane und SettingsCommand hinzugefügt werden. Das vollständige Beispiel finden Sie unter Beispiel für App-Einstellungen.

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);
}

Hinweise

Hinweis

Diese Klasse ist nicht agil, was bedeutet, dass Sie das Threadingmodell und das Marshallingverhalten berücksichtigen müssen. Weitere Informationen finden Sie unter Threading and Marshaling (C++/CX) und Using Windows-Runtime objects in a multithreaded environment (.NET).

Eigenschaften

Edge

Hinweis SettingsPane ist veraltet und funktioniert möglicherweise nicht in allen Versionen von Windows 10. Anstatt eine Einstellungsspanne zu verwenden, integrieren Sie Einstellungsoptionen in die App-Benutzeroberfläche. Weitere Informationen finden Sie unter Richtlinien für App-Einstellungen. Ruft einen Wert ab, der angibt, ob der Charm Einstellungen am linken oder rechten Bildschirmrand angezeigt wird.

Methoden

GetForCurrentView()	Hinweis SettingsPane ist veraltet und funktioniert möglicherweise nicht in allen Versionen von Windows 10. Anstatt eine Einstellungsspanne zu verwenden, integrieren Sie Einstellungsoptionen in die App-Benutzeroberfläche. Weitere Informationen finden Sie unter Richtlinien für App-Einstellungen. Ruft ein SettingsPane-Objekt ab, das der aktuellen App-Ansicht (also mit CoreWindow) zugeordnet ist.
Show()	Hinweis SettingsPane ist veraltet und funktioniert möglicherweise nicht in allen Versionen von Windows 10. Anstatt eine Einstellungsspanne zu verwenden, integrieren Sie Einstellungsoptionen in die App-Benutzeroberfläche. Weitere Informationen finden Sie unter Richtlinien für App-Einstellungen. Zeigt dem Benutzer den Bereich Charm "Einstellungen" an.

Ereignisse

CommandsRequested

Hinweis SettingsPane ist veraltet und funktioniert möglicherweise nicht in allen Versionen von Windows 10. Anstatt eine Einstellungsspanne zu verwenden, integrieren Sie Einstellungsoptionen in die App-Benutzeroberfläche. Weitere Informationen finden Sie unter Richtlinien für App-Einstellungen. Tritt auf, wenn der Benutzer den Einstellungsbereich öffnet. Beim Lauschen auf dieses Ereignis kann die App die Einstellungsbefehle initialisieren und die Benutzeroberfläche anhalten, bis der Benutzer den Bereich schließt. Fügen Sie während dieses Ereignisses Ihre SettingsCommand-Objekte an den verfügbaren ApplicationCommands-Vektor an, um sie für die Benutzeroberfläche "Einstellungen"verfügbar zu machen.

Weitere Informationen

• SettingsCommand
• Beispiel für App-Einstellungen