Controls the bookmark generation
Declaration Syntax| C# | Visual Basic | Visual C++ |
public class PdfBookmarkOptions
Public Class PdfBookmarkOptions
public ref class PdfBookmarkOptions
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | PdfBookmarkOptions()()()() | |
 | AllowDefaultTitle |
By default the converter will not generate bookmarks for the tags that don't have a text (e.g IMG tag).
Setting this property true will instruct the converter to use the DefaultTitle or the tag outer HTML as
bookmark title. The default value is false and therefore the converter will ignore the bookmarks for which a title
cannot be automatically determined.
Note: This is used only by the IE rendering engine.
|
| BookmarkHiddenElements |
When this property is true the converter will generate bookmarks for hidden HTML elements.
Default value is true.
Note: This is used only by the IE rendering engine.
|
| ClassNameFilter |
An additional filter to be applied to the tag name filter. This must be identical with the string
set for the 'class' atttribute of the HTML tag.
Note: This is used only by the IE rendering engine.
|
| 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 and DefaultTitleToOuterHtml is false. This property defaults to "Bookmark" text.
Note: This is used only by the IE rendering engine.
|
| DefaultTitleToOuterHtml |
When is true this property instructs the converter to use the tag outer HTML code as title when a correct title cannot be automatically determined
for the bookmark. This property has effect only when the AllowDefaultTitle property is true and it has priority over the
DefaultTitle property. The default value is false.
Note: This is used only by the IE rendering engine.
|
| Equals(Object) | (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.) |
| 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".
Note: This is used only by the WebKit rendering engine.
|
| 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 necessasry. The default value is -1 and the bookmark title will not be truncated.
|
| MemberwiseClone()()()() | Creates a shallow copy of the current Object. (Inherited from Object.) |
| TagNames |
Gets or sets the names of the HTML tags to be bookmarked, e.g. "H1".
If null or empty no bookmark will be generated for the PDF document.
Note: This is used only by the IE rendering engine.
|
| ToString()()()() | Returns a string that represents the current object. (Inherited from Object.) |
Inheritance Hierarchy| Object | |
 | PdfBookmarkOptions |
Assembly: ExpertPdf.HtmlToPdf (Module: ExpertPdf.HtmlToPdf.dll) Version: 9.2.0.25824 (9.2.0.0)