Class
ReferenceFieldBase

Represents the base class for reference fields in the Telerik document model.

Definition

Namespace:Telerik.Windows.Documents.Model

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

cs-api-definition
public abstract class ReferenceFieldBase : CodeBasedField, ISupportInitialize

Inheritance: objectFieldCodeBasedFieldReferenceFieldBase

Derived Classes: PageReferenceFieldReferenceField

Implements: ISupportInitialize

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

Constructors

ReferenceFieldBase()

Declaration

cs-api-definition
public ReferenceFieldBase()

Fields

BookmarkNameProperty

Gets or sets the name of the bookmark associated with the reference field.

Declaration

cs-api-definition
public static readonly FieldPropertyDefinition BookmarkNameProperty

Field Value

FieldPropertyDefinition

A string representing the bookmark name. This property is used to identify the bookmark in the document's structure for navigation or linking purposes.

ReferenceSourceNotFoundError

Declaration

cs-api-definition
protected static readonly string ReferenceSourceNotFoundError

Field Value

string

Properties

BookmarkName

Gets or sets the name of the bookmark associated with the reference field.

Declaration

cs-api-definition
[XamlSerializable]
public string BookmarkName { get; set; }

Property Value

string

Determines whether a hyperlink should be created for the reference field.

Declaration

cs-api-definition
[XamlSerializable(false)]
public bool ShouldCreateHyperlink { get; set; }

Property Value

bool

ShouldDisplayRelativePosition

Determines whether the relative position of the reference field should be displayed.

Declaration

cs-api-definition
[XamlSerializable(false)]
public bool ShouldDisplayRelativePosition { get; set; }

Property Value

bool

Methods

BuildCodeOverride()

Builds the field-specific parts of the code fragment, using the current CodeBuilder.

Declaration

cs-api-definition
protected override void BuildCodeOverride()

Overrides CodeBasedField.BuildCodeOverride()

CopyPropertiesFrom(Field)

Copies all properties from another field of the same type.

Declaration

cs-api-definition
public override void CopyPropertiesFrom(Field fromField)

Parameters

fromField

Field

The other field, which has to be of the same type as the current instance.

Overrides CodeBasedField.CopyPropertiesFrom(Field)

CopyPropertiesFromCodeExpression(FieldCodeExpression)

Copies the field-specific properties from a FieldCodeExpression.

Declaration

cs-api-definition
protected override void CopyPropertiesFromCodeExpression(FieldCodeExpression fieldCodeExpression)

Parameters

fieldCodeExpression

FieldCodeExpression

The field code expression.

Overrides CodeBasedField.CopyPropertiesFromCodeExpression(FieldCodeExpression)

GetRelativePositionString(DocumentPosition, DocumentPosition)

Declaration

cs-api-definition
protected DocumentFragment GetRelativePositionString(DocumentPosition bookmarkPosition, DocumentPosition currentPosition)

Parameters

bookmarkPosition

DocumentPosition

currentPosition

DocumentPosition

Returns

DocumentFragment