Class ICommandBuilderExtensions

Namespace

OneImlx.Terminal.Extensions

Assembly

OneImlx.Terminal.dll

The ICommandBuilder extension methods.

public static class ICommandBuilderExtensions

Inheritance

object

ICommandBuilderExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Checker<TChecker>(ICommandBuilder)

Updates the checker for the registered command descriptor.

public static ICommandBuilder Checker<TChecker>(this ICommandBuilder builder) where TChecker : ICommandChecker

Parameters

builder ICommandBuilder

The ICommandBuilder.

Returns

ICommandBuilder

The configured ICommandBuilder.

Type Parameters

TChecker

The checker type.

CustomProperty(ICommandBuilder, string, object)

Adds a command custom property to the ICommandBuilder.

public static ICommandBuilder CustomProperty(this ICommandBuilder builder, string key, object value)

Parameters

builder ICommandBuilder

The ICommandBuilder.

key string

The custom property key.

value object

The custom property value.

Returns

ICommandBuilder

The configured ICommandBuilder.

DefineArgument(ICommandBuilder, int, string, string, string, ArgumentFlags)

Starts a new IArgumentBuilder definition.

public static IArgumentBuilder DefineArgument(this ICommandBuilder builder, int order, string id, string dataType, string description, ArgumentFlags flags)

Parameters

builder ICommandBuilder

The ICommandBuilder.

order int

The argument order.

id string

The argument id.

dataType string

The argument data type.

description string

The argument description.

flags ArgumentFlags

The argument flags.

Returns

IArgumentBuilder

The configured IArgumentBuilder.

DefineOption(ICommandBuilder, string, string, string, OptionFlags, string?)

Starts a new IOptionBuilder definition.

public static IOptionBuilder DefineOption(this ICommandBuilder builder, string id, string dataType, string description, OptionFlags flags, string? alias = null)

Parameters

builder ICommandBuilder

The ICommandBuilder.

id string

The option id.

dataType string

The option data type.

description string

The option description.

flags OptionFlags

The option flags.

alias string

The option alias.

Returns

IOptionBuilder

The configured IOptionBuilder.

Owners(ICommandBuilder, OwnerIdCollection)

Adds a command owners to the ICommandBuilder.

public static ICommandBuilder Owners(this ICommandBuilder builder, OwnerIdCollection owners)

Parameters

builder ICommandBuilder

The ICommandBuilder.

owners OwnerIdCollection

The owner identifiers.

Returns

ICommandBuilder

The configured ICommandBuilder.

Tags(ICommandBuilder, TagIdCollection)

Adds command tags to the ICommandBuilder.

public static ICommandBuilder Tags(this ICommandBuilder builder, TagIdCollection tagIds)

Parameters

builder ICommandBuilder

The ICommandBuilder.

tagIds TagIdCollection

The tag identifiers.

Returns

ICommandBuilder

The configured ICommandBuilder.