HelpBuilderExtensions.CustomizeSymbol Method

Definition

Namespace:

System.CommandLine.Help

Assembly:

System.CommandLine.dll

Package:

System.CommandLine v2.0.0-beta4.22272.1

Source:

HelpBuilderExtensions.cs

Specifies custom help details for a specific symbol.

public static void CustomizeSymbol(this System.CommandLine.Help.HelpBuilder builder, System.CommandLine.Symbol symbol, string? firstColumnText = default, string? secondColumnText = default, string? defaultValue = default);

static member CustomizeSymbol : System.CommandLine.Help.HelpBuilder * System.CommandLine.Symbol * string * string * string -> unit

<Extension()>
Public Sub CustomizeSymbol (builder As HelpBuilder, symbol As Symbol, Optional firstColumnText As String = Nothing, Optional secondColumnText As String = Nothing, Optional defaultValue As String = Nothing)

Parameters

builder

HelpBuilder

The help builder to write with.

symbol

Symbol

The symbol to customize the help details for.

firstColumnText

String

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

secondColumnText

String

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

defaultValue

String

The displayed default value for the symbol.