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

SymbolField

Class

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

Definition

Namespace:Telerik.WinForms.Documents.Model

Assembly:Telerik.WinControls.RichTextEditor.dll

Syntax:

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.

public SymbolField()

Fields

CharCodeProperty

FieldPropertyDefinition

The property containing the value of the char code.

public static readonly FieldPropertyDefinition CharCodeProperty

FieldType

string

The symbol field type name.

public static readonly string FieldType

FontNameProperty

FieldPropertyDefinition

The property containing the value of the font name.

public static readonly FieldPropertyDefinition FontNameProperty

FontSizeProperty

FieldPropertyDefinition

The property containing the value of the font size.

public static readonly FieldPropertyDefinition FontSizeProperty

Properties

CharCode

string

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".

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

FieldTypeName

string

The name of the field type.

public override string FieldTypeName { get; }

Overrides: Field.FieldTypeName

FontName

string

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.

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

IsAnsi

bool

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

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

IsUnicode

bool

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

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

Methods

BuildCodeOverride()

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

protected override void BuildCodeOverride()

Overrides: CodeBasedField.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: CodeBasedField.CopyPropertiesFrom(Field)

CopyPropertiesFromCodeExpression(FieldCodeExpression)

Copies the field-specific properties from a FieldCodeExpression.

protected override void CopyPropertiesFromCodeExpression(FieldCodeExpression fieldCodeExpression)

Parameters:fieldCodeExpressionFieldCodeExpression

The field code expression.

Overrides: CodeBasedField.CopyPropertiesFromCodeExpression(FieldCodeExpression)

CreateInstance()

Creates a new instance of the current field class.

public override Field CreateInstance()

Returns:

Field

The new field instance.

Overrides: Field.CreateInstance()

GetResultFragment()

Builds the result fragment of the field.

protected override DocumentFragment GetResultFragment()

Returns:

DocumentFragment

The result fragment.

Overrides: Field.GetResultFragment()