TE Edit Control .NET Core / .NET Framework Help
Product page
Contents/Control Methods/Footnote, Endnote, Bookmark, Tag/

TerGetTag

Retrieve the tag at the specified text position:

int TerGetTag ( line, col, out name, out AuxText, out AuxInt, out flags)
int TerGetTagEx ( line, col, type, out name, out AuxText, out AuxInt, out flags)
int TerGetTagEx ( line, col, type, out name, out AuxText, out AuxInt, out obj, out 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.
int type; Tag type (used by TerGetTagEx function only):
TERTAG_BKM:Bookmark tags
TERTAG_USER:Generic tags
string name;The location to retrieve the tag name.
string AuxText;The location to retrieve any auxiliary text string associated with the tag.
int AuxInt;The location to retrieve any auxiliary numeric data associated with the tag.
object obj;The location to retrieve any external object associated with the tag.
int flags;The location to retrieve tag flags (reserved for future use).

Return Value: This function returns the unique tag id at the specified location. It returns 0 if no tag is found at the location, or if an error is encountered.