HelpBuilder.CustomizeSymbol Method

Definition

Namespace:

System.CommandLine.Help

Assembly:

System.CommandLine.dll

Specifies custom help details for a specific symbol.

public void CustomizeSymbol (System.CommandLine.Symbol symbol, Func<System.CommandLine.Help.HelpContext,string?>? firstColumnText = default, Func<System.CommandLine.Help.HelpContext,string?>? secondColumnText = default, Func<System.CommandLine.Help.HelpContext,string?>? defaultValue = default);

member this.CustomizeSymbol : System.CommandLine.Symbol * Func<System.CommandLine.Help.HelpContext, string> * Func<System.CommandLine.Help.HelpContext, string> * Func<System.CommandLine.Help.HelpContext, string> -> unit

Public Sub CustomizeSymbol (symbol As Symbol, Optional firstColumnText As Func(Of HelpContext, String) = Nothing, Optional secondColumnText As Func(Of HelpContext, String) = Nothing, Optional defaultValue As Func(Of HelpContext, String) = Nothing)

Parameters

symbol

Symbol

The symbol to specify custom help details for.

firstColumnText

Func<HelpContext,String>

A delegate to display the first help column (typically name and usage information).

secondColumnText

Func<HelpContext,String>

A delegate to display second help column (typically the description).

defaultValue

Func<HelpContext,String>

A delegate to display the default value for the symbol.