JumpListItem Classe

Definição

Namespace:

Windows.UI.StartScreen

Fornece funcionalidade para criar e definir itens de lista de atalhos para a lista de atalhos de um aplicativo.

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

Herança

Object Platform::Object IInspectable JumpListItem

Atributos

ContractVersionAttribute MarshalingBehaviorAttribute

Requisitos do Windows

Família de dispositivos	Windows 10 (introduzida na 10.0.10586.0)
API contract	Windows.Foundation.UniversalApiContract (introduzida na v2.0)

Exemplos

O exemplo a seguir demonstra como criar uma tarefa para um JumpList que inicia o aplicativo com parâmetros de linha de comando e executa uma ação desejada. A localização não é mostrada, mas é possível para o DisplayName, descrição e logotipo por meio do uso dos esquemas de URI ms-resource: e ms-appx: .

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

Comentários

Um JumpListItem é criado usando os métodos CreateWithArguments e CreateSeparator . Após a criação, eles podem ser adicionados à lista de atalhos do aplicativo usando a propriedade Items da lista de atalhos e o método SaveAsync . Lembre-se de que, na interface do usuário, um usuário pode clicar com o botão direito do mouse em um item de lista de atalhos que está em um grupo personalizado e selecionar "Remover desta lista". Quando essa ação ocorre, o sistema marca o item como removido pelo usuário e o suprime da interface do usuário. Na próxima vez que um aplicativo carregar a lista de atalhos, ele deverá marcar os itens para ver se a propriedade RemovedByUser do item está definida como True. Se RemovedByUser for True, o aplicativo deverá atualizar seu estado interno para estar em sincronia com a alteração iniciada pelo usuário. É responsabilidade dos aplicativos garantir que um item removido não seja adicionado novamente à lista de atalhos até que as condições para sua adição sejam novamente atendidas, por exemplo, pelo usuário que abre o documento associado novamente.

Quando um aplicativo salva o JumpList usando SaveAsync, o sistema operacional organiza os itens da seguinte maneira.

• Todos os itens com RemovedByUser iguais a True são removidos.
• Os itens com a mesma propriedade GroupName são colocados juntos, preservando sua ordem relativa.
• Os grupos são ordenados pela posição original do primeiro item no grupo, com a exceção de que os grupos gerenciados pelo sistema estão sempre na parte superior e o grupo Tarefas está sempre na parte inferior se estiverem presentes. Isso significa que, quando um aplicativo carrega seu JumpList usando o método LoadCurrentAsync , os itens são recuperados em sua ordem organizada, o que pode não concordar com a ordem dos itens na lista de atalhos quando ele foi salvo originalmente.

Propriedades

Arguments	Obtém os argumentos de linha de comando para o item de lista de atalhos.
Description	Obtém ou define a descrição da tarefa do item de lista de atalhos.
DisplayName	Obtém ou define o nome de exibição do item de lista de atalhos. O nome de exibição também pode ser especificado como um parâmetro usando o método CreateWithArguments quando o item de lista de atalhos é criado.
GroupName	Obtém ou define o nome do grupo personalizado do item de lista de atalhos. Se nenhum nome for especificado, o item será adicionado ao grupo Tarefas por padrão.
Kind	Obtém o JumpListItemKind de um item de lista de atalhos.
Logo	Obtém ou define o logotipo do item de lista de atalhos.
RemovedByUser	Obtém um booliano que indica se o item de lista de atalhos foi removido da lista de atalhos do aplicativo pelo usuário.

Métodos

CreateSeparator()	Cria um item de lista de atalhos que é um separador inerte para um grupo personalizado na lista de atalhos do aplicativo.
CreateWithArguments(String, String)	Cria um novo item de lista de atalhos para a lista de atalhos de um aplicativo.

Confira também

• Exemplo de personalização de lista de atalhos