Class Field

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

Inheritance
System.Object
Field
ComparisonFieldBase
CustomCodeField
DateField
DocumentVariableField
ExpressionField
Hyperlink
MergeField
NumberingField
ParseErrorField
SeqField
TableFieldBase
TaField
TcField
TimeField
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
Assembly: Telerik.Windows.Documents.Flow.dll

Syntax

public abstract class Field

Constructors

Field(RadFlowDocument)

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

Declaration
protected Field(RadFlowDocument document)
Parameters
RadFlowDocument document

The document.

Properties

DateTimeFormatting

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

Declaration
public string DateTimeFormatting { get; }
Property Value
System.String

The date time formatting.

Document

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

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

The general formatting collection.

NumericFormatting

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

Declaration
public string NumericFormatting { get; }
Property Value
System.String

The numeric formatting.

Methods

EncodeParameter(String)

Encodes a parameter.

Declaration
protected static string EncodeParameter(string parameter)
Parameters
System.String parameter

The parameter.
Returns
System.String

GetFormattedDate(DateTime)

Gets the formatted date.

Declaration
protected string GetFormattedDate(DateTime date)
Parameters
System.DateTime date

The date.
Returns
System.String

IsSwitchWithArgumentOverride(String)

Determines whether a switch can have an argument.

Declaration
protected virtual bool IsSwitchWithArgumentOverride(string switchKey)
Parameters
System.String switchKey

The switch key.
Returns
System.Boolean

True if the switch can have argument.