Description

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

Syntax

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

Parameters

Parameter	Description
callback	Receives whether the text is top aligned as parameter.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

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

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

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