TE Edit Control .NET Core / .NET Framework Help
Product page
Contents/Control Methods/List Numbering/

TerGetListLevelInfo

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

bool TerGetListLevelInfo( IsList, id, level, out StartAt, out NumType, out CharAft, out ListText, out FontId, out flags)
bool 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.
int StartAt;The location to retrieve the starting number for a level.
int NumType;The location to retrieve the number type used for the bullet. Please refer to the TerEditListLevel function for a list of number type constants.
int CharAft;The location to retrieve 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.
string ListText. The location to retrieve the text printed for the paragraph number. Please refer to the TerEditListLevel function for the description of this parameter.
int FontId; The location to retrieve the font id to print the paragraph number text.
int flags;The location to retrieve the list level flags. Please refer to the TerEditListLevel function for a description of the list level flags.

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