OutlineOptions.DefaultBookmarksOutlineLevel

OutlineOptions DefaultBookmarksOutlineLevel property. Specifies the default level in the document outline at which to display Word bookmarks.

OutlineOptions.DefaultBookmarksOutlineLevel property

Specifies the default level in the document outline at which to display Word bookmarks.

public int DefaultBookmarksOutlineLevel { get; set; }

Remarks

Individual bookmarks level could be specified using BookmarksOutlineLevels property.

Specify 0 and Word bookmarks will not be displayed in the document outline. Specify 1 and Word bookmarks will be displayed in the document outline at level 1; 2 for level 2 and so on.

Default is 0. Valid range is 0 to 9.

Examples

Shows how to configure bookmarks outline levels.

PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
// Configure exporting bookmarks in document header/footer
pdfSaveOptions.HeaderFooterBookmarksExportMode = HeaderFooterBookmarksExportMode.None;
// Set default bookmarks outline level
pdfSaveOptions.OutlineOptions.DefaultBookmarksOutlineLevel = 1;
// Specify concrete bookmark outline level.
pdfSaveOptions.OutlineOptions.BookmarksOutlineLevels.Add("bk3", 2);
pdfSaveOptions.OutlineOptions.BookmarksOutlineLevels.Add("bk4", 3);
// Remove bookmark
if (pdfSaveOptions.OutlineOptions.BookmarksOutlineLevels.Contains("bk3"))
    pdfSaveOptions.OutlineOptions.BookmarksOutlineLevels.Remove("bk3");
// Clear all specified bookmark outline levels.
if (pdfSaveOptions.OutlineOptions.BookmarksOutlineLevels.Count > 0)
    pdfSaveOptions.OutlineOptions.BookmarksOutlineLevels.Clear();
// Add bookmark back
pdfSaveOptions.OutlineOptions.BookmarksOutlineLevels["bk3"] = 2;
Converter.Create()
    .From(MyDir + "Simple.docx")
    .To(ArtifactsDir + "BookmarksOutlineLevel.pdf", pdfSaveOptions)
    .Execute();

See Also