DS Server

Javascript: InputFormat.getCentered Method

Method|Introduced in 28.0

Description

Gets a value specifying whether text is centered at the current input position.

Syntax

<void> InputFormat.getCentered(<RequestBooleanCallback> callback, [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
callback

Receives whether text is centered at the current input position as parameter.

errorCallback

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

Examples

The following example demonstrates InputFormat.getCentered in a practical document-editing workflow. It gets a value specifying whether text is centered at the current input position.

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

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