次の方法で共有


JumpListItem クラス

定義

アプリのジャンプ リストのジャンプ リスト 項目を作成および定義するための機能を提供します。

public ref class JumpListItem sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 131072)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class JumpListItem final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 131072)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class JumpListItem
Public NotInheritable Class JumpListItem
継承
Object Platform::Object IInspectable JumpListItem
属性

Windows の要件

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

次の例では、コマンド ライン パラメーターを使用してアプリを起動し、必要なアクションを実行する JumpList のタスクを作成する方法を示します。 ローカライズは表示されませんが、ms-resource:ms-appx: URI スキームを使用して DisplayNamedescription、ロゴを使用できます。

private Windows.UI.StartScreen.JumpListItem CreateJumpListItemTask()
{
    var taskItem = JumpListItem.CreateWithArguments(
                            "/Argument", "DisplayName");

    // Set the description. (Optional.)
    taskItem.Description = "Compose a new message to " + friendName;

    // Set the logo for this jump list item. Must be ms-appx: or ms-appdata:.
    taskItem.Logo = new Uri("ms-appdata:///local/downloads/taskImage.png");

    // If the GroupName is left blank, then the item goes into the Tasks group by default.

    return taskItem;
}

partial class App
{
    protected override void OnLaunched(LaunchActivatedEventArgs e)
    {
        if (e.Kind == ActivationKind.Launch && e.Arguments == "/Argument")
        {
            // Run code relevant to the task that was selected.
        }
    }
}

注釈

JumpListItem は、 CreateWithArguments メソッドと CreateSeparator メソッドを使用して作成されます。 作成後、ジャンプ リストの Items プロパティと SaveAsync メソッドを使用して、アプリのジャンプ リストに追加できます。 ユーザー インターフェイスでは、ユーザーがカスタム グループ内のジャンプ リスト項目を右クリックし、[このリストから削除] を選択できることに注意してください。 このアクションが発生すると、ユーザーによって削除されたアイテムとしてマークされ、UI から非表示になります。 次回アプリがジャンプ リストを読み込む場合は、アイテムの RemovedByUser プロパティが True に設定されているかどうかを確認するために、アイテムをチェックする必要があります。 RemovedByUser が True の場合、アプリは、ユーザーが開始した変更と同期するように内部状態を更新する必要があります。 削除されたアイテムがジャンプ リストに追加されないようにするのは、アプリの役割です。追加の条件が再び満たされるまで (たとえば、ユーザーが関連付けられたドキュメントを再度開くなど) まで、ジャンプ リストに戻す必要があります。

アプリで SaveAsync を使用して JumpList を保存すると、オペレーティング システムによって項目が次のように整理されます。

  • RemovedByUser が True のアイテムはすべて削除されます。
  • 同じ GroupName プロパティを持つアイテムは、相対的な順序を維持してまとめて配置されます。
  • グループはグループ内の最初の項目の元の位置で並べ替えられますが、システム管理グループが常に一番上にあり、タスク グループが存在する場合は常に一番下に配置されます。 つまり、アプリが LoadCurrentAsync メソッドを使用して JumpList を読み込むと、アイテムは整理された順序で取得されます。これは、最初に保存されたときのジャンプ リスト内のアイテムの順序と一致しない可能性があります。

プロパティ

Arguments

ジャンプ リスト項目のコマンド ライン引数を取得します。

Description

ジャンプ リスト アイテムタスクの説明を取得または設定します。

DisplayName

ジャンプ リスト 項目の表示名を取得または設定します。 ジャンプ リスト項目の作成時に CreateWithArguments メソッドを使用して、表示名をパラメーターとして指定することもできます。

GroupName

ジャンプ リスト 項目のカスタム グループ名を取得または設定します。 名前が指定されていない場合、項目は既定で [タスク] グループに追加されます。

Kind

ジャンプ リスト アイテムの JumpListItemKind を取得します。

Logo

ジャンプ リスト アイテムのロゴを取得または設定します。

RemovedByUser

ジャンプ リスト項目がユーザーによってアプリのジャンプ リストから削除されたかどうかを示すブール値を取得します。

メソッド

CreateSeparator()

アプリのジャンプ リスト内のカスタム グループの不活性区切り記号であるジャンプ リスト 項目を作成します。

CreateWithArguments(String, String)

アプリのジャンプ リストの新しいジャンプ リスト 項目を作成します。

適用対象

こちらもご覧ください