DS Server

FootnoteCallbackData Object

Object|Introduced in 32.0

Description

The type of the response parameter of the AddFootnoteCallback callback function.

Syntax

{
   footnote: <Footnote>,
   added: <boolean>
}

Examples

The following example demonstrates FootnoteCallbackData in a practical document-editing workflow. The type of the response parameter of the AddFootnoteCallback callback function.

function inspectFootnoteCallbackData(footnoteCallbackData) {
    console.log("footnote:", footnoteCallbackData.footnote);
    console.log("added:", footnoteCallbackData.added);
}

Members

Properties

PropertyDescription
addedIndicates whether the footnote was added successfully.
footnoteThe added footnote. Is null if no footnote could be added.