Class SymbolField

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

Inheritance
System.Object
Field
CodeBasedField
SymbolField
Inherited Members
Namespace: Telerik.Windows.Documents.Model
Assembly: Telerik.Windows.Documents.dll

Syntax

public class SymbolField : CodeBasedField, ISupportInitialize

Constructors

SymbolField()

Initializes a new instance of the SymbolField class.

Declaration
public SymbolField()

Fields

CharCodeProperty

The property containing the value of the char code.

Declaration
public static readonly FieldPropertyDefinition CharCodeProperty
Field Value
FieldPropertyDefinition

FieldType

The symbol field type name.

Declaration
public static readonly string FieldType
Field Value
System.String

FontNameProperty

The property containing the value of the font name.

Declaration
public static readonly FieldPropertyDefinition FontNameProperty
Field Value
FieldPropertyDefinition

FontSizeProperty

The property containing the value of the font size.

Declaration
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
[XamlSerializable]
public string CharCode { get; set; }
Property Value
System.String

FieldTypeName

The name of the field type.

Declaration
public override string FieldTypeName { get; }
Property Value
System.String

Overrides

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
[XamlSerializable]
public string FontName { get; set; }
Property Value
System.String

FontSize

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

Declaration
[XamlSerializable]
public string FontSize { get; set; }
Property Value
System.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
[XamlSerializable]
public bool IsAnsi { get; set; }
Property Value
System.Boolean

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
[XamlSerializable]
public bool IsUnicode { get; set; }
Property Value
System.Boolean

Methods

BuildCodeOverride()

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

Declaration
protected override void BuildCodeOverride()
Overrides

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

CopyPropertiesFromCodeExpression(FieldCodeExpression)

Copies the field-specific properties from a FieldCodeExpression.

Declaration
protected override void CopyPropertiesFromCodeExpression(FieldCodeExpression fieldCodeExpression)
Parameters
FieldCodeExpression fieldCodeExpression

The field code expression.
Overrides

CreateInstance()

Creates a new instance of the current field class.

Declaration
public override Field CreateInstance()
Returns
Field

The new field instance.
Overrides

GetResultFragment()

Builds the result fragment of the field.

Declaration
protected override DocumentFragment GetResultFragment()
Returns
DocumentFragment

The result fragment.
Overrides

Extension Methods