Description

Gets the formula mode of the ruler bar.

Syntax

<void> RulerBarViewGenerator.getFormulaMode(<RequestRulerBarFormulaModeCallback> callback, [<ErrorCallback> errorCallback])

Parameters

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

Examples

The following example demonstrates RulerBarViewGenerator.getFormulaMode in a practical document-editing workflow. It gets the formula mode of the ruler bar.

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

TXTextControl.rulerBar.getFormulaMode(
    function(formulaMode) {
        if (!formulaMode) {
            console.warn("No ruler bar formula mode was returned.");
            return;
        }
        
        console.log("get formula mode result:", formulaMode);
    },
    onTxError
);