DS Server

Javascript: Page.getHeader Method

Method|Introduced in 28.0

Description

Gets the header of the page.

Syntax

<void> Page.getHeader(<RequestHeaderFooterCallback> callback, [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
callback

Receives the header of the page.

errorCallback

Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates Page.getHeader in a practical document-editing workflow. It gets the header of the page.

function onTxError(error) {
    console.error("TX Text Control error:", error.msg);
    error.handled = true;
}

function inspectHeader(page) {
    page.getHeader(
        function(headerFooter) {
            if (!headerFooter) {
                console.warn("No header footer was returned.");
                return;
            }
            
            console.log("get header result:", headerFooter);
        },
        onTxError
    );
}