ClassFieldInfo
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:
public class FieldInfo
Inheritance: objectFieldInfo
Constructors
FieldInfo(RadFlowDocument)
Initializes a new instance of the FieldInfo class for the specified document.
Declaration
public FieldInfo(RadFlowDocument document)
Parameters
document
The document.
Properties
Document
Gets the document containing this field.
Declaration
public RadFlowDocument Document { get; }
Property Value
The document.
End
Gets the field character that marks the end of the field.
Declaration
public FieldCharacter End { get; }
Property Value
The end field character.
Field
Gets the parsed field instance representing the field code, or null if parsing failed.
IsDirty
Gets or sets whether the field result is outdated and should be recalculated before display.
Declaration
public bool IsDirty { get; set; }
Property Value
The IsDirty value.
IsLocked
Gets or sets whether the field is locked, preventing automatic updates during document processing.
Declaration
public bool IsLocked { get; set; }
Property Value
The IsLocked value.
Separator
Gets the field character that separates the field code from the field result, or null if absent.
Declaration
public FieldCharacter Separator { get; }
Property Value
The separator field character.
Start
Gets the field character that marks the beginning of the field.
Declaration
public FieldCharacter Start { get; }
Property Value
The start field character.
Methods
GetCode()
Extracts the field code as a string, using nested field results for any fields within the code fragment.
GetResult()
Extracts the field result as a string, resolving any nested fields within the result fragment.
UpdateField()
Recalculates the field result and updates any nested fields within the field code fragment.
Declaration
public void UpdateField()