TCharacterProperties Class Reference

A class which stores character properties. More...

Inheritance diagram for TCharacterProperties:

Public Member Functions
TCharacterProperties	Clone ()
	Creates a clone of the current TCharacterProperties instance.
	CopyFrom (const TCharacterProperties CP)
	Copies all properties from another TCharacterProperties instance.
Boolean	IsBold ()
	Checks if the font style includes bold.
Boolean	IsItalic ()
	Checks if the font style includes italic.
Boolean	IsStrike ()
	Checks if the font style includes strikethrough.
Boolean	IsUnderline ()
	Checks if the font style includes underline.
	SetUnderline (const Boolean Value)
	Sets or removes the underline style.

Public Attributes
TDirection	Direction
	Specifies the text direction (left-to-right or right-to-left).
string	FontBGColor
	Specifies the background color in hexadecimal format.
TCharset	FontCharSet
	Specifies the font character set.
string	FontColor
	Specifies the font color in hexadecimal format.
string	FontHLColor
	Specifies the highlight color in hexadecimal format.
string	FontName
	Specifies the font name.
Integer	FontSize
	Specifies the font size in points.
TFontstyles	FontStyle
	Specifies the font style as a set of TFontStyle values.
string	Language
	Specifies the language of the text.
SxTypes	VerticalAlignment
	Specifies the vertical alignment of the text.

Detailed Description

A class which stores character properties.

Member Function Documentation

Clone()

TCharacterProperties TCharacterProperties::Clone

(

)

Creates a clone of the current TCharacterProperties instance.

Returns

A new instance of TCharacterProperties with the same properties.

CopyFrom()

TCharacterProperties::CopyFrom

(

const TCharacterProperties

CP

)

Copies all properties from another TCharacterProperties instance.

Parameters

CP	The source TCharacterProperties instance to copy from.

IsBold()

Boolean TCharacterProperties::IsBold

(

)

Checks if the font style includes bold.

Returns

True if the font style is bold, otherwise False.

IsItalic()

Boolean TCharacterProperties::IsItalic

(

)

Checks if the font style includes italic.

Returns

True if the font style is italic, otherwise False.

IsStrike()

Boolean TCharacterProperties::IsStrike

(

)

Checks if the font style includes strikethrough.

Returns

True if the font style is strikethrough, otherwise False.

IsUnderline()

Boolean TCharacterProperties::IsUnderline

(

)

Checks if the font style includes underline.

Returns

True if the font style is underlined, otherwise False.

SetUnderline()

TCharacterProperties::SetUnderline

(

const Boolean

Value

)

Sets or removes the underline style.

Parameters

Value

True to add underline, False to remove it.

Member Data Documentation

Direction

TDirection TCharacterProperties::Direction

Specifies the text direction (left-to-right or right-to-left).

See also

TDirection

FDirection For reading

SetDirection For writing

FontBGColor

string TCharacterProperties::FontBGColor

Specifies the background color in hexadecimal format.

See also

FFontBGColor For reading

SetFontBGColor For writing

FontCharSet

TCharset TCharacterProperties::FontCharSet

Specifies the font character set.

See also

FFontCharSet For reading

SetFontCharSet For writing

FontColor

string TCharacterProperties::FontColor

Specifies the font color in hexadecimal format.

See also

FFontColor For reading

SetFontColor For writing

FontHLColor

string TCharacterProperties::FontHLColor

Specifies the highlight color in hexadecimal format.

See also

FFontHLColor For reading

SetFontHLColor For writing

FontName

string TCharacterProperties::FontName

Specifies the font name.

See also

FFontName For reading

SetFontName For writing

FontSize

Integer TCharacterProperties::FontSize

Specifies the font size in points.

See also

FFontSize For reading

SetFontSize For writing

FontStyle

TFontstyles TCharacterProperties::FontStyle

Specifies the font style as a set of TFontStyle values.

See also

TFontstyles

FFontStyle For reading

SetFontStyle For writing

Language

string TCharacterProperties::Language

Specifies the language of the text.

See also

FLanguage For reading

FLanguage For writing

VerticalAlignment

SxTypes TCharacterProperties::VerticalAlignment

Specifies the vertical alignment of the text.

See also

TVerticalAlignment

FVerticalAlignment For reading

SetVerticalAlignment For writing