Get Started
Usage API
More information

AddFootnoteCrossRef

AddFootnoteCrossRef(sRefType, oParaTo, [bLink], [bAboveBelow]) → { boolean }

Adds a footnote cross-reference to the current paragraph. The paragraph must be in the document.

Parameters:

Name Type Default Description
sRefType footnoteRefTo

The text or numeric value of a footnote reference you want to insert.

oParaTo ApiParagraph

The first paragraph from a footnote to be referred to (must be in the document).

bLink boolean true

Specifies if the reference will be inserted as a hyperlink.

bAboveBelow boolean false

Specifies if the above/below words indicating the position of the reference should be included (don't used with the "aboveBelow" sRefType).

Returns:

Type
boolean

Example

Copy code
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oElement = oDocument.GetElement(0);
var nElementCount = oElement.GetElementsCount();
if (nElementCount == 1) {
    var oRun = Api.CreateRun();
    oRun.AddText("Add any footnote to this page. To do this, select any word or word phrase in this sentences, open the References tab and click Footnote. Enter the footnote text. After that, copy the macro above (without the first and last two lines) and run it (Plugins -> Macros).");
    oElement.AddElement(oRun);
}
else {
    var aFootnotesFirstParagraphs = oDocument.GetFootnotesFirstParagraphs();
    var oParagraph = Api.CreateParagraph();
    oParagraph.AddText("For more information on previous sentences see footnote ");
    oDocument.Push(oParagraph);
    oParagraph.AddFootnoteCrossRef("formFootnoteNum", aFootnotesFirstParagraphs[0]);
}
builder.SaveFile("docx", "AddFootnoteCrossRef.docx");
builder.CloseFile();

Resulting document