Compartilhar via

Classe CommandResult

Definição

Namespace: Microsoft.CommandPalette.Extensions.Toolkit

Indica o que a Paleta de comandos deve fazer depois que um comando é executado. Isso permite que os comandos controlem o fluxo da paleta.

Implementa ICommandResult

A classe CommandResult é usada para especificar o resultado de uma execução de comando na Paleta de Comandos. Ele fornece vários métodos para controlar o comportamento da Paleta de Comandos após a execução de um comando. Essa classe é útil para gerenciar a navegação, exibir mensagens e controlar o estado da Paleta de Comandos.

Propriedades

Propriedade Tipo Descrição
Argumentos ICommandResultArgs Obtém ou define os argumentos associados ao resultado do comando. Isso pode incluir dados adicionais necessários para o resultado do comando.
Tipo CommandResultKind Obtém ou define o resultado do comando. O padrão é CommandResultKind.Dismiss.

Métodos

Método Descrição
Confirm(ConfirmationArgs) Exiba uma caixa de diálogo de confirmação para o usuário.
Dispensar() Feche a Paleta de Comandos depois que a ação for executada e ignore o estado atual. Na próxima inicialização, a Paleta de Comandos começará na página principal com uma consulta em branco.
GoBack() Navegue até a página anterior e mantenha-a aberta.
GoHome() Navegue de volta para a página principal da Paleta de Comandos e mantenha-a aberta. Isso limpa a pilha atual de páginas, mas mantém a paleta aberta.
GoToPage(GoToPageArgs) Navegue para uma página diferente na paleta. O GoToPageArgs especificará para qual página navegar.
Ocultar() Cria uma nova instância de CommandResult com Kind definido como CommandResultKind.Hide e Args definido como null.
KeepOpen() Não faça nada. Isso deixa a paleta em seu estado atual, com a pilha de páginas e a consulta atuais.
ShowToast(Cadeia de caracteres) Exiba uma mensagem transitória no nível da área de trabalho para o usuário. Cria um novo CommandResult com Args definido como um novo objeto ToastArgs com seu Message definido como String.
ShowToast(ToastArgs) Exiba uma mensagem transitória no nível da área de trabalho para o usuário. Cria uma nova instância CommandResult com Args definido como ToastArgs.

Exemplo

Consulte Resultados do Comando para obter um exemplo de como usar isso.

  • Last updated on