Contents/Control Methods/List Numbering/

TerGetListOrInfo

Retrieve information for a list override id.

boolean TerGetListOrInfo( ListOrId, out ListId, out LevelCount, out flags)

int ListOrId;

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

The TerGetBulletInfo2 function can be used to retrieve the list override id associated with the current line or a paragraph id.

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

int ListId;

The list id for this list override id.

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

ListId=tej.TerGetOutInt("ListId")

int LevelCount;

The number of list levels supported by the list override id. A non-zero value indicates that this list override id actually overrides the level information for the underlying list id.

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

LevelCount=tej.TerGetOutInt("ListLevelCount")

int flags;

The list override flags. This parameter is not used currently and always returns a zero value.

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

flags=tej.TerGetOutInt("ListFlags")

Return Value: This function returns true when successful.