New to Telerik UI for WPF? Start a free 30-day trial

ReferenceFieldBase

Class

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:

public abstract class ReferenceFieldBase : CodeBasedField, ISupportInitialize

Inheritance: objectFieldCodeBasedFieldReferenceFieldBase

Derived Classes: PageReferenceFieldReferenceField

Implements: ISupportInitialize

Inherited Members CodeBasedField.DateTimeFormattingPropertyCodeBasedField.GeneralFormattingPropertyCodeBasedField.NumericFormattingPropertyCodeBasedField.ToolTipPropertyCodeBasedField.CopyPropertiesFrom(FieldCodeExpression)CodeBasedField.InvalidateCode()CodeBasedField.GetCodeFragment()CodeBasedField.MakeHyperlinkFragment(DocumentFragment, HyperlinkInfo)CodeBasedField.GetNumberResultWithFormatting(int)CodeBasedField.IsCodeValid()CodeBasedField.CodeBuilderCodeBasedField.FieldCodeCodeBasedField.DateTimeFormattingCodeBasedField.GeneralFormattingCodeBasedField.NumericFormattingCodeBasedField.ToolTipField.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()

public ReferenceFieldBase()

Fields

BookmarkNameProperty

FieldPropertyDefinition

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

public static readonly FieldPropertyDefinition BookmarkNameProperty

Field Value:

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

string

protected static readonly string ReferenceSourceNotFoundError

Properties

BookmarkName

string

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

[XamlSerializable]
public string BookmarkName { get; set; }

ShouldCreateHyperlink

bool

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

[XamlSerializable(false)]
public bool ShouldCreateHyperlink { get; set; }

ShouldDisplayRelativePosition

bool

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

[XamlSerializable(false)]
public bool ShouldDisplayRelativePosition { get; set; }

Methods

BuildCodeOverride()

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

protected override void BuildCodeOverride()

Overrides: CodeBasedField.BuildCodeOverride()

CopyPropertiesFrom(Field)

Copies all properties from another field of the same type.

public override void CopyPropertiesFrom(Field fromField)

Parameters:fromFieldField

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.

protected override void CopyPropertiesFromCodeExpression(FieldCodeExpression fieldCodeExpression)

Parameters:fieldCodeExpressionFieldCodeExpression

The field code expression.

Overrides: CodeBasedField.CopyPropertiesFromCodeExpression(FieldCodeExpression)

GetRelativePositionString(DocumentPosition, DocumentPosition)

DocumentFragment

protected DocumentFragment GetRelativePositionString(DocumentPosition bookmarkPosition, DocumentPosition currentPosition)

Parameters:bookmarkPositionDocumentPositioncurrentPositionDocumentPositionReturns:

DocumentFragment