This document covers the following topics:
A generic (non-Natural) text object currently open in a program editor window.
The following properties are available:
Used to navigate to the parent interface of this interface.
| Natural Data Format | Variant Type | Remark |
|---|---|---|
| HANDLE OF OBJECT | VT_DISPATCH (INatAutoGenericTexts) | Get only |
Used to navigate to the root interface.
| Natural Data Format | Variant Type | Remark |
|---|---|---|
| HANDLE OF OBJECT | VT_DISPATCH (INatAutoStudio) | Get only |
The text contained in the text object.
| Natural Data Format | Variant Type | Remark |
|---|---|---|
| A | VT_BSTR |
Shows or hides the editor window.
| Natural Data Format | Variant Type | Remark |
|---|---|---|
| L | VT_BOOL |
The type of the text object. The type is defined as a text string by
the plug-in during the method Open.
| Natural Data Format | Variant Type | Remark |
|---|---|---|
| A | VT_BSTR | Get only |
The name of the text object. The name is defined as a text string by
the plug-in during the method Open.
| Natural Data Format | Variant Type | Remark |
|---|---|---|
| A | VT_BSTR | Get only |
The number of lines in the text object.
| Natural Data Format | Variant Type | Remark |
|---|---|---|
| I4 | VT_I4 | Get only |
The following methods are available:
Clears the editor contents.
| Name | Natural Data Format | Variant Type | Remark |
|---|---|---|---|
| Quiet | L | VT_BOOL | Optional |
If set to TRUE, the method is performed without user interaction. The default is FALSE.
Closes the editor and removes the object from the collection.
| Name | Natural Data Format | Variant Type | Remark |
|---|---|---|---|
| Quiet | L | VT_BOOL | Optional |
If set to TRUE, the method is performed without user interaction. The default is FALSE.
Renumbers the text object.
Searches for the first occurrence of a given string.
| Name | Natural Data Format | Variant Type | Remark |
|---|---|---|---|
| Return value | BOOL | VT_BOOL | |
| SearchString | A | VT_BSTR | |
| Line | I4 | VT_I4 | By reference |
| Column | I4 | VT_I4 | By reference |
| CaseSensitive | L | VT_BOOL | Optional |
| WholeWords | L | VT_BOOL | Optional |
| Up | L | VT_BOOL | Optional |
TRUE if a match was found.
The string to search for.
Contains the start line for the search on input. Contains the line of the first match on return.
Contains the start column for the search on input. Contains the column of the first match on return.
Searches case sensitively. The default is FALSE.
Searches only for whole words that match the search string. The default is FALSE.
Searches in upward direction. The default is FALSE.
Replaces the first occurrence of a given string with another one.
| Name | Natural Data Format | Variant Type | Remark |
|---|---|---|---|
| Return value | BOOL | VT_BOOL | |
| SearchString | A | VT_BSTR | |
| ReplaceString | A | VT_BSTR | |
| Line | I4 | VT_I4 | By reference |
| Column | I4 | VT_I4 | By reference |
| CaseSensitive | L | VT_BOOL | Optional |
| WholeWords | L | VT_BOOL | Optional |
| Up | L | VT_BOOL | Optional |
TRUE if a match was found.
The string to search for.
The string which replaces the search string.
Contains the start line for the search on input. Contains the line of the first match on return.
Contains the start column for the search on input. Contains the column of the first match on return.
Searches case sensitively. The default is FALSE.
Searches only for whole words that match the search string. The default is FALSE.
Searches in upward direction.
Deletes a block of lines from the text object.
| Name | Natural Data Format | Variant Type | Remark |
|---|---|---|---|
| StartLine | I4 | VT_I4 | |
| LineCount | I4 | VT_I4 | Optional |
The start line of the block to delete.
The number of lines to delete. The default is 1.
Retrieves a block of lines from the text object.
| Name | Natural Data Format | Variant Type | Remark |
|---|---|---|---|
| Return value | A | VT_BSTR | |
| StartLine | I4 | VT_I4 | |
| LineCount | I4 | VT_I4 | Optional |
A block of text lines. The lines are separated by carriage return / line feed characters.
The start line of the block to return.
The number of lines to return. The default is 1.
Inserts a block of lines into the text object.
| Name | Natural Data Format | Variant Type | Remark |
|---|---|---|---|
| Return value | I4 | VT_I4 | |
| Code | A | VT_BSTR | |
| InsertAfterLine | I4 | VT_I4 | Optional |
The line number passed in InsertAfterLine increased by the number of inserted lines.
A block of text lines to insert. The lines must be separated by carriage return / line feed characters.
Line after which the lines shall be inserted. The default is 0.
Replaces a block of lines from the text object.
| Name | Natural Data Format | Variant Type | Remark |
|---|---|---|---|
| Return value | I4 | VT_I4 | |
| Code | A | VT_BSTR | |
| ReplaceLine | I4 | VT_I4 | Optional |
| LineCount | I4 | VT_I4 | Optional |
The line number passed in ReplaceLine increased by the number of inserted lines.
A block of source code lines to replace the block that is defined by ReplaceLine and LineCount. The lines must be separated by carriage return / line feed characters.
The start line of the block to be replaced. The default is 1.
The number of lines to be replaced by the given block. The default is 1.
