Javascript: PageBorder.setSurroundHeader Method

Description

Sets the whether the page border surrounds the section's header.

Syntax

<void> PageBorder.setSurroundHeader(<boolean> surroundHeader, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
surroundHeader	Specifies whether the page border surrounds the section's header.
callback	Optional. Is called when the operation completed.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates PageBorder.setSurroundHeader in a practical document-editing workflow. It sets the whether the page border surrounds the section's header.

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

function configureSurroundHeader(pageBorder) {
    pageBorder.setSurroundHeader(
        true,
        function() {
            console.log("set surround header completed.");
        },
        onTxError
    );
}