TE Edit Control Java / HTML-JavaScript Help
Product page

TerGetListInfo

Retrieve information for a list id.

boolean TerGetListInfo( ListId)
boolean TerGetListInfo2( ListId)
int ListId;

The id of the list item. Set this parameter to -1 to retrieve the information about the list id for the current line.

The TerGetListOrInfo function can be used to retrieve the list id associated with a list override id.

Upon a successful return from this method, the following information can be retrieved by using TerGetOutInt and related methods:

String ListName;

The list name.

// This flag is true if the paragraph has bullets. It is false if the paragraph numbering is turned on.

Upon a successful return from this method, this value can be retrieve as following:

ListName=tej.TerGetOutStr("ListName")
int LevelCount;

The number of list levels supported by the list. A nested list supports 9 levels. A simple list supports one level.

// This flag is true if the paragraph has bullets. It is false if the paragraph numbering is turned on.

Upon a successful return from this method, this value can be retrieve as following:

LevelCount=tej.TerGetOutInt("ListLevelCount")
int flags;

The list flag (LISTFLAG_?). Please refer to the TerEditList for an available list of list flags.

// This flag is true if the paragraph has bullets. It is false if the paragraph numbering is turned on.

Upon a successful return from this method, this value can be retrieve as following:

flags=tej.TerGetOutInt("ListFlags")
int RtfId;

The unique RTF id for this list.

// This flag is true if the paragraph has bullets. It is false if the paragraph numbering is turned on.

Upon a successful return from this method, this value can be retrieve as following:

RtfId=tej.TerGetOutInt("ListRtfId")
int TmplId;

The template id for this list.

// This flag is true if the paragraph has bullets. It is false if the paragraph numbering is turned on.

Upon a successful return from this method, this value can be retrieve as following:

TmplId=tej.TerGetOutBool("TmplId")

Return Value: This function returns true when successful.