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)	指定したコマンドのヘルプ出力を書き込みます。