Class CharacterFormat

Represents character (text) format.

Inheritance
System.Object
EntityBase
XDLSSerializableBase
FormatBase
CharacterFormat
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Syncfusion.DLS
Assembly: Syncfusion.DLS.Base.dll
Syntax
public class CharacterFormat : FormatBase, IEntityBase, IXDLSSerializable

Constructors

CharacterFormat()

Default constructor

Declaration
public CharacterFormat()

CharacterFormat(IDocument)

Default constructor

Declaration
public CharacterFormat(IDocument doc)
Parameters
Type Name Description
IDocument doc

Fields

BoldKey

Declaration
public const int BoldKey = 4
Field Value
Type
System.Int32

DEF_FONTFAMILY

Declaration
protected const string DEF_FONTFAMILY = "Times New Roman"
Field Value
Type
System.String

DEF_FONTSIZE

Declaration
protected const float DEF_FONTSIZE = 10F
Field Value
Type
System.Single

DoubleStrikeKey

Declaration
public const int DoubleStrikeKey = 14
Field Value
Type
System.Int32

FontKey

Declaration
public const int FontKey = 0
Field Value
Type
System.Int32

FontNameKey

Declaration
public const int FontNameKey = 2
Field Value
Type
System.Int32

FontSizeKey

Declaration
public const int FontSizeKey = 3
Field Value
Type
System.Int32

ItalicKey

Declaration
public const int ItalicKey = 5
Field Value
Type
System.Int32

LineBreakKey

Declaration
public const int LineBreakKey = 20
Field Value
Type
System.Int32

PositionKey

Declaration
public const int PositionKey = 17
Field Value
Type
System.Int32

SpacingKey

Declaration
public const int SpacingKey = 18
Field Value
Type
System.Int32

StrikeKey

Declaration
public const int StrikeKey = 6
Field Value
Type
System.Int32

SubSuperScriptKey

Declaration
public const int SubSuperScriptKey = 10
Field Value
Type
System.Int32

TextBkgColorKey

Declaration
public const int TextBkgColorKey = 9
Field Value
Type
System.Int32

TextColorKey

Declaration
public const int TextColorKey = 1
Field Value
Type
System.Int32

UnderlineKey

Declaration
public const int UnderlineKey = 7
Field Value
Type
System.Int32

Properties

Bold

Gets / sets bold style

Declaration
public bool Bold { get; set; }
Property Value
Type
System.Boolean

CharacterSpacing

Gets / sets space width between characters.

Declaration
public float CharacterSpacing { get; set; }
Property Value
Type
System.Single
Remarks

Not supported by Essential PDF

DoubleStrike

Gets / sets doublestrikeout style

Declaration
public bool DoubleStrike { get; set; }
Property Value
Type
System.Boolean
Remarks

Not supported by Essential PDF

Font

Gets / sets font as System.Drawing.Font

Declaration
public Font Font { get; set; }
Property Value
Type
System.Drawing.Font

FontName

Gets / sets font name

Declaration
public string FontName { get; set; }
Property Value
Type
System.String

FontSize

Gets / sets font size

Declaration
public float FontSize { get; set; }
Property Value
Type
System.Single

Italic

Gets / sets italic style

Declaration
public bool Italic { get; set; }
Property Value
Type
System.Boolean

LineBreak

Gets / sets line break after.

Declaration
public bool LineBreak { get; set; }
Property Value
Type
System.Boolean

Position

Gets / sets text vertical position.

Declaration
public float Position { get; set; }
Property Value
Type
System.Single
Remarks

Not supported by Essential PDF

Strikeout

Gets / sets strikeout style

Declaration
public bool Strikeout { get; set; }
Property Value
Type
System.Boolean

SubSuperScript

Gets / sets subscript/superscript mode

Declaration
public SubSuperScript SubSuperScript { get; set; }
Property Value
Type
SubSuperScript
Remarks

Not supported by Essential PDF

TextBackgroundColor

Gets / sets text background color

Declaration
public Color TextBackgroundColor { get; set; }
Property Value
Type
System.Drawing.Color
Remarks

Not supported by Essential PDF

TextColor

Gets / sets text color

Declaration
public Color TextColor { get; set; }
Property Value
Type
System.Drawing.Color

UnderlineStyle

Gets / sets underline style

Declaration
public UnderlineStyle UnderlineStyle { get; set; }
Property Value
Type
UnderlineStyle
Remarks

Essential PDF only supports single underline.

Methods

GetDefValue(Int32)

Declaration
protected override object GetDefValue(int key)
Parameters
Type Name Description
System.Int32 key
Returns
Type
System.Object
Overrides

InitXDLSHolder()

Declaration
protected override void InitXDLSHolder()
Overrides

OnUpdateFontName(String)

Called when updates font name.

Declaration
protected virtual void OnUpdateFontName(string fontName)
Parameters
Type Name Description
System.String fontName

Name of the font.

ReadXmlAttributes(IXDLSAttributeReader)

Declaration
protected override void ReadXmlAttributes(IXDLSAttributeReader reader)
Parameters
Type Name Description
IXDLSAttributeReader reader
Overrides

WriteXmlAttributes(IXDLSAttributeWriter)

Declaration
protected override void WriteXmlAttributes(IXDLSAttributeWriter writer)
Parameters
Type Name Description
IXDLSAttributeWriter writer
Overrides

Implements