TerGetParam
Retrieve miscellaneous operating variables.
boolean TerGetParam( type)
int type; | The parameter type to retrieve: |
| TP_CUR_LINE | Current line number |
| TP_CUR_COL | Current column number |
| TP_CUR_SECT | Current section id |
| TP_MOUSE_X | Return the pixel x position where the mouse is positioned. This value is relevant only when retrieved from the PreProcess or Action events for a mouse message. |
| TP_MOUSE_Y | Return the pixel y position where the mouse is positioned. This value is relevant only when retrieved from the PreProcess or Action events for a mouse message. |
| TP_MOUSE_LINE | Return the text line number where the mouse is positioned. This value is relevant only when retrieved from the PreProcess or Action events for a mouse message. |
| TP_MOUSE_COL | Return the text column number where the mouse is positioned. This value is relevant only when retrieved from the PreProcess or Action events for a mouse message. |
| TP_MOUSE_FONT_ID | Return the font-id for the character where the mouse is positioned. This value is relevant only when retrieved from the PreProcess or Action events for a mouse message. |
| TP_MOUSE_PICT_ID | Return the picture-id for the picture where the mouse is located. This value would be 0 if if the mouse is not positioned over a picture object. This value is relevant only when retrieved from the PreProcess or Action events for a mouse message. |
| TP_MOUSE_FIELD_ID | Return the field-id for the field where the mouse is positioned. This value would be 0 if the mouse is not positioned over a picture. This value is relevant only when retrieved from the PreProcess or Action events for a mouse message. |
| TP_MOUSE_ON_TEXT_LINE | Returns TRUE if the mouse is located on a text line. This value is meaningful only when retrieved after calling the TerPixToTextPos method. |
| TP_PAGE_BK_COLOR | Page background color |
| TP_SELECTION_TYPE | Selection type: Set to HILIGHT_OFF if no text is selected. Any other value indicates that a text block is selected. The following four TP_SELECTION_ constants are not valid if the selection type is HILIGHT_OFF. |
| TP_SELECTION_START_LINE | Selection start line. |
| TP_SELECTION_START_COL | Selection start column. |
| TP_SELECTION_END_LINE | Selection end line. |
| TP_SELECTION_END_COL | Selection end column. |
| TP_TOTAL_BLTS | Total number of bullet ids in the document. |
| TP_TOTAL_CELLS | Total number of cell ids in the document. |
| TP_TOTAL_CHAR_TAGS | Total number of character tags in the document |
| TP_TOTAL_FONTS | Total number of font ids in the document. |
| TP_TOTAL_IMAGE_MAPS | Total number of image maps in the document. |
| TP_TOTAL_LINES | Total number of lines in the document. |
| TP_TOTAL_LISTS | Total number of list ids in the document. |
| TP_TOTAL_LIST_OR | Total number of list-override ids in the document. |
| TP_TOTAL_PAGES | Total number pages in the document. |
| TP_TOTAL_PARA_FRAMES | Total number of paragraph frames in the document |
| TP_TOTAL_PFMTS | Total number of paragraph ids in the document. |
| TP_TOTAL_SECTS | Total number of section ids in the document. |
| TP_TOTAL_STYLES | Total number of style ids in the document. |
| TP_TOTAL_TABS | Total number of tab ids in the document. |
| TP_TOTAL_TABLE_ROWS | Total number of table row ids in the document. |
| TP_WATERMARK_WASH | The return value is 1 if watermark picture is washed, otherwise the return value is 0. |
| TP_WATERMARK_PICT | Returns the picture id for the current watermark picture. Returns 0 if watermark is not set for the document |
| TP_TOTAL_REVIEWERS | Total number of reviewer ids. Id# 0 is not used. |
.
Return Value: This function returns the value of the requested parameter. It returns -1 to indicate an error condition.