Table of Contents

Class PdfBookmarkOptions

Namespace
EvoPdf
Assembly
evohtmltopdf.dll

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

[ClassInterface(ClassInterfaceType.AutoDual)]
public class PdfBookmarkOptions
Inheritance
PdfBookmarkOptions
Inherited Members

Constructors

PdfBookmarkOptions()

public PdfBookmarkOptions()

Properties

AllowDefaultTitle

A flag indicating if the HTML elements without text can be bookmarked. This property is true by default

public bool AllowDefaultTitle { get; set; }

Property Value

bool

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

public bool AutoBookmarksEnabled { get; set; }

Property Value

bool

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

public string DefaultTitle { get; set; }

Property Value

string

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

public bool HierarchicalBookmarks { get; set; }

Property Value

bool

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".

public string[] HtmlElementSelectors { get; set; }

Property Value

string[]

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

public int MaxTitleLength { get; set; }

Property Value

int