DS Server

Javascript: Selection.setAutoBaseline Method

Method|Introduced in 30.0

Description

Sets values specifying automatic sub- or superscripted text. When using automatic sub- and superscript the font is scaled and moved above or below the baseline with values defined through the font itself. Automatic sub- and superscript can be combined with a user-defined baseline which can be set with the Baseline property.

Syntax

<void> Selection.setAutoBaseline(<AutoBaseline> autoBaseline, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
autoBaseline

The auto baseline of the selected text.

callback

Optional. Is called when the operation completed.

errorCallback

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

Examples

The following example demonstrates Selection.setAutoBaseline in a practical document-editing workflow. It sets values specifying automatic sub- or superscripted text. When using automatic sub- and superscript the font is scaled and moved above or below the baseline with values defined through the font itself. Automatic sub- and superscript can be combined with a user-defined baseline which can be set with the Baseline property.

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

TXTextControl.selection.setAutoBaseline(
    TXTextControl.AutoBaseline.Superscript,
    function() {
        console.log("set auto baseline completed.");
    },
    onTxError
);