Description

Sets the field's format.

Syntax

<void> ApplicationField.setFormat(<ApplicationFieldFormat> format, [<EmptyRequestCallback> callback])

Parameters

Parameter	Description
format	The field's format.
callback	Optional. Is called when the operation completed.

Examples

The following example demonstrates ApplicationField.setFormat in a practical document-editing workflow. It sets the field's format.

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

TXTextControl.textParts.getMainText(function(mainText) {
    const applicationFields = mainText.applicationFields;
    applicationFields.getItem(function(applicationField) {
        if (!applicationField) {
            console.warn("No application field is available at the current input position.");
            return;
        }
    
        applicationField.setFormat(
            TXTextControl.ApplicationFieldFormat.MSWord,
            function() {
                console.log("set format completed.");
            }
        );
    }, onTxError);
}, onTxError);