DS Server

Javascript: TXTextControl.getRenderMode Method

Method|Introduced in 32.0

Description

Gets the component render mode.

Syntax

<void> TXTextControl.getRenderMode(<RequestRenderModeCallback> callback, [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
callback

Receives the property value.

errorCallback

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

Examples

The following example demonstrates TXTextControl.getRenderMode in a practical document-editing workflow. It gets the component render mode.

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

TXTextControl.getRenderMode(
    function(renderMode) {
        if (!renderMode) {
            console.warn("No component render mode was returned.");
            return;
        }
        
        console.log("get render mode result:", renderMode);
    },
    onTxError
);