Skip to main content

GetIncludePageNumbers

Returns whether page numbers are shown in the table of figures.

note

This functionality is available in paid ONLYOFFICE Docs editions.

Syntax​

expression.GetIncludePageNumbers();

expression - A variable that represents an ApiTableOfFigures class.

Parameters​

This method doesn't have any parameters.

Returns​

boolean

Example​

Check whether a table of figures shows page numbers.

// Add a captioned figure and a table of figures built from the "Figure" label.

// Read whether page numbers are included in the table of figures entries.

let doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
paragraph.AddText("Figure 1");
paragraph.AddCaption(" - Sample figure", "Figure", false, "Arabic", false, undefined, "hyphen");
let tof = doc.AddTableOfFigures({"BuildFrom": "Figure", "LabelNumber": true});
let isInclude = tof.GetIncludePageNumbers();
let resultParagraph = Api.CreateParagraph();
resultParagraph.AddText("Page numbers included: " + isInclude);
doc.Push(resultParagraph);