Class
SymbolField

Represents a field which inserts a character with certain font and size.

Definition

Namespace:Telerik.Windows.Documents.Model

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

cs-api-definition

public class SymbolField : CodeBasedField, ISupportInitialize

Inheritance: objectFieldCodeBasedFieldSymbolField

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.Update()Field.CreateFragmentFromText(string)Field.GetDisplayNameFragment()Field.CreateDeepCopy()Field.SetPropertyValue(FieldPropertyDefinition, string)Field.SetPropertyValue(FieldPropertyDefinition, Field)Field.IsResultFragmentEmpty()Field.HasDisplayNameFragmentField.FieldStartField.DisplayModeField.EvaluationContextField.Document

Constructors

SymbolField()

Initializes a new instance of the SymbolField class.

Declaration

cs-api-definition

public SymbolField()

Fields

CharCodeProperty

The property containing the value of the char code.

Declaration

cs-api-definition

public static readonly FieldPropertyDefinition CharCodeProperty

Field Value

FieldPropertyDefinition

FieldType

The symbol field type name.

Declaration

cs-api-definition

public static readonly string FieldType

Field Value

string

FontNameProperty

The property containing the value of the font name.

Declaration

cs-api-definition

public static readonly FieldPropertyDefinition FontNameProperty

Field Value

FieldPropertyDefinition

FontSizeProperty

The property containing the value of the font size.

Declaration

cs-api-definition

public static readonly FieldPropertyDefinition FontSizeProperty

Field Value

FieldPropertyDefinition

Properties

CharCode

Gets or sets the code point value of the char which will be formatted by the formatting switches.

The value can be specified in decimal or hexadecimal. When it is hexadecimal, it must have a leading "0X" or "0x".

Declaration

cs-api-definition

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

Property Value

string

FieldTypeName

The name of the field type.

Declaration

cs-api-definition

public override string FieldTypeName { get; }

Property Value

string

Overrides Field.FieldTypeName

FontName

Gets or sets the name of the font which will be applied on the character whose code is specified in the CharCode property. By default, the font used is that of the current span.

Declaration

cs-api-definition

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

Property Value

string

IsAnsi

Gets or sets the value which indicates whether the value of the CharCode property will be interpreted as the value of an ANSI character.

Declaration

cs-api-definition

[XamlSerializable]
public bool IsAnsi { get; set; }

Property Value

bool

IsUnicode

Gets or sets the value which indicates whether the value of the CharCode property will be interpreted as the value of a Unicode character.

Declaration

cs-api-definition

[XamlSerializable]
public bool IsUnicode { get; set; }

Property Value

bool

Methods

BuildCodeOverride()

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

Declaration

cs-api-definition

protected override void BuildCodeOverride()

Overrides CodeBasedField.BuildCodeOverride()

CopyPropertiesFrom(Field)

Copies all properties from another field of the same type.

Declaration

cs-api-definition

public override void CopyPropertiesFrom(Field fromField)

Parameters

fromField

Field

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.

Declaration

cs-api-definition

protected override void CopyPropertiesFromCodeExpression(FieldCodeExpression fieldCodeExpression)

Parameters

fieldCodeExpression

FieldCodeExpression

The field code expression.

Overrides CodeBasedField.CopyPropertiesFromCodeExpression(FieldCodeExpression)

CreateInstance()

Creates a new instance of the current field class.

Declaration

cs-api-definition

public override Field CreateInstance()

Returns

Field

The new field instance.

Overrides Field.CreateInstance()

GetResultFragment()

Builds the result fragment of the field.

Declaration

cs-api-definition

protected override DocumentFragment GetResultFragment()

Returns

DocumentFragment

The result fragment.

Overrides Field.GetResultFragment()

ClassSymbolField

Class
SymbolField