TX Text Control .NET Server

Javascript: TXTextControl.Proofing.getUserDictionaryInfo Method

Method|Introduced in 25.0

Description

Retrieves information about all currently existing user dictionaries via a callback function.

Syntax

<void> TXTextControl.Proofing.getUserDictionaryInfo(<GetUserDictionaryInfoCallback> callback)

Parameters

ParameterDescription
callback

The callback function which is called as soon as the dictionary information has been received from the server.

Examples

The following example demonstrates TXTextControl.Proofing.getUserDictionaryInfo in a practical document-editing workflow. Retrieves information about all currently existing user dictionaries via a callback function.

function inspectUserDictionaryInfo(proofing) {
    proofing.getUserDictionaryInfo(
        function(info) {
            if (!info) {
                console.warn("No user dictionary info was returned.");
                return;
            }
            
            console.log("get user dictionary info result:", info);
        }
    );
}