TE Edit Control Java / HTML-JavaScript Help
Product page

TerSetTag

Set a tag at the specified text position:

int TerSetTag( line, col, name, AuxText, flags)
int TerSetTag( line, col, name, AuxText, obj, flags)
int line;The line position of the text. Set to -1 to use the current cursor position.
int col;The column position of the text. This parameter is ignored if the 'line' parameter is set to -1.
String name;The tag name string. A tag name does not need to be unique within the document.
String AuxText;Any auxiliary text String associated with the tag.
int AuxInt;Any auxiliary numeric data associated with the tag
object obj;Any external object associated with the tag.
int flags;Reserved for future use. Must be set to 0.

Description: Use this function to set a tag at the specified character position. If a tag already exists at the current text position, then the existing tag is updated with the new information.

The 'obj' parameter is not serialized to the rtf file.

Return Value: This function returns the unique tag id if successful. Otherwise it returns 0.