 |
This method is obsolete. See the Remarks section below. |
Description
The Utilities.WrapText method scans the given string (Line) for occurrences of any of the characters specified by the nBreakChars parameter and inserts a line break, specified by BreakStr, at the last occurrence of the character in nBreakChars before MaxCol (the maximum line length).
Declaration
Utilities.WrapText(Line, BreakStr, nBreakChars, MaxCol)
| Line | [in] | Required | String | |
| BreakStr | [in] | Required | String | |
| nBreakChars | [in] | Required | Byte | |
| MaxCol | [in] | Required | Integer | |
| Result | String | |||
Applies To
The method is applied to the following object:
Parameters
The method has the following parameters:
Line
Specifies the string to be split.
BreakStr
Specifies the symbol used as a line break. BreakStr typically includes the carriage return character.
nBreakChars
Normally, nBreakChars is set to hold space, hyphen, tab and other similar characters on which to break the line.
MaxCol
Specifies the maximum length of the string. If the string’s length reaches the value of this parameter, this string is split into several lines.
Result Value
WrapText returns the string split into multiple lines.
Remarks
This method is obsolete. It is supported for backward compatibility only. To process strings, use the methods of the aqString object.