DS Server

Javascript: TextField.getBounds Method

Method|Introduced in 28.0

Description

Gets the bounding rectangle of a text field.

Syntax

<void> TextField.getBounds(<RequestRectangleCallback> callback, [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
callback

Receives the bounding rectangle.

errorCallback

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

Examples

The following example demonstrates TextField.getBounds in a practical document-editing workflow. It gets the bounding rectangle of a text field.

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

function inspectBounds(textField) {
    textField.getBounds(
        function(rect) {
            if (!rect) {
                console.warn("No rectangle was returned.");
                return;
            }
            
            console.log("get bounds result:", rect);
        },
        onTxError
    );
}