Class
Field

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

Definition

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

Assembly:Telerik.Windows.Documents.Flow.dll

Syntax:

cs-api-definition

public abstract class Field

Inheritance: objectField

Derived Classes: ComparisonFieldBaseCustomCodeFieldDateFieldDocumentVariableFieldExpressionFieldHyperlinkMergeFieldNumberingFieldParseErrorFieldSeqFieldTaFieldTableFieldBaseTcFieldTimeField

Constructors

Field(RadFlowDocument)

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

Declaration

cs-api-definition

protected Field(RadFlowDocument document)

Parameters

document

RadFlowDocument

The document.

Properties

DateTimeFormatting

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

Declaration

cs-api-definition

public string DateTimeFormatting { get; }

Property Value

string

The date time formatting.

Document

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

Declaration

cs-api-definition

public RadFlowDocument Document { get; }

Property Value

RadFlowDocument

The document.

GeneralFormattings

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

Declaration

cs-api-definition

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

Property Value

IList<string>

The general formatting collection.

NumericFormatting

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

Declaration

cs-api-definition

public string NumericFormatting { get; }

Property Value

string

The numeric formatting.

Methods

EncodeParameter(string)

Encodes a parameter.

Declaration

cs-api-definition

protected static string EncodeParameter(string parameter)

Parameters

parameter

string

The parameter.

Returns

string

GetFormattedDate(DateTime)

Gets the formatted date.

Declaration

cs-api-definition

protected string GetFormattedDate(DateTime date)

Parameters

date

DateTime

The date.

Returns

string

IsSwitchWithArgumentOverride(string)

Determines whether a switch can have an argument.

Declaration

cs-api-definition

protected virtual bool IsSwitchWithArgumentOverride(string switchKey)

Parameters

switchKey

string

The switch key.

Returns

bool

True if the switch can have argument.

ClassField

Class
Field