Javascript: Footnote.setName Method

Description

Sets a name for the footnote. An empty string indicates that the footnote has no name.

Syntax

<void> Footnote.setName(<string> value, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

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

Examples

The following example demonstrates Footnote.setName in a practical document-editing workflow. It sets a name for the footnote. An empty string indicates that the footnote has no name.

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

TXTextControl.footnotes.elementAt(0, function(footnote) {
    if (!footnote) {
        console.warn("No footnote is available.");
        return;
    }

    footnote.setName(
        "Quarterly report",
        function() {
            console.log("set name completed.");
        },
        onTxError
    );
}, onTxError);