Class CodeBasedField

Inheritance

System.Object

Field

CodeBasedField

AuthorField

BibliographyField

CitationField

DateField

DocumentVariableField

HyperlinkField

IncludePictureField

MergeField

NotSupportedField

NumPagesField

PageField

ReferenceFieldBase

SequentialField

StyleReferenceField

SymbolField

TableOfContentsField

TCField

Inherited Members

Field.CodeFragmentFormat

Field.DisplayNameFragmentFormat

Field.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.HasDisplayNameFragment

Field.FieldTypeName

Field.FieldStart

Field.DisplayMode

Field.EvaluationContext

Field.Document

Field.FieldPropertySetters

Namespace: Telerik.Windows.Documents.Model

Assembly: Telerik.Windows.Documents.dll

Syntax

public abstract class CodeBasedField : Field, ISupportInitialize

Constructors

CodeBasedField()

Initializes a new instance of the CodeBasedField class.

Declaration

public CodeBasedField()

Fields

DateTimeFormattingProperty

The date time formatting.

Declaration

public static readonly FieldPropertyDefinition DateTimeFormattingProperty

Field Value

FieldPropertyDefinition

GeneralFormattingProperty

The general formatting.

Declaration

public static readonly FieldPropertyDefinition GeneralFormattingProperty

Field Value

FieldPropertyDefinition

NumericFormattingProperty

The numeric formatting.

Declaration

public static readonly FieldPropertyDefinition NumericFormattingProperty

Field Value

FieldPropertyDefinition

Properties

CodeBuilder

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

Declaration

protected FieldCodeBuilder CodeBuilder { get; }

Property Value

FieldCodeBuilder

DateTimeFormatting

Declaration

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

Property Value

System.String

FieldCode

Gets the code of the field.

Declaration

public string FieldCode { get; }

Property Value

System.String

GeneralFormatting

Declaration

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

Property Value

System.String

NumericFormatting

Declaration

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

Property Value

System.String

Methods

BuildCodeOverride()

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

Declaration

protected virtual void BuildCodeOverride()

CopyPropertiesFrom(Field)

Copies all properties from another field of the same type.

Declaration

public override void CopyPropertiesFrom(Field fromField)

Parameters

Field fromField 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.

Declaration

public void CopyPropertiesFrom(FieldCodeExpression fieldCodeExpression)

Parameters

FieldCodeExpression fieldCodeExpression The field code expression.

CopyPropertiesFromCodeExpression(FieldCodeExpression)

Copies the field-specific properties from a FieldCodeExpression.

Declaration

protected virtual void CopyPropertiesFromCodeExpression(FieldCodeExpression fieldCodeExpression)

Parameters

FieldCodeExpression fieldCodeExpression The field code expression.

GetCodeFragment()

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

Declaration

protected override DocumentFragment GetCodeFragment()

Returns

DocumentFragment The code fragment

Overrides

Field.GetCodeFragment()

GetNumberResultWithFormatting(Int32)

Declaration

protected string GetNumberResultWithFormatting(int number)

Parameters

System.Int32 number

Returns

System.String

InvalidateCode()

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

Declaration

protected void InvalidateCode()

IsCodeValid()

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

Declaration

protected override bool IsCodeValid()

Returns

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

Overrides

Field.IsCodeValid()

MakeHyperlinkFragment(DocumentFragment, HyperlinkInfo)

Declaration

protected DocumentFragment MakeHyperlinkFragment(DocumentFragment fragment, HyperlinkInfo hyperlinkInfo)

Parameters

DocumentFragment fragment

HyperlinkInfo hyperlinkInfo

Returns

DocumentFragment

Extension Methods

CollectionExtensions.ToEnumerable<T>(T)

EnumerableExtensions.ToEnumerable<T>(T)