Class
FieldParameters

Contains the parsed arguments, switches, expressions, and comparisons extracted from a field code for use by field implementations.

Definition

Namespace:Telerik.Windows.Documents.Flow.Model.Fields.FieldCode

Assembly:Telerik.Windows.Documents.Flow.dll

Syntax:

cs-api-definition
public class FieldParameters

Inheritance: objectFieldParameters

Constructors

FieldParameters()

Initializes a new instance of the FieldParameters class.

Declaration

cs-api-definition
public FieldParameters()

Properties

Comparison

Gets the parsed comparison structure when the field code contains a conditional (e.g., in IF fields).

Declaration

cs-api-definition
public FieldComparison Comparison { get; }

Property Value

FieldComparison

The comparison.

Expression

Gets the expression text when the field code contains a formula or calculation (e.g., in IF or = fields).

Declaration

cs-api-definition
public string Expression { get; }

Property Value

string

The expression.

FirstArgument

Gets the first positional argument from the field code, or null if none exists.

Declaration

cs-api-definition
public FieldArgument FirstArgument { get; }

Property Value

FieldArgument

The first field argument.

SecondArgument

Gets the second positional argument from the field code, or null if fewer than two arguments exist.

Declaration

cs-api-definition
public FieldArgument SecondArgument { get; }

Property Value

FieldArgument

The second field argument.

Methods

GetSwitchArguments(string)

Retrieves the argument values for all switches matching the specified key, or an empty list if none exist.

Declaration

cs-api-definition
public IList<string> GetSwitchArguments(string switchKey)

Parameters

switchKey

string

The switch key.

Returns

IList<string>

The switch argument value(s) if there is such switch, otherwise - an empty string.

IsSwitchDefined(string)

Checks whether the field code contains a switch with the specified key.

Declaration

cs-api-definition
public bool IsSwitchDefined(string switchKey)

Parameters

switchKey

string

The switch key.

Returns

bool

True if the switch is defined.

TryGetSwitch(string, out IList<FieldSwitch>)

Attempts to retrieve all switches matching the specified key and returns whether any were found.

Declaration

cs-api-definition
public bool TryGetSwitch(string switchKey, out IList<FieldSwitch> result)

Parameters

switchKey

string

The switch key.

result

IList<FieldSwitch>

The result.

Returns

bool

True if there is such switch(es), otherwise - false.