TerGetBulletInfo
Get the paragraph bullet/numbering information.
int TerGetBulletInfo( QueryType, id)
int TerGetBulletInfo2( QueryType, id)
int TerGetBulletInfo3( QueryType, id)
int QueryType; | This parameter can be set to one of the following values: |
| PID_LINE: | Get the bullet information for the given line. |
| PID_PARA: | Get the bullet information for the given paragraph id. |
| PID_BULLET: | Get the bullet information for the given bullet id. |
| PID_STYLE | Get the bullet information for the style id specified by the 'id' argument. |
int id; | The value for this parameter depends upon the value specified for the 'QueryType' parameter. When the 'QueryType' is set to PID_LINE, the 'id' parameter must contain a text line number. You can set the line number value to -1 to specify the current line. when the 'QueryType' is set to PID_PARA, then the 'id' parameter must contain a paragraph id. When the 'QueryType' is set to PID_BULLET, then the 'id' parameter must contain a valid bullet id. When the 'QueryType' is set to PID_STYLE, the 'id' parameter must contain a stylesheet style id. |
Upon a successful return from this method, the following information can be retrieved by using TerGetOutInt and related methods:
boolean IsBullet; | 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: IsBullet=tej.TerGetOutBool("IsBullet") |
int start; | The starting number when setting paragraph numbering is turned on. Upon a successful return from this method, the start value can be retrieve as following: start=tej.TerGetOutInt("ListStart") |
int level; | The level number when paragraph numbering is turned on. Upon a successful return from this method, the level number can be retrieve as following: level=tej.TerGetOutInt("ListLevel") |
int symbol; | For a bullet list, the symbol can be one of the following: |
| BLT_ROUND | Round |
| BLT_DIAMOND | Diamond |
| BLT_SQUARE | Square |
| BLT_HOLLOW_SQARE | Hollow square |
| BLT_4_DIAMOND | Four Diamonds |
| BLT_ARROW | Arrow |
| BLT_CHECK | Check |
For a numbered list, the symbol can be one of the following:
| NBR_DEC | Decimal numbering |
| NBR_UPR_ALPHA | Uppercase letters |
| NBR_LWR_ALPHA | Lowercase letters |
| NBR_UPR_ROMAN | Uppercase Roman numbers |
| NBR_LWR_ROMAN | Lowercase Roman numbers |
Upon a successful return from this method, the symbol value can be retrieve as following:
symbol=tej.TerGetOutInt("ListSymbol")int ListOrId; | The list override id if this bullet is created using the list table. A zero return value for this parameter indicates a regular bullet or a regular paragraph number. A non-zero value for this field indicates a bullet or number created using the list-mechanism. In this case, the values returned by the 'type' and 'ListText' are not applicable. Please use the TerGetListLevelInfo to retrieve the list information for this list. Upon a successful return from this method, the list override id can be retrieve as following: ListOrId=tej.TerGetOutInt("ListOrId") |
int flags; | reserved for future use. |
String ListText; | The list text. Please refer to the TerEditListLevel function for the description of the parameter. This parameter is valid only when ListOrId is returned as non-zero. Upon a successful return from this method, the list text can be retrieve as following: ListText=tej.TerGetOutInt("ListText") |
Return Value: This function returns the current bullet id. A value of 0 indicates that the bullet/numbering is not turned on for the paragraph. A value of -1 indicates an error condition.