Compartilhar via


CommandLineToolSwitch Class

Definition

The class CommandLineToolSwitch holds information about the properties for each task

public ref class CommandLineToolSwitch
public class CommandLineToolSwitch
type CommandLineToolSwitch = class
Public Class CommandLineToolSwitch
Inheritance
CommandLineToolSwitch

Constructors

CommandLineToolSwitch()

The default constructor creates a new CommandLineToolSwitch to hold the name of the tool, the attributes, the dependent switches, and the values (if they exist)

CommandLineToolSwitch(CommandLineToolSwitchType)

Overloaded constructor. Takes a CommandLineToolSwitchType and sets the type.

Properties

AllowMultipleValues

True if multiple values are allowed.

ArgumentRequired

This attribute specifies whether or not an argument attribute is required.

Arguments

The arguments.

BooleanValue

The BooleanValue is used for the boolean switches, and are set to true or false, depending on what you set it to.

Description

The Description of the parameter

DisplayName

The DisplayName of the parameter

FallbackArgumentParameter

The Fallback attribute is used to specify which property to look at in the case that the argument property is not set, or if the file that the argument property indicates is nonexistent.

FalseSuffix

The flag to append at the end of a switch when the switch is set to false i.e., for all CL switches that are reversible, the FalseSuffix is "-"

IncludeInCommandLine

Specifies if this switch should be included on the command-line.

IsValid

Flag indicating if the switch is valid.

Name

The name of the parameter

Number

The number is the number you wish to append to the end of integer switches

Overrides

This property indicates the parent of the dependency

Parents

This property indicates the parent of the dependency

Required

This property indicates whether or not the property is required in the project file

ReverseSwitchValue

The SwitchValue of the parameter

Reversible

Indicates whether or not the switch is emitted with a flag when false

Separator

The separator indicates the characters that go between the switch and the string in the string typed case, the characters that go between each name for the string array case, or the characters that go between the switch and the appendage for the boolean case.

StringList

Returns the set of inputs to a switch

SwitchValue

The SwitchValue of the parameter

TaskItemArray

Returns the set of inputs to a switch that is a set of ITaskItems

TrueSuffix

The flag to append to the end of the switch when that switch is true i.e., In the OptimizeForWindows98, the switch is OPT, the FalseSuffix is :NOWIN98, and the TrueSuffix is :WIN98

Type

The type of the switch, i.e., boolean, string, stringarray, etc.

Value

The Value of the parameter

Applies to