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

CodeBasedField

Class

Definition

Namespace:Telerik.WinForms.Documents.Model

Assembly:Telerik.WinControls.RichTextEditor.dll

Syntax:

public abstract class CodeBasedField : Field, ISupportInitialize

Inheritance: objectFieldCodeBasedField

Derived Classes: AuthorFieldBibliographyFieldCitationFieldDateFieldDocumentVariableFieldHyperlinkFieldIncludePictureFieldMergeFieldNotSupportedFieldNumPagesFieldPageFieldReferenceFieldBaseSequentialFieldStyleReferenceFieldSymbolFieldTCFieldTableOfContentsField...

Implements: ISupportInitialize

Inherited Members Field.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

CodeBasedField()

Initializes a new instance of the CodeBasedField class.

public CodeBasedField()

Fields

DateTimeFormattingProperty

FieldPropertyDefinition

The date time formatting.

public static readonly FieldPropertyDefinition DateTimeFormattingProperty

GeneralFormattingProperty

FieldPropertyDefinition

The general formatting.

public static readonly FieldPropertyDefinition GeneralFormattingProperty

NumericFormattingProperty

FieldPropertyDefinition

The numeric formatting.

public static readonly FieldPropertyDefinition NumericFormattingProperty

Properties

CodeBuilder

FieldCodeBuilder

Gets the FieldCodeBuilder used to create the code fragment of the field.

protected FieldCodeBuilder CodeBuilder { get; }

DateTimeFormatting

string

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

FieldCode

string

Gets the code of the field.

public string FieldCode { get; }

GeneralFormatting

string

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

NumericFormatting

string

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

Methods

BuildCodeOverride()

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

protected virtual void 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: Field.CopyPropertiesFrom(Field)

CopyPropertiesFrom(FieldCodeExpression)

Copies the properties of the field from a FieldCodeExpression instance.

public void CopyPropertiesFrom(FieldCodeExpression fieldCodeExpression)

Parameters:fieldCodeExpressionFieldCodeExpression

The field code expression.

CopyPropertiesFromCodeExpression(FieldCodeExpression)

Copies the field-specific properties from a FieldCodeExpression.

protected virtual void CopyPropertiesFromCodeExpression(FieldCodeExpression fieldCodeExpression)

Parameters:fieldCodeExpressionFieldCodeExpression

The field code expression.

GetCodeFragment()

Gets the code fragment of the field. If the code is currently not valid, it will be rebuilt.

protected override DocumentFragment GetCodeFragment()

Returns:

DocumentFragment

The code fragment

Overrides: Field.GetCodeFragment()

GetNumberResultWithFormatting(int)

protected string GetNumberResultWithFormatting(int number)

Parameters:numberintReturns:

string

InvalidateCode()

Invalidates the code fragment of the field. The next time the code fragment is requested, it will be built anew.

protected void InvalidateCode()

IsCodeValid()

Gets the value indicating whether the code in the code fragment is currently valid.

protected override bool IsCodeValid()

Returns:

bool

The value indicating whether the code in the code fragment is currently valid.

Overrides: Field.IsCodeValid()

MakeHyperlinkFragment(DocumentFragment, HyperlinkInfo)

protected DocumentFragment MakeHyperlinkFragment(DocumentFragment fragment, HyperlinkInfo hyperlinkInfo)

Parameters:fragmentDocumentFragmenthyperlinkInfoHyperlinkInfoReturns:

DocumentFragment