Class ExternalCommandLineArgumentDefinition

Defines a command line argument.

Inheritance
System.Object
ExternalCommandLineArgumentDefinition
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Sdl.Desktop.IntegrationApi.Extensions.CommandLine
Assembly: Sdl.Desktop.IntegrationApi.Extensions.dll
Syntax
public class ExternalCommandLineArgumentDefinition

Constructors

ExternalCommandLineArgumentDefinition(String, String)

Creates a new command line argument definition with the given argument name and description.

Declaration
public ExternalCommandLineArgumentDefinition(string name, string description)
Parameters
Type Name Description
System.String name
System.String description

Properties

Aliases

Gets or sets a list of alias arguments that can be used instead of the main argument name in the Name property.

Declaration
public IList<string> Aliases { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<System.String>

Description

Gets or sets the description of the argument (shown in the usage text).

Declaration
public string Description { get; set; }
Property Value
Type Description
System.String

MaxValues

Gets or sets the maximum number of values expected for this argument, if it is specified. Set to -1 in order to allow un unlimited number of values. Defaults to -1.

Declaration
public int MaxValues { get; set; }
Property Value
Type Description
System.Int32

MinValues

Gets or sets the minimum number of values expected for this argument, if it is specified. Defaults to 0.

Declaration
public int MinValues { get; set; }
Property Value
Type Description
System.Int32

Name

Gets or sets the argument name. The user must use this name, preceded by a slash ('/') in order to specify this argument on the command line, followed by a number of values separated by a space.

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String

Required

Gets or sets if this argument is required = true or optional = false. This is currently only used to display square brackets around optional arguments in the command line help.

Declaration
public bool Required { get; set; }
Property Value
Type Description
System.Boolean

SampleValues

Gets or sets an array of sample argument value strings to be used in the command line help.

Declaration
public string[] SampleValues { get; set; }
Property Value
Type Description
System.String[]
Remarks

The default value is a string[] containing the main argument name appended with '1'. Also when displaying the command line help if more sample names are needed to display required or optional sample names then an incrementing number is appended to the last sample name in the the array.

Extension Methods