ClassReferenceFieldBase
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:
Implements:
Inherited Members
Constructors
ReferenceFieldBase()
Declaration
public ReferenceFieldBase()
Fields
BookmarkNameProperty
Gets or sets the name of the bookmark associated with the reference field.
Declaration
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
Declaration
protected static readonly string ReferenceSourceNotFoundError
Field Value
Properties
BookmarkName
Gets or sets the name of the bookmark associated with the reference field.
Declaration
[XamlSerializable]
public string BookmarkName { get; set; }
Property Value
ShouldCreateHyperlink
Determines whether a hyperlink should be created for the reference field.
Declaration
[XamlSerializable(false)]
public bool ShouldCreateHyperlink { get; set; }
Property Value
ShouldDisplayRelativePosition
Determines whether the relative position of the reference field should be displayed.
Declaration
[XamlSerializable(false)]
public bool ShouldDisplayRelativePosition { get; set; }
Property Value
Methods
BuildCodeOverride()
Builds the field-specific parts of the code fragment, using the current CodeBuilder.
Declaration
protected override void BuildCodeOverride()
Overrides
CopyPropertiesFrom(Field)
Copies all properties from another field of the same type.
Declaration
public override void CopyPropertiesFrom(Field fromField)
Parameters
fromField
The other field, which has to be of the same type as the current instance.
Overrides
CopyPropertiesFromCodeExpression(FieldCodeExpression)
Copies the field-specific properties from a FieldCodeExpression.
Declaration
protected override void CopyPropertiesFromCodeExpression(FieldCodeExpression fieldCodeExpression)
Parameters
fieldCodeExpression
The field code expression.
Overrides
GetRelativePositionString(DocumentPosition, DocumentPosition)
Declaration
protected DocumentFragment GetRelativePositionString(DocumentPosition bookmarkPosition, DocumentPosition currentPosition)
Parameters
bookmarkPosition
currentPosition
Returns