SettingsPane Kelas

Definisi

Ruang nama:

Windows.UI.ApplicationSettings

Catatan

SettingsPane tidak digunakan lagi, dan mungkin tidak berfungsi pada semua versi Windows 10. Alih-alih menggunakan SettingsPane, integrasikan opsi pengaturan ke dalam pengalaman aplikasi. Untuk informasi selengkapnya, lihat Panduan untuk pengaturan aplikasi.

Kelas statis yang memungkinkan aplikasi mengontrol panel Tombol Pengaturan. Aplikasi dapat menambahkan atau menghapus perintah, menerima pemberitahuan saat pengguna membuka panel, atau membuka panel secara terprogram.

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

Warisan

Object Platform::Object IInspectable SettingsPane

Atribut

ContractVersionAttribute DeprecatedAttribute MarshalingBehaviorAttribute

Persyaratan Windows

Rangkaian perangkat	Windows Desktop Extension SDK (diperkenalkan dalam 10.0.10240.0) Xbox One Extensions for the UWP (diperkenalkan dalam 10.0.10586.0)
API contract	Windows.UI.ApplicationSettings.ApplicationsSettingsContract (diperkenalkan dalam v1.0)

Contoh

Kode berikut menunjukkan cara menambahkan perintah aplikasi dengan menggunakan kelas SettingsPane dan SettingsCommand . Untuk contoh lengkapnya, lihat Sampel pengaturan aplikasi.

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

Keterangan

Catatan

Kelas ini tidak lincah, yang berarti Anda perlu mempertimbangkan model utas dan perilaku marshalingnya. Untuk informasi selengkapnya, lihat Threading dan Marshaling (C++/CX) dan Menggunakan objek Windows Runtime di lingkungan multithreaded (.NET).

Properti

Edge

Catatan SettingsPane tidak digunakan lagi, dan mungkin tidak berfungsi pada semua versi Windows 10. Alih-alih menggunakan SettingsPane, integrasikan opsi pengaturan ke dalam pengalaman aplikasi. Untuk informasi selengkapnya, lihat Panduan untuk pengaturan aplikasi. Mendapatkan nilai yang menunjukkan apakah tombol Pengaturan muncul di tepi kiri atau kanan layar.

Metode

GetForCurrentView()	Catatan SettingsPane tidak digunakan lagi, dan mungkin tidak berfungsi pada semua versi Windows 10. Alih-alih menggunakan SettingsPane, integrasikan opsi pengaturan ke dalam pengalaman aplikasi. Untuk informasi selengkapnya, lihat Panduan untuk pengaturan aplikasi. Mendapatkan objek SettingsPane yang terkait dengan tampilan aplikasi saat ini (yaitu, dengan CoreWindow).
Show()	Catatan SettingsPane tidak digunakan lagi, dan mungkin tidak berfungsi pada semua versi Windows 10. Alih-alih menggunakan SettingsPane, integrasikan opsi pengaturan ke dalam pengalaman aplikasi. Untuk informasi selengkapnya, lihat Panduan untuk pengaturan aplikasi. Menampilkan panel Tombol Pengaturan kepada pengguna.

Acara

CommandsRequested

Catatan SettingsPane tidak digunakan lagi, dan mungkin tidak berfungsi pada semua versi Windows 10. Alih-alih menggunakan SettingsPane, integrasikan opsi pengaturan ke dalam pengalaman aplikasi. Untuk informasi selengkapnya, lihat Panduan untuk pengaturan aplikasi. Terjadi saat pengguna membuka panel pengaturan. Mendengarkan peristiwa ini memungkinkan aplikasi menginisialisasi perintah pengaturan dan menjeda UI-nya hingga pengguna menutup panel. Selama kejadian ini, tambahkan objek SettingsCommand Anda ke vektor ApplicationCommands yang tersedia untuk membuatnya tersedia untuk UI SettingsPane.

Lihat juga

• SettingsCommand
• Sampel pengaturan aplikasi