TofPr
Table of figures properties.
Type
Object
Properties
| Name | Type | Description | 
|---|---|---|
| BuildFrom | CaptionLabel | string | Specifies whether to generate the table of figures based on the specified caption label or the paragraph style name used (for example, "Heading 1"). | 
| FormatAsLinks | boolean | Specifies whether to format the table of figures as links. | 
| LabelNumber | boolean | Specifies whether to include the label and number in the table of figures. | 
| LeaderType | TocLeader | The leader type in the table of figures. | 
| RightAlgn | boolean | Specifies whether to right-align page numbers in the table of figures. | 
| ShowPageNums | boolean | Specifies whether to show page numbers in the table of figures. | 
| TofStyle | TofStyle | The table of figures style type. | 
Example
This example adds a table of figures with the specified properties to the document.
- Code
- Result
// How to create a table of figures properties.
// Add a table of figures from created properties.
let tofPr = {
	"ShowPageNums": true,
	"RightAlgn": true,
	"LeaderType": "dot",
	"FormatAsLinks": true,
	"BuildFrom": "Figure",
	"LabelNumber": true,
	"TofStyle": "distinctive"
};
doc.AddTableOfFigures(tofPr);