OutlineOptions class
OutlineOptions class
Allows to specify outline options. To learn more, visit the Save a Document documentation article.
Constructors
| Name | Description |
|---|---|
| OutlineOptions() | The default constructor. |
Properties
| Name | Description |
|---|---|
| bookmarks_outline_levels | Allows to specify individual bookmarks outline level. |
| create_missing_outline_levels | Gets or sets a value determining whether or not to create missing outline levels when the document is exported. |
| create_outlines_for_headings_in_tables | Specifies whether or not to create outlines for headings (paragraphs formatted with the Heading styles) inside tables. |
| default_bookmarks_outline_level | Specifies the default level in the document outline at which to display Word bookmarks. |
| expanded_outline_levels | Specifies how many levels in the document outline to show expanded when the file is viewed. |
| headings_outline_levels | Specifies how many levels of headings (paragraphs formatted with the Heading styles) to include in the document outline. |
Examples
Shows to process bookmarks in headers/footers in a document that we are rendering to PDF.
doc = aw.Document(MY_DIR + "Bookmarks in headers and footers.docx")
# Create a "PdfSaveOptions" object that we can pass to the document's "save" method
# to modify how that method converts the document to .PDF.
save_options = aw.saving.PdfSaveOptions()
# Set the "page_mode" property to "PdfPageMode.USE_OUTLINES" to display the outline navigation pane in the output PDF.
save_options.page_mode = aw.saving.PdfPageMode.USE_OUTLINES
# Set the "default_bookmarks_outline_level" property to "1" to display all
# bookmarks at the first level of the outline in the output PDF.
save_options.outline_options.default_bookmarks_outline_level = 1
# Set the "header_footer_bookmarks_export_mode" property to "HeaderFooterBookmarksExportMode.NONE" to
# not export any bookmarks that are inside headers/footers.
# Set the "header_footer_bookmarks_export_mode" property to "HeaderFooterBookmarksExportMode.FIRST" to
# only export bookmarks in the first section's header/footers.
# Set the "header_footer_bookmarks_export_mode" property to "HeaderFooterBookmarksExportMode.ALL" to
# export bookmarks that are in all headers/footers.
save_options.header_footer_bookmarks_export_mode = header_footer_bookmarks_export_mode
doc.save(ARTIFACTS_DIR + "PdfSaveOptions.header_footer_bookmarks_export_mode.pdf", save_options)
See Also
- module aspose.words.saving