JumpListItem Klasse

Definition

Namespace:

Windows.UI.StartScreen

Bietet Funktionen zum Erstellen und Definieren von Sprunglistenelementen für die Sprungliste einer App.

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

Vererbung

Object Platform::Object IInspectable JumpListItem

Attribute

ContractVersionAttribute MarshalingBehaviorAttribute

Windows-Anforderungen

Gerätefamilie	Windows 10 (eingeführt in 10.0.10586.0)
API contract	Windows.Foundation.UniversalApiContract (eingeführt in v2.0)

Beispiele

Im folgenden Beispiel wird veranschaulicht, wie Sie eine Aufgabe für eine JumpList erstellen, die die App mit Befehlszeilenparametern startet und eine gewünschte Aktion ausführt. Lokalisierung wird nicht angezeigt, ist aber für displayName, description und logo durch die Verwendung der URI-Schemas ms-resource: und ms-appx: möglich.

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.
        }
    }
}

Hinweise

Ein JumpListItem wird mit den Methoden CreateWithArguments und CreateSeparator erstellt. Nach der Erstellung können sie der Sprungliste der App mithilfe der Items-Eigenschaft der Sprungliste und der SaveAsync-Methode hinzugefügt werden. Beachten Sie, dass ein Benutzer in der Benutzeroberfläche mit der rechten Maustaste auf ein Sprunglistenelement klicken kann, das sich in einer benutzerdefinierten Gruppe befindet, und "Aus dieser Liste entfernen" auswählen kann. Wenn diese Aktion ausgeführt wird, markiert das System das Element als vom Benutzer entfernt und unterdrückt es von der Benutzeroberfläche. Wenn eine App das nächste Mal die Sprungliste lädt, sollte sie die Elemente überprüfen, um festzustellen, ob die RemovedByUser-Eigenschaft des Elements auf True festgelegt ist. Wenn RemovedByUser auf True festgelegt ist, sollte die App ihren internen Zustand aktualisieren, um mit der vom Benutzer initiierten Änderung synchron zu sein. Es liegt in der Verantwortung der Apps, sicherzustellen, dass ein entferntes Element erst wieder der Sprungliste hinzugefügt wird, bis die Bedingungen für das Hinzufügen erneut erfüllt sind, z. B. durch erneutes Öffnen des zugeordneten Dokuments durch den Benutzer.

Wenn eine App die JumpList mithilfe von SaveAsync speichert, organisiert das Betriebssystem die Elemente wie folgt.

• Alle Elemente, deren RemovedByUser gleich True ist, werden entfernt.
• Elemente mit derselben GroupName-Eigenschaft werden zusammen platziert, wobei ihre relative Reihenfolge beibehalten wird.
• Gruppen werden nach der ursprünglichen Position des ersten Elements in der Gruppe sortiert, mit der Ausnahme, dass vom System verwaltete Gruppen immer oben und die Gruppe Aufgaben immer am unteren Rand liegt, wenn sie vorhanden sind. Das heißt, wenn eine App ihre JumpList mithilfe der LoadCurrentAsync-Methode lädt, werden die Elemente in ihrer organisierten Reihenfolge abgerufen, was möglicherweise nicht mit der Reihenfolge der Elemente in der Sprungliste übereinstimmt, als sie ursprünglich gespeichert wurden.

Eigenschaften

Arguments	Ruft die Befehlszeilenargumente für das Sprunglistenelement ab.
Description	Ruft die Aufgabenbeschreibung des Sprunglistenelements ab oder legt diese fest.
DisplayName	Ruft den Anzeigenamen des Sprunglistenelements ab oder legt diesen fest. Der Anzeigename kann auch als Parameter mit der CreateWithArguments-Methode angegeben werden, wenn das Sprunglistenelement erstellt wird.
GroupName	Ruft den namen des benutzerdefinierten Sprunglistenelements ab oder legt diesen fest. Wenn kein Name angegeben ist, wird das Element standardmäßig der Gruppe Aufgaben hinzugefügt.
Kind	Ruft das JumpListItemKind eines Sprunglistenelements ab.
Logo	Ruft das Logo des Sprunglistenelements ab oder legt es fest.
RemovedByUser	Ruft einen booleschen Wert ab, der angibt, ob das Sprunglistenelement vom Benutzer aus der Sprungliste der App entfernt wurde.

Methoden

CreateSeparator()	Erstellt ein Sprunglistenelement, das ein Inerttrennzeichen für eine benutzerdefinierte Gruppe innerhalb der Sprungliste der App ist.
CreateWithArguments(String, String)	Erstellt ein neues Sprunglistenelement für die Sprungliste einer App.

Weitere Informationen

• Beispiel für die Anpassung von Sprunglisten