This class contains the necessary properties to control the bookmarks creation in a PDF document
Inheritance Hierarchy
EvoPdf.HtmlToPdfClientPdfBookmarkOptions
Namespace: EvoPdf.HtmlToPdfClient
Assembly: EvoHtmlToPdfClient (in EvoHtmlToPdfClient.dll) Version: 9.0.0.0 (9.0.0.0)
Syntax
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
Name | Description | |
---|---|---|
Equals | (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also