HelpBuilder Classe

Definição

Namespace:

System.CommandLine.Help

Assembly:

System.CommandLine.dll

Formata a saída a ser mostrada aos usuários para descrever como usar uma ferramenta de linha de comando.

public ref class HelpBuilder

public class HelpBuilder

type HelpBuilder = class

Public Class HelpBuilder

Herança

Object

HelpBuilder

Construtores

HelpBuilder(LocalizationResources, Int32)

Formata a saída a ser mostrada aos usuários para descrever como usar uma ferramenta de linha de comando.

Propriedades

LocalizationResources	Fornece cadeias de caracteres localizáveis para mensagens de ajuda e erro.
MaxWidth	A largura máxima para a qual formatar a saída de ajuda.

Métodos

CustomizeLayout(Func<HelpContext,IEnumerable<HelpSectionDelegate>>)	Personaliza as seções de ajuda que serão exibidas.
CustomizeSymbol(Symbol, Func<HelpContext,String>, Func<HelpContext,String>, Func<HelpContext,String>)	Especifica detalhes de ajuda personalizados para um símbolo específico.
Equals(Object)	Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object)
GetHashCode()	Serve como a função de hash padrão. (Herdado de Object)
GetTwoColumnRow(Symbol, HelpContext)	Obtém um item de ajuda para o símbolo especificado.
GetType()	Obtém o Type da instância atual. (Herdado de Object)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)
Write(HelpContext)	Grava a saída de ajuda para o comando especificado.
WriteColumns(IReadOnlyList<TwoColumnHelpRow>, HelpContext)	Grava as linhas de ajuda especificadas, alinhando a saída em colunas.

Métodos de Extensão

CustomizeSymbol(HelpBuilder, Symbol, String, String, String)	Especifica detalhes de ajuda personalizados para um símbolo específico.
Write(HelpBuilder, Command, TextWriter)	Grava a saída de ajuda para o comando especificado.