Class FieldParameters

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

Inheritance
System.Object
FieldParameters
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: Telerik.Windows.Documents.Flow.Model.Fields.FieldCode
Assembly: Telerik.Windows.Documents.Flow.dll

Syntax

public class FieldParameters

Constructors

FieldParameters()

Initializes a new instance of the FieldParameters class.

Declaration
public FieldParameters()

Properties

Comparison

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

Declaration
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
public string Expression { get; }
Property Value
System.String

The expression.

FirstArgument

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

Declaration
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
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
public IList<string> GetSwitchArguments(string switchKey)
Parameters
System.String switchKey

The switch key.
Returns
System.Collections.Generic.IList<System.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
public bool IsSwitchDefined(string switchKey)
Parameters
System.String switchKey

The switch key.
Returns
System.Boolean

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
public bool TryGetSwitch(string switchKey, out IList<FieldSwitch> result)
Parameters
System.String switchKey

The switch key.
System.Collections.Generic.IList<FieldSwitch> result

The result.
Returns
System.Boolean

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

Extension Methods