PDFParseDocumentStructureOptions Enumeration

Summary

Specifies options to use when parsing a PDF document structure.

Syntax

C++

Java

[SerializableAttribute()] 
[FlagsAttribute()] 
public enum PDFParseDocumentStructureOptions

<FlagsAttribute()> 
<SerializableAttribute()> 
Public Enum PDFParseDocumentStructureOptions

public enum PDFParseDocumentStructureOptions

[FlagsAttribute()] 
[SerializableAttribute()] 
public enum class PDFParseDocumentStructureOptions

Members

Value	Member	Description
0x00000000	None	Do not parse anything.
0x00000001	Bookmarks	Parse the bookmarks that constitute the document's Table of Contents (TOC). This option populates the PDFDocument.Bookmarks property.
0x00000002	InternalLinks	Parse the internal links (or jumps) between the pages found in the document. This option populates the PDFDocument.InternalLinks property.
0x00000004	Images	Parse the images found in the document. This option populates the PDFDocument.Images property.
0x00000008	Fonts	Parse the fonts found in the document. This option populates the PDFDocument.Fonts property.
0x0000001F	All	Parse bookmarks, internal links, images, fonts and embedded files.

Remarks

The PDFParseDocumentStructureOptions enumeration is used as the type of the options parameter passed to the PDFDocument.ParseDocumentStructure method.

The structure of PDF document is its Table of Contents (TOC) which consists of the PDFBookmark objects saved in the document and the collection of the internal links (or jumps) between the pages that are found in all the pages (PDFInternalLink objects).

When a PDFDocument object is created, the value of PDFDocument.Bookmarks and PDFDocument.InternalLinks will be initialized to null. You must call the PDFDocument.ParseDocumentStructure method to parse the items of interest (determined by the PDFParseDocumentStructureOptions passed as the options parameter to the method). This is done for performance reasons and to make it possible to parse only the objects of interest.

You can parse either the bookmarks or the internal links or both of a PDF document using the PDFDocument.ParseDocumentStructure method. When the method returns, the PDFDocument will be updated as follows:

If PDFParseDocumentStructureOptions.Bookmarks is specified, then the PDFDocument.Bookmarks collection will be populated with a PDFBookmark object for each bookmark item found in the document. If no bookmarks are found in the document, PDFDocument.Bookmarks will be initialized with an empty collection (PDFDocument.Bookmarks.Count will be 0).
If PDFParseDocumentStructureOptions.InternalLinks is specified, then the PDFDocument.InternalLinks collection will be populated with a PDFInternalLink object for each internal link (or jump) item found in the document. If no internal links are found in the document, the PDFDocument.InternalLinks will be initialized with an empty collection (PDFDocument.InternalLinks.Count will be 0).

The values of PDFParseDocumentStructureOptions can be OR'ed together.

Example

For an example, refer to PDFDocument.ParseDocumentStructure.

Requirements

Target Platforms

Reference

Leadtools.Pdf Namespace

Download our FREE evaluation

Help Version 20.0.2020.4.3

Leadtools.Pdf Assembly

Introduction

Getting Started

Namespaces

Leadtools.Pdf Namespace

Assemblies