Back to all docs
API Reference / Telerik.WinForms.Documents.Model / ReferenceFieldBase
New to Telerik UI for WinForms? Start a free 30-day trial

ReferenceFieldBase

Class

Definition

Namespace:Telerik.WinForms.Documents.Model

Assembly:Telerik.WinControls.RichTextEditor.dll

Syntax:
C#
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()

C#
public ReferenceFieldBase()

Fields

BookmarkNameProperty

C#
public static readonly FieldPropertyDefinition BookmarkNameProperty

ReferenceSourceNotFoundError

C#
protected static readonly string ReferenceSourceNotFoundError

Properties

BookmarkName

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

ShouldCreateHyperlink

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

ShouldDisplayRelativePosition

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

Methods

BuildCodeOverride()

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

C#
protected override void BuildCodeOverride()

Overrides: CodeBasedField.BuildCodeOverride()

CopyPropertiesFrom(Field)

Copies all properties from another field of the same type.

C#
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.

C#
protected override void CopyPropertiesFromCodeExpression(FieldCodeExpression fieldCodeExpression)
Parameters:fieldCodeExpressionFieldCodeExpression

The field code expression.

Overrides: CodeBasedField.CopyPropertiesFromCodeExpression(FieldCodeExpression)

GetRelativePositionString(DocumentPosition, DocumentPosition)

C#
protected DocumentFragment GetRelativePositionString(DocumentPosition bookmarkPosition, DocumentPosition currentPosition)
Parameters:bookmarkPositionDocumentPositioncurrentPositionDocumentPositionReturns:

DocumentFragment

In this article
DefinitionConstructorsReferenceFieldBase()FieldsBookmarkNamePropertyReferenceSourceNotFoundErrorPropertiesBookmarkNameShouldCreateHyperlinkShouldDisplayRelativePositionMethodsBuildCodeOverride()CopyPropertiesFrom(Field)CopyPropertiesFromCodeExpression(FieldCodeExpression)GetRelativePositionString(DocumentPosition, DocumentPosition)
Not finding the help you need?
Contact Support