TE Edit Control Java / HTML-JavaScript Help
Product page
Contents/Control Methods/List Numbering/

TerGetListLevelInfo

Retrieve the level properties for a list or a list-override item.

boolean TerGetListLevelInfo( IsList, id, level)
boolean IsList;Set to true to retrieve the level properties for a list item. Set to false to retrieve the level properties for a list-override item. A list-override item is allowed only if it has non-zero list levels (please refer to the TerGetListOrInfo function).
int id;The id of the list or list-override item to retrieve. You can set this parameter to -1 to retrieve the information about the list level for the current line.
int level;A valid level number. A simple list has only one level (level number 0). A nested list has 9 levels (0 to 8). This parameter is ignored when the 'id' parameter is set to -1.

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

int StartAt;

The starting number for a level.

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

StartAt=tej.TerGetOutInt("ListStart")
int NumType;

The lnumber type used for the bullet. Please refer to the TerEditListLevel function for a list of number type constants.

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

NumType=tej.TerGetOutInt("ListNumType")
int CharAft;

The character between the bullet text and the body text. Please refer to the TerEditListLevel function for a list of values returned by this parameter.

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

CharAft=tej.TerGetOutInt("ListCharAft")
String ListText.

The text printed for the paragraph number. Please refer to the TerEditListLevel function for the description of this parameter.

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

ListText=tej.TerGetOutStr("ListText")
int FontId;

The font id to print the paragraph number text.

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

FontId=tej.TerGetOutInt("ListFontId")
int flags;

The list level flags. Please refer to the TerEditListLevel function for a description of the list level flags.

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

flags=tej.TerGetOutInt("ListFlags")

Return Value: When successful, this function returns a true value.