New to Telerik Document Processing? Start a free 30-day trial

Field

Class

Abstract base for all field implementations that calculate and produce dynamic content during field updates.

Definition

Namespace:Telerik.Documents.Flow.Model.Fields

Assembly:Telerik.Windows.Documents.Flow.dll

Syntax:

C#
public abstract class Field

Inheritance: objectField

Derived Classes: ComparisonFieldBaseCustomCodeFieldDateFieldDocumentVariableFieldExpressionFieldHyperlinkMergeFieldNumberingFieldParseErrorFieldSeqFieldTaFieldTableFieldBaseTcFieldTimeField...

Constructors

Initializes a new instance of the Field class and associates it with the specified document.

C#
protected Field(RadFlowDocument document)
Parameters:documentRadFlowDocument

The document.

Properties

Gets the date-time format string applied to date and time field results when the @ switch is specified.

C#
public string DateTimeFormatting { get; }
Property Value:

The date time formatting.

Gets the document in which this field resides and from which it retrieves context during updates.

C#
public RadFlowDocument Document { get; }
Property Value:

The document.

Gets the collection of general formatting switches (such as capitalization and text casing) applied to field results when the * switch is specified.

C#
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Formattings")]
public IList<string> GeneralFormattings { get; }
Property Value:

The general formatting collection.

Gets the numeric format string applied to numeric field results when the # switch is specified.

C#
public string NumericFormatting { get; }
Property Value:

The numeric formatting.

Methods

Encodes a parameter.

C#
protected static string EncodeParameter(string parameter)
Parameters:parameterstring

The parameter.

Returns:

string

Gets the formatted date.

C#
protected string GetFormattedDate(DateTime date)
Parameters:dateDateTime

The date.

Returns:

string

Determines whether a switch can have an argument.

C#
protected virtual bool IsSwitchWithArgumentOverride(string switchKey)
Parameters:switchKeystring

The switch key.

Returns:

bool

True if the switch can have argument.