Class
FieldInfo

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:

cs-api-definition
public class FieldInfo

Inheritance: objectFieldInfo

Constructors

FieldInfo(RadFlowDocument)

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

Declaration

cs-api-definition
public FieldInfo(RadFlowDocument document)

Parameters

document

RadFlowDocument

The document.

Properties

Document

Gets the document containing this field.

Declaration

cs-api-definition
public RadFlowDocument Document { get; }

Property Value

RadFlowDocument

The document.

End

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

Declaration

cs-api-definition
public FieldCharacter End { get; }

Property Value

FieldCharacter

The end field character.

Field

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

Declaration

cs-api-definition
public Field Field { get; }

Property Value

Field

The current field.

IsDirty

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

Declaration

cs-api-definition
public bool IsDirty { get; set; }

Property Value

bool

The IsDirty value.

IsLocked

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

Declaration

cs-api-definition
public bool IsLocked { get; set; }

Property Value

bool

The IsLocked value.

Separator

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

Declaration

cs-api-definition
public FieldCharacter Separator { get; }

Property Value

FieldCharacter

The separator field character.

Start

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

Declaration

cs-api-definition
public FieldCharacter Start { get; }

Property Value

FieldCharacter

The start field character.

Methods

GetCode()

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

Declaration

cs-api-definition
public string GetCode()

Returns

string

Current code as string.

GetResult()

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

Declaration

cs-api-definition
public string GetResult()

Returns

string

Current result as string.

UpdateField()

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

Declaration

cs-api-definition
public void UpdateField()