HelpBuilder.CustomizeSymbol Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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> -> unitPublic 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.
Applies to
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
