Class ParameterText

Namespace

TechnologySolutions.Rfid.AsciiProtocol.Parameters

Assembly

TechnologySolutions.Rfid.AsciiProtocol.Core.dll

Represents a command line parameter that has a text value

public class ParameterText : ParameterBase<string>, IParameterAndValue<string>, IParameterValue<string>, ICommandParameter, IParameterAction

Inheritance

object

ParameterBase<string>

ParameterText

Implements

IParameterAndValue<string>

IParameterValue<string>

ICommandParameter

IParameterAction

Derived

ParameterHex

Inherited Members

ParameterBase<string>.ParameterIdentifier

ParameterBase<string>.ParameterFormat

ParameterBase<string>.Value

ParameterBase<string>.ParameterType

ParameterBase<string>.ParameterValue

ParameterBase<string>.AppendToCommandLine(StringBuilder)

ParameterBase<string>.Reset()

ParameterBase<string>.ParseParameter(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ParameterText(string, int, int)

Initializes a new instance of the ParameterText class

public ParameterText(string identifier, int minimumLength, int maximumLength)

Parameters

identifier string

The character(s) that identify the parameter on the command line

minimumLength int

The minimum length of the string

maximumLength int

The maximum length of the string

ParameterText(string, int, int, bool)

Initializes a new instance of the ParameterText class

public ParameterText(string identifier, int minimumLength, int maximumLength, bool quoted)

Parameters

identifier string

The character(s) that identify the parameter on the command line

minimumLength int

The minimum length of the string

maximumLength int

The maximum length of the string

quoted bool

True if the string is output surrounded with double quotes on the command line

Properties

IsQuoted

Gets or sets a value indicating whether the value output to the command line is surrounded in double quotes

public bool IsQuoted { get; set; }

Property Value

bool

MaximumLength

Gets or sets the maximum length of the text in characters

public int MaximumLength { get; set; }

Property Value

int

MinimumLength

Gets or sets the minimum length of the text in characters

public int MinimumLength { get; set; }

Property Value

int

Methods

CheckValue(string)

Checks the text is within the length constraints as the Value property is assigned

protected override string CheckValue(string value)

Parameters

value string

The value to test

Returns

string

The value to assign to the value

ParseValue(string)

Attempt to parse the value from the command line and assign value to the parsed value

protected override string ParseValue(string value)

Parameters

value string

The value to parse

Returns

string

Exceptions

ArgumentOutOfRangeException

If the value is outside the permitted range

FormatException

If the parameter is not in the expected format