HelpBuilder Класс

Определение

Пространство имен:

System.CommandLine.Help

Сборка:

System.CommandLine.dll

Форматирует выходные данные, отображаемые пользователям, чтобы описать, как использовать программу командной строки.

public ref class HelpBuilder

public class HelpBuilder

type HelpBuilder = class

Public Class HelpBuilder

Наследование

Object

HelpBuilder

Конструкторы

HelpBuilder(LocalizationResources, Int32)

Форматирует выходные данные, отображаемые пользователям, чтобы описать, как использовать программу командной строки.

Свойства

LocalizationResources	Предоставляет локализуемые строки для справки и сообщений об ошибках.
MaxWidth	Максимальная ширина, для которой нужно отформатировать выходные данные справки.

Методы

CustomizeLayout(Func<HelpContext,IEnumerable<HelpSectionDelegate>>)	Настраивает отображаемые разделы справки.
CustomizeSymbol(Symbol, Func<HelpContext,String>, Func<HelpContext,String>, Func<HelpContext,String>)	Указывает сведения о пользовательской справке для определенного символа.
Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
GetHashCode()	Служит хэш-функцией по умолчанию. (Унаследовано от Object)
GetTwoColumnRow(Symbol, HelpContext)	Возвращает элемент справки для указанного символа.
GetType()	Возвращает объект Type для текущего экземпляра. (Унаследовано от Object)
MemberwiseClone()	Создает неполную копию текущего объекта Object. (Унаследовано от Object)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)
Write(HelpContext)	Записывает выходные данные справки для указанной команды.
WriteColumns(IReadOnlyList<TwoColumnHelpRow>, HelpContext)	Записывает указанные строки справки, выравнивая выходные данные по столбцам.

Методы расширения

CustomizeSymbol(HelpBuilder, Symbol, String, String, String)	Указывает сведения о пользовательской справке для определенного символа.
Write(HelpBuilder, Command, TextWriter)	Записывает выходные данные справки для указанной команды.