PdfBookmarkOptions Class

EVO HTML to PDF Converter Client Documentation
This class contains the necessary properties to control the bookmarks creation in a PDF document
Inheritance Hierarchy

SystemObject
  EvoPdf.HtmlToPdfClientPdfBookmarkOptions

Namespace:  EvoPdf.HtmlToPdfClient
Assembly:  EvoHtmlToPdfClient (in EvoHtmlToPdfClient.dll) Version: 7.5.0.0 (7.5.0.0)
Syntax

public class PdfBookmarkOptions

The PdfBookmarkOptions type exposes the following members.

Constructors

  NameDescription
Public methodPdfBookmarkOptions
Initializes a new instance of the PdfBookmarkOptions class
Top
Properties

  NameDescription
Public propertyAllowDefaultTitle
A flag indicating if the HTML elements without text can be bookmarked. This property is true by default
Public propertyAutoBookmarksEnabled
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 propertyDefaultTitle
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 propertyHierarchicalBookmarks
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 propertyHtmlElementSelectors
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 propertyMaxTitleLength
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
Top
Methods

  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also

Reference