Description

Gets an object with all user-defined document properties contained in the current document.

Syntax

<void> DocumentSettings.getUserDefinedDocumentProperties(<RequestObjectCallback> 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 DocumentSettings.getUserDefinedDocumentProperties in a practical document-editing workflow. It gets an object with all user-defined document properties contained in the current document.

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

TXTextControl.documentSettings.getUserDefinedDocumentProperties(
    function(obj) {
        if (!obj) {
            console.warn("No object was returned.");
            return;
        }
        
        console.log("get user defined document properties result:", obj);
    },
    onTxError
);