Alignment

Detailed Description

Enumerations
enum	TextAlignment {   taNone,   taLeft,   taCenter,   taRight }
	Values that represent TextAlignment. See AlignText. More...

Functions
String	AlignLeft (PCChar8 text, Int32 resultLength, Char8 fillChar= ' ')
	Align characters on the left. More...
String	AlignCenter (PCChar8 text, Int32 resultLength, Char8 fillChar= ' ')
	Align characters on center. More...
String	AlignRight (PCChar8 text, Int32 resultLength, Char8 fillChar= ' ')
	Align characters on the right. More...
String	AlignText (PCChar8 text, Int32 ResultLength, TextAlignment textAlignment, Char8 FillChar= ' ')
	Align text. More...

Enumeration Type Documentation

enum TextAlignment

Values that represent TextAlignment. See AlignText.

Enumerator
taNone	None.
taLeft	Left.
taCenter	Center.
taRight	Right.

Function Documentation

String AlignCenter	(	PCChar8	text,
		Int32	resultLength,
		Char8	fillChar = ' '
	)

Align characters on center.

Parameters

text	The text to align.
resultLength	Length of the String.
fillChar	(optional) the fill character.

Returns

The aligned String.

Note

return a String which is limited to STRING_MAX_LENGTH.

String AlignLeft	(	PCChar8	text,
		Int32	resultLength,
		Char8	fillChar = ' '
	)

Align characters on the left.

Parameters

text	The text to align.
resultLength	Length of the String.
fillChar	(optional) the fill character.

Returns

The aligned String.

Note

return a String which is limited to STRING_MAX_LENGTH.

String AlignRight	(	PCChar8	text,
		Int32	resultLength,
		Char8	fillChar = ' '
	)

Align characters on the right.

Parameters

text	The text to align.
resultLength	Length of the result.
fillChar	(optional) the fill character.

Returns

The aligned String.

Note

return a String which is limited to STRING_MAX_LENGTH.

String AlignText	(	PCChar8	text,
		Int32	ResultLength,
		TextAlignment	textAlignment,
		Char8	FillChar = ' '
	)

Align text.

Parameters

text	The text to align.
ResultLength	Length of the result.
textAlignment	The text alignment mode. See TextAlignment.
FillChar	(optional) the fill character.

Returns

The aligned String.

Note

return a String which is limited to STRING_MAX_LENGTH.

RT Exceptions:

RT_ERROR_OUT_OF_ENUM_RANGE