This document covers the following topics:

• Purpose

• Properties

• Methods

---

Purpose

A generic (non-Natural) text object currently open in a program editor window.

Properties

The following properties are available:

• Parent

• Studio

• Source

• Visible

• Type

• Name

• LineCount

Parent

Used to navigate to the parent interface of this interface.

Natural Data Format	Variant Type	Remark
HANDLE OF OBJECT	VT_DISPATCH (INatAutoGenericTexts)	Get only

Studio

Used to navigate to the root interface.

Natural Data Format	Variant Type	Remark
HANDLE OF OBJECT	VT_DISPATCH (INatAutoStudio)	Get only

Source

The text contained in the text object.

Natural Data Format	Variant Type	Remark
A	VT_BSTR

Visible

Shows or hides the editor window.

Natural Data Format	Variant Type	Remark
L	VT_BOOL

Type

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

Name

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

LineCount

The number of lines in the text object.

Natural Data Format	Variant Type	Remark
I4	VT_I4	Get only

Methods

The following methods are available:

• Clear

• Close

• Renumber

• Search

• Replace

• DeleteLines

• GetLines

• InsertLines

• ReplaceLines

Clear

Clears the editor contents.

Parameters

Name	Natural Data Format	Variant Type	Remark
Quiet	L	VT_BOOL	Optional

Quiet

If set to TRUE, the method is performed without user interaction. The default is FALSE.

Close

Closes the editor and removes the object from the collection.

Parameters

Name	Natural Data Format	Variant Type	Remark
Quiet	L	VT_BOOL	Optional

Quiet

If set to TRUE, the method is performed without user interaction. The default is FALSE.

Renumber

Renumbers the text object.

Search

Searches for the first occurrence of a given string.

Parameters

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

Return value

TRUE if a match was found.

SearchString

The string to search for.

Line

Contains the start line for the search on input. Contains the line of the first match on return.

Column

Contains the start column for the search on input. Contains the column of the first match on return.

CaseSensitive

Searches case sensitively. The default is FALSE.

WholeWords

Searches only for whole words that match the search string. The default is FALSE.

Up

Searches in upward direction. The default is FALSE.

Replace

Replaces the first occurrence of a given string with another one.

Parameters

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

Return value

TRUE if a match was found.

SearchString

The string to search for.

ReplaceString

The string which replaces the search string.

Line

Contains the start line for the search on input. Contains the line of the first match on return.

Column

Contains the start column for the search on input. Contains the column of the first match on return.

CaseSensitive

Searches case sensitively. The default is FALSE.

WholeWords

Searches only for whole words that match the search string. The default is FALSE.

Up

Searches in upward direction.

DeleteLines

Deletes a block of lines from the text object.

Parameters

Name	Natural Data Format	Variant Type	Remark
StartLine	I4	VT_I4
LineCount	I4	VT_I4	Optional

StartLine

The start line of the block to delete.

LineCount

The number of lines to delete. The default is 1.

GetLines

Retrieves a block of lines from the text object.

Parameters

Name	Natural Data Format	Variant Type	Remark
Return value	A	VT_BSTR
StartLine	I4	VT_I4
LineCount	I4	VT_I4	Optional

Return value

A block of text lines. The lines are separated by carriage return / line feed characters.

StartLine

The start line of the block to return.

LineCount

The number of lines to return. The default is 1.

InsertLines

Inserts a block of lines into the text object.

Parameters

Name	Natural Data Format	Variant Type	Remark
Return value	I4	VT_I4
Code	A	VT_BSTR
InsertAfterLine	I4	VT_I4	Optional

Return value

The line number passed in InsertAfterLine increased by the number of inserted lines.

Code

A block of text lines to insert. The lines must be separated by carriage return / line feed characters.

InsertAfterLine

Line after which the lines shall be inserted. The default is 0.

ReplaceLines

Replaces a block of lines from the text object.

Parameters

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

Return value

The line number passed in ReplaceLine increased by the number of inserted lines.

Code

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.

ReplaceLine

The start line of the block to be replaced. The default is 1.

LineCount

The number of lines to be replaced by the given block. The default is 1.