Javascript: TXTextControl.getTextParts Method

Description

Obsolete. This method will be removed in one of the next versions. Requests a collection of either all text parts the current document contains or only the text part containing the input position from the server and returns the collection by calling a callback function which has to be provided as a parameter to the function.

Syntax

<void> TXTextControl.getTextParts(<RequestTextPartsCallback> callback, [<boolean> atInputPosition])

Parameters

Parameter	Description
callback	Is called with an array of text parts as a parameter containing the requested text parts as soon as the information has been retrieved from the server.
atInputPosition	Optional. A boolean value indicating that only the text part containing the input position should be retrieved.

Examples

The following example demonstrates TXTextControl.getTextParts in a practical document-editing workflow. Obsolete. This method will be removed in one of the next versions. Requests a collection of either all text parts the current document contains or only the text part containing the input position from the server and returns the collection by calling a callback function which has to be provided as a parameter to the function.

TXTextControl.getTextParts(
    function(result) {
        if (!result) {
            console.warn("No text part was returned.");
            return;
        }
        
        console.log("get text parts result:", result);
    },
    true
);