LEADTOOLS PDF (Leadtools.Pdf assembly)
Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.5.11.1
| Leadtools.Pdf Namespace : PDFParseDocumentStructureOptions Enumeration |
[FlagsAttribute()] [SerializableAttribute()] public enum PDFParseDocumentStructureOptions : System.Enum
'Declaration <FlagsAttribute()> <SerializableAttribute()> Public Enum PDFParseDocumentStructureOptions Inherits System.Enum
'Usage Dim instance As PDFParseDocumentStructureOptions
[FlagsAttribute()] [SerializableAttribute()] public enum PDFParseDocumentStructureOptions : System.Enum
Leadtools.Pdf.PDFParseDocumentStructureOptions = function() { };
Leadtools.Pdf.PDFParseDocumentStructureOptions.prototype = {
LeadtoolsMemberMarker(replace me)
};
[FlagsAttribute()] [SerializableAttribute()] public enum class PDFParseDocumentStructureOptions : public System.Enum
| Member | Description |
|---|---|
| All | Parse both the bookmarks and internal links. This is the same as using Bookmarks | InternalLinks. |
| Bookmarks | Parse the bookmarks that constitute the Table of Contents (TOC) of the document. This option will cause the PDFDocument.Bookmarks property to be populated. |
| InternalLinks | Parse the internal links (or jumps) between the pages found in the document. This option will cause the PDFDocument.InternalLinks property to be populated. |
| None | Do not parse anything. |
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 (Nothing in Visual Basic). You must call the PDFDocument.ParseDocumentStructure method to parse the items you are interested in (determined by the PDFParseDocumentStructureOptions passed as the options parameter to the method). This is done for performance reasons and to give the user the ability to parse only the objects of interest.
You can parse either the bookmarks or internal links or both of a PDF document using the 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 there aren't any bookmarks 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 internal links aren't 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.
For an example, refer to PDFDocument.ParseDocumentStructure.
System.Object
System.ValueType
System.Enum
Leadtools.Pdf.PDFParseDocumentStructureOptions
Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2