PdfBookmarkOptions Class

Winnovative Client for Windows Universal Platform Documentation

This class contains the necessary properties to control the bookmarks creation in a PDF document

Inheritance Hierarchy

SystemObject
Winnovative.HtmlToPdfClientPdfBookmarkOptions

Namespace: Winnovative.HtmlToPdfClient
Assembly: WnvHtmlToPdfClient_UWP (in WnvHtmlToPdfClient_UWP.dll) Version: 16.0.0.0 (16.0.0.0)

Syntax

public class PdfBookmarkOptions

Public Class PdfBookmarkOptions

The PdfBookmarkOptions type exposes the following members.

Constructors

	Name	Description
	PdfBookmarkOptions	Initializes a new instance of the PdfBookmarkOptions class

Properties

	Name	Description
	AllowDefaultTitle	A flag indicating if the HTML elements without text can be bookmarked. This property is true by default
	AutoBookmarksEnabled	A flag indicating if the automatic creation of bookmarks in PDF for the H1 to H6 HTML elements is enabled or not. By default the automatic bookmarks creation is disabled
	DefaultTitle	Gets or sets the default title to be used for bookmarks that don't have an associated text. This property has effect only if AllowDefaultTitle is true. This property defaults to "Bookmark" text
	HierarchicalBookmarks	A flag indicating if the bookmarks created in PDF for the HTML elements are arranged in a hierarchy based on the bookmark levels defined in HTML. By default this property is true
	HtmlElementSelectors	Gets or sets the selectors of the HTML elements to be bookmarked. For example, the selector for all the H1 elements is "H1", the selector for all the elements with the CSS class name 'myclass' is ".myclass" and the selector for the elements with the id 'myid' is "#myid".
	MaxTitleLength	Gets or sets the maximum accepted length of the bookmark title string. If a positive value is set for this property the bookmark title will be truncated if necessary. By default and the bookmark title will not be truncated

Methods