FileHandle :: AlignText - Align text
The function aligns text to be displayed in fixed font metrics, which is typically the case for ASCII texts as program comments or console output. The function arranges the text in a block for each paragraph using the passed size as line size. In order to indent text blocks, the number of indent characters may be passed in indent. The indent value will reduce the output line size passed in size.
The way of arranging the text in the output area is controlled by the align_type parameter
Return value: Success ( logical )
Implementation details
logical
FileHandle :: AlignText ( NString &cnstring, uint32 size, uint16 indent, TextAlignment align_type )
- cnstring - String containing the text
- size
- Size
Size of the instance or string area.
- indent
- Left indent for the text block
The indent value contains the number of empty characters at the beginning of each new line.
- align_type
- Alignment type for a text block
The alignment type defines whether the text is left or right aligned or arranged in a block.