JumpList クラス

リファレンス

定義

名前空間:: Windows.UI.StartScreen

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

編集

アプリのジャンプリストの機能を提供します。ジャンプリストは、ユーザーがタスクバーまたはスタートメニューでプログラムを右クリックしたときに表示されるシステム提供のメニューです。最近または頻繁に使用されるドキュメントにすばやくアクセスし、アプリ機能への直接リンクを提供するために使用されます。すべてのデバイスファミリがジャンプリストをサポートしているわけではありません。

public ref class JumpList sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 131072)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class JumpList final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 131072)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class JumpList

Public NotInheritable Class JumpList

継承: Object Platform::Object IInspectable JumpList

属性: ContractVersionAttribute MarshalingBehaviorAttribute

Windows の要件

デバイスファミリ	Windows 10 (10.0.10586.0 で導入)
API contract	Windows.Foundation.UniversalApiContract (v2.0 で導入)

例

次の例では、以前に追加された可能性のあるカスタム項目を含め、アプリのジャンプリストを削除する方法を示します。

private async void DisableSystemJumpListAsync()
{
    // Get the app's jump list.
    var jumpList = await Windows.UI.StartScreen.JumpList.LoadCurrentAsync();

    // Disable the system-managed jump list group.
    jumpList.SystemGroupKind = Windows.UI.StartScreen.JumpListSystemGroupKind.None;

    // Remove any previously added custom jump list items.
    jumpList.Items.Clear();

    // Save the changes to the app's jump list.
    await jumpList.SaveAsync();
}

次の例では、既存のカスタムジャンプリスト項目に影響を与えることなく、アプリのジャンプリストで使用されるシステムマネージドグループの種類を設定する方法を示します。

private async void SetSystemGroupAsync()
{
    // Get the app's jump list.
    var jumpList = await Windows.UI.StartScreen.JumpList.LoadCurrentAsync();

    // Set the system to autogenerate a Frequent group for the app jump list.
    // Alternatively, this property could be set to JumpListSystemGroupKind.Recent to autogenerate a Recent group.
    jumpList.SystemGroupKind = Windows.UI.StartScreen.JumpListSystemGroupKind.Frequent;

    // No changes were made to the jump list Items property, so any custom tasks and groups remain intact.
    await jumpList.SaveAsync();
}

注釈

アプリの JumpList は、LoadCurrentAsync メソッドを使用して取得されます。アプリケーションがジャンプリストをカスタマイズしない場合、システムは既定のジャンプリストを提供します。現在、既定のジャンプリストには最近使用した項目が表示されます。アプリが、最近使用したアイテムの一覧に表示する特定のファイルの種類の既定のファイルハンドラーに登録されていることを確認します。詳細については、「ファイルのアクティブ化を処理する」を参照してください。

プロパティ

Items	ジャンプリストの JumpListItem のリストを取得します。項目の種類は IVector(JumpListItem)です。
SystemGroupKind	システム管理ジャンプリストグループの現在の種類を取得または設定します。

メソッド

IsSupported()	システムがジャンプリストをサポートしているかどうかを示す値を取得します。 Note デスクトップデバイスファミリのみがジャンプリストをサポートし、別のデバイスファミリを持つジャンプリストに加えられた変更は保持されません。
LoadCurrentAsync()	現在のジャンプリストとその項目を非同期的に取得します。
SaveAsync()	ジャンプリストとその項目に対する変更を非同期的に保存します。

適用対象

こちらもご覧ください

ジャンプリストのカスタマイズサンプル