Class
PageField

Represents a page field in a document model. The PageField class is used to define fields that can dynamically display information such as page numbers or dates within a document.

Definition

Namespace:Telerik.Windows.Documents.Model

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

cs-api-definition
public class PageField : CodeBasedField, ISupportInitialize

Inheritance: objectFieldCodeBasedFieldPageField

Implements: ISupportInitialize

Inherited Members CodeBasedField.DateTimeFormattingPropertyCodeBasedField.GeneralFormattingPropertyCodeBasedField.NumericFormattingPropertyCodeBasedField.CopyPropertiesFrom(FieldCodeExpression)CodeBasedField.CopyPropertiesFromCodeExpression(FieldCodeExpression)CodeBasedField.BuildCodeOverride()CodeBasedField.InvalidateCode()CodeBasedField.GetCodeFragment()CodeBasedField.MakeHyperlinkFragment(DocumentFragment, HyperlinkInfo)CodeBasedField.CopyPropertiesFrom(Field)CodeBasedField.GetNumberResultWithFormatting(int)CodeBasedField.IsCodeValid()CodeBasedField.CodeBuilderCodeBasedField.FieldCodeCodeBasedField.DateTimeFormattingCodeBasedField.GeneralFormattingCodeBasedField.NumericFormattingField.CodeFragmentFormatField.DisplayNameFragmentFormatField.GetFragmentToDisplay()Field.GetFragmentByDisplayMode(FieldDisplayMode)Field.SetFragmentByDisplayMode(FieldDisplayMode, DocumentFragment)Field.Update()Field.CreateFragmentFromText(string)Field.GetDisplayNameFragment()Field.CreateDeepCopy()Field.SetPropertyValue(FieldPropertyDefinition, string)Field.SetPropertyValue(FieldPropertyDefinition, Field)Field.IsResultFragmentEmpty()Field.HasDisplayNameFragmentField.FieldStartField.DisplayModeField.EvaluationContextField.Document

Constructors

PageField()

Declaration

cs-api-definition
public PageField()

Fields

CachedPageKey

Declaration

cs-api-definition
public static readonly string CachedPageKey

Field Value

string

FieldType

Declaration

cs-api-definition
public static readonly string FieldType

Field Value

string

Properties

FieldTypeName

Gets the name of the field type.

Declaration

cs-api-definition
public override string FieldTypeName { get; }

Property Value

string

Overrides Field.FieldTypeName

Methods

CreateInstance()

Creates a new instance of the current field class.

Declaration

cs-api-definition
public override Field CreateInstance()

Returns

Field

The new field instance.

Overrides Field.CreateInstance()

GetResultFragment()

Builds the result fragment of the field.

Declaration

cs-api-definition
protected override DocumentFragment GetResultFragment()

Returns

DocumentFragment

The result fragment.

Overrides Field.GetResultFragment()