Description

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

Syntax

<void> PageBorder.getSurroundHeader(<RequestBooleanCallback> callback, [<ErrorCallback> errorCallback])

Parameters

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

Examples

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

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

function inspectSurroundHeader(pageBorder) {
    pageBorder.getSurroundHeader(
        function(result) {
            if (result) {
                console.log("get surround header is available.");
            } else {
                console.warn("get surround header is not available in the current document state.");
            }
        },
        onTxError
    );
}