Click or drag to resize

PdfBookmarkOptions Class

Controls the bookmark generation
Inheritance Hierarchy
SystemObject
  ExpertPdf.PdfCreatorPdfBookmarkOptions

Namespace:  ExpertPdf.PdfCreator
Assembly:  epdfcreator (in epdfcreator.dll) Version: 17.0.0
Syntax
public class PdfBookmarkOptions

The PdfBookmarkOptions type exposes the following members.

Constructors
  NameDescription
Public methodPdfBookmarkOptions
Top
Properties
  NameDescription
Public propertyAllowDefaultTitle
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.
Public propertyBookmarkHiddenElements
When this property is true the converter will generate bookmarks for hidden HTML elements. Default value is true.
Public propertyClassNameFilter
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.
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 and DefaultTitleToOuterHtml is false. This property defaults to "Bookmark" text.
Public propertyDefaultTitleToOuterHtml
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.
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". Note: This is used only by the WebKit rendering engine.
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. The default value is -1 and the bookmark title will not be truncated.
Public propertyTagNames
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.
Top
See Also