TerPosHdrFtr
Position the cursor at the header or footer text.
bool TerPosHdrFtr ( section, header, pos, repaint)
bool TerPosHdrFtrEx(section,HdrFtr,pos,repaint)
int section; | section number for the header. Specify a number between 0 (first section) and total section -1. |
This function uses sequential section numbers within the document. Please note that the sequential section numbers can be different from the actual section id for the section. You can use the TerGetSeqSect function to translate a section id into the sequential section number.
int header; | true to position at the header text or false to position at the footer text (used by the TerPosHdrFtr function only). |
char HdrFtr; | Use one of the following constants to specify the type of the header/footer area to position at (used by the TerPosHdrFtrEx function only): |
| HDR_CHAR: | Regular header |
| FTR_CHAR: | Regular footer |
| FHDR_CHAR: | First page header |
| FFTR_CHAR: | First Page footer |
| RHDR_CHAR: | Right (odd) page header |
| RFTR_CHAR: | Right (odd) page footer |
| LHDR_CHAR: | Left (even) page header |
| LFTR_CHAR: | Left (even) page footer |
int pos; | Set to POS_BEG to position before the first character of the existing header or footer text. Set to POS_END to position at the end of the existing header or footer text. |
bool repaint; | true to refresh the screen after this operation. |
Description: This function is available in the Page Mode only. The function toggles the header/footer edit mode before positioning the cursor.
Please note that this function automatically turns on the editing of header/footers, if not already enabled.
Return Value: This function returns a true value when successful.