Displays the panels for editing the header and footer in a RichTextEdit control or hides the panels and returns to editing the main text.

Applies to

DataWindow type

Method applies to


DataWindow control with RichTextEdit presentation style



integer rtename.ShowHeadFoot ( boolean editheadfoot {, headerfooter} )




A reference to the DataWindow control for which you want to edit header and footer information. The DataWindow must have a RichTextEdit presentation style.


A boolean value specifying the editing panel to display. Values are:

  • True -- Display the header and footer editing panels.

  • False -- Display the detail editing panel for the document body.

headerfooter (optional)

A boolean value specifying whether the insertion point (caret) for editing the header/footer panel is in the header or the footer section. Values are:

  • True

    Caret is in the header section.

  • False

    Caret is in the footer section.

Return value

Returns 1 if it succeeds and -1 if an error occurs.


ShowHeadFoot takes effect when the control is in preview mode or when it is in edit mode for the main text. If the control is in preview mode, calling ShowHeadFoot returns to edit mode. The value of editheadfoot determines whether the main text or the header and footer panels display.

The headerfooter argument is ignored if the editheadfoot argument is false. The headerfooter argument defaults to "true" if a value is not provided. The header and footer can include input fields for page numbers and dates.

PowerBuilder RichTextEdit control

You can use the same syntax with any RichTextEdit control. See the section called “ShowHeadFoot” in PowerScript Reference.

See also

Preview for RichTextEdit controls in the section called “Preview” in PowerScript Reference