CommandLineBuilderExtensions.UseHelpBuilder<TBuilder> Method

Definition

Namespace:

System.CommandLine.Builder

Assembly:

System.CommandLine.dll

Package:

System.CommandLine v2.0.0-beta4.22272.1

Source:

CommandLineBuilderExtensions.cs

Specifies an HelpBuilder to be used to format help output when help is requested.

public:
generic <typename TBuilder>
 where TBuilder : System::CommandLine::Builder::CommandLineBuilder[System::Runtime::CompilerServices::Extension]
 static TBuilder UseHelpBuilder(TBuilder builder, Func<System::CommandLine::Binding::BindingContext ^, System::CommandLine::Help::HelpBuilder ^> ^ getHelpBuilder);

public static TBuilder UseHelpBuilder<TBuilder>(this TBuilder builder, Func<System.CommandLine.Binding.BindingContext,System.CommandLine.Help.HelpBuilder> getHelpBuilder) where TBuilder : System.CommandLine.Builder.CommandLineBuilder;

static member UseHelpBuilder : 'Builder * Func<System.CommandLine.Binding.BindingContext, System.CommandLine.Help.HelpBuilder> -> 'Builder (requires 'Builder :> System.CommandLine.Builder.CommandLineBuilder)

<Extension()>
Public Function UseHelpBuilder(Of TBuilder As CommandLineBuilder) (builder As TBuilder, getHelpBuilder As Func(Of BindingContext, HelpBuilder)) As TBuilder

Type Parameters

TBuilder

Parameters

builder

TBuilder

A command line builder.

getHelpBuilder

Func<BindingContext,HelpBuilder>

A delegate that returns an instance of HelpBuilder

Returns

TBuilder

The same instance of CommandLineBuilder.