Description

Informs whether the document can be formatted with page and section formatting attributes. The value depends on whether the formatting is allowed and the currently set edit mode.

Syntax

<void> TXTextControl.getCanDocumentFormat(<RequestBooleanCallback> callback, [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
callback	The callback function that receives the requested value.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates TXTextControl.getCanDocumentFormat in a practical document-editing workflow. Informs whether the document can be formatted with page and section formatting attributes. The value depends on whether the formatting is allowed and the currently set edit mode.

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

TXTextControl.getCanDocumentFormat(
    function(result) {
        if (result) {
            console.log("get can document format is available.");
        } else {
            console.warn("get can document format is not available in the current document state.");
        }
    },
    onTxError
);