Adds a text string to a BigText variable.
BigText.ADDTEXT(Variable[, Position]) |
Parameters
- BigText
- Type: BigTextThe BigText to which the text string will be added.
- Variable
- Type: BigText, Code, or TextThe string that will be added to the BigText variable. If this parameter is empty, then the BigText variable is not modified.
- Position
- Type: IntegerThis is an optional parameter that defines the position in the BigText variable where the string is inserted. If this parameter is omitted, then the string is added at the end of the BigText variable. If this parameter is less than one, then a run-time error occurs. If this parameter is greater than the length of the BigText variable, then the string is added at the end of the BigText variable.
Remarks
Variable can be inserted anywhere in BigText or added at the end of the BigText.
The first character in a BigText variable is position 1.
To delete the content in a BigText variable, use the
CLEAR Function. The following
code shows the syntax for the function:
CLEAR(BigText)
Example
The following examples show how to use the ADDTEXT function. The
specified text is inserted into the BigText string at the specified
position. In these examples, the initial content of the
BigText variable is ABCDEFG. These examples
require that you create the following variables.
| Variable name | DataType |
|---|---|
|
MyBigText |
BigText |
The following example inserts the string 'ZZZ' after the character B in the MyBigText variable because 3 is specified for Position.
 Copy Code |
|
|---|---|
// Example 1
MyBigText.ADDTEXT('ABCDEFG');
MyBigText.ADDTEXT('ZZZ', 3); // Returns the subtext ABZZZCDEFG.
|
|
Example
The following example appends the string 'ZZZ' at the end of the MyBigText variable because the number specified for Position is greater than the length of the MyBigText variable.
| Copy Code |
|
|---|---|
// Example 2
MyBigText.ADDTEXT('ABCDEFG');
MyBigText.ADDTEXT('ZZZ', 15); // Returns the subtext ABCDEFGZZZ.
|
|
Example
In the following example, the content of the MyBigText variable is unchanged because the specified variable is an empty string.
| Copy Code |
|
|---|---|
// Example 3
MyBigText.ADDTEXT('ABCDEFG');
MyBigText.ADDTEXT('', 1); // Returns the subtext ABCDEFG.
|
|
Example
In the following example, the function returns an error because 0 is specified for Position.
| Copy Code |
|
|---|---|
// Example 4
MyBigText.ADDTEXT('ABCDEFG');
MyBigText.ADDTEXT('ZZZ', 0); // Returns an error.
|
|