Documentation

Class FieldInfo

An class that holds information of a filed that is inserted in the document.

Inheritance
System.Object
FieldInfo
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 class FieldInfo

Constructors

FieldInfo(RadFlowDocument)

Initializes a new instance of the FieldInfo class.

Declaration
public FieldInfo(RadFlowDocument document)
Parameters
RadFlowDocument document

The document.

Properties

Document

Gets the document to which this field is associated.

Declaration
public RadFlowDocument Document { get; }
Property Value
RadFlowDocument

The document.

End

Gets the end field character.

Declaration
public FieldCharacter End { get; }
Property Value
FieldCharacter

The end field character.

Field

Gets the current field.

Declaration
public Field Field { get; }
Property Value
Field

The current field.

IsDirty

Gets or sets the value indicating if the contents of the field should be updated before they are displayed if this functionality is supported by the next processing application.

Declaration
public bool IsDirty { get; set; }
Property Value
System.Boolean

The IsDirty value.

IsLocked

Gets or sets the value indicating that the field is locked. Locked fields are not updated.

Declaration
public bool IsLocked { get; set; }
Property Value
System.Boolean

The IsLocked value.

Separator

Gets the separator field character.

Declaration
public FieldCharacter Separator { get; }
Property Value
FieldCharacter

The separator field character.

Start

Gets the start field character.

Declaration
public FieldCharacter Start { get; }
Property Value
FieldCharacter

The start field character.

Methods

GetCode()

Gets the current code as string. Note that if there are nested fields - their result fragment will used to generate the value returned by this method.

Declaration
public string GetCode()
Returns
System.String

Current code as string.

GetResult()

Gets current result as string. Note that if there are nested fields - their result fragment will be used to generate the value returned by this method.

Declaration
public string GetResult()
Returns
System.String

Current result as string.

UpdateField()

Updates the field. This method will also update all fields inside the code fragment of the current field.

Declaration
public void UpdateField()