Javascript: FormattingStyle.setCapitals Method

Description

Sets values specifying wheather lowercase letters are displayed with capital letters. Lowercase letters are displayed either with capital letters of the same size or with capital letters which have a smaller size. The smaller size is either the size of the lowercase 'x' (petite caps) or the size of the lowercase 'x' + 10% (small caps).

Syntax

<void> FormattingStyle.setCapitals(<Capitals> capitals, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

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

Examples

The following example demonstrates FormattingStyle.setCapitals in a practical document-editing workflow. It sets values specifying wheather lowercase letters are displayed with capital letters. Lowercase letters are displayed either with capital letters of the same size or with capital letters which have a smaller size. The smaller size is either the size of the lowercase 'x' (petite caps) or the size of the lowercase 'x' + 10% (small caps).

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

function configureCapitals(formattingStyle) {
    formattingStyle.setCapitals(
        TXTextControl.Capitals.Capitals,
        function() {
            console.log("set capitals completed.");
        },
        onTxError
    );
}