Javascript: TextFrame.setAlignment Method

Description

Sets the frame's horizontal alignment when it is anchored to a paragraph.

Syntax

<void> TextFrame.setAlignment(<HorizontalAlignment> value, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
value	The new property value.
callback	Optional. Is called when the operation completed.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates TextFrame.setAlignment in a practical document-editing workflow. It sets the frame's horizontal alignment when it is anchored to a paragraph.

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

function configureAlignment(textFrame) {
    textFrame.setAlignment(
        TXTextControl.HorizontalAlignment.Center,
        function() {
            console.log("set alignment completed.");
        },
        onTxError
    );
}