DS Server

Javascript: HeaderFooter.getType Method

Method|Introduced in 28.0

Description

Gets the type of the header or footer.

Syntax

<void> HeaderFooter.getType(<RequestHeaderFooterTypeCallback> callback, [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
callback

Receives the type of the header of footer.

errorCallback

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

Examples

The following example demonstrates HeaderFooter.getType in a practical document-editing workflow. It gets the type of the header or footer.

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

function inspectType(headerFooter) {
    headerFooter.getType(
        function(headerFooterType) {
            if (!headerFooterType) {
                console.warn("No header footer type was returned.");
                return;
            }
            
            console.log("get type result:", headerFooterType);
        },
        onTxError
    );
}