New to Telerik Document ProcessingStart a free 30-day trial

Holds the structural information and boundaries (Start, Separator, End) of a field inserted in the document.

Definition

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

Assembly:Telerik.Windows.Documents.Flow.dll

Syntax:

C#
public class FieldInfo

Inheritance: objectFieldInfo

Constructors

Initializes a new instance of the FieldInfo class for the specified document.

C#
public FieldInfo(RadFlowDocument document)
Parameters:documentRadFlowDocument

The document.

Methods

Extracts the field code as a string, using nested field results for any fields within the code fragment.

C#
public string GetCode()
Returns:

string

Current code as string.

Extracts the field result as a string, resolving any nested fields within the result fragment.

C#
public string GetResult()
Returns:

string

Current result as string.

Recalculates the field result and updates any nested fields within the field code fragment.

C#
public void UpdateField()

Properties

Gets the document containing this field.

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

The document.

Gets the field character that marks the end of the field.

C#
public FieldCharacter End { get; }
Property Value:

The end field character.

Gets the parsed field instance representing the field code, or null if parsing failed.

C#
public Field Field { get; }
Property Value:

The current field.

Gets or sets whether the field result is outdated and should be recalculated before display.

C#
public bool IsDirty { get; set; }
Property Value:

The IsDirty value.

Gets or sets whether the field is locked, preventing automatic updates during document processing.

C#
public bool IsLocked { get; set; }
Property Value:

The IsLocked value.

Gets the field character that separates the field code from the field result, or null if absent.

C#
public FieldCharacter Separator { get; }
Property Value:

The separator field character.

Gets the field character that marks the beginning of the field.

C#
public FieldCharacter Start { get; }
Property Value:

The start field character.