In This Topic ▼

isParsed Property

Summary

Gets a value that indicate whether the structure of this document has been parsed.

Syntax

TypeScript

JavaScript

Object.defineProperty(DocumentStructure.prototype, 'isParsed', 
   get: function() 
)

readonly isParsed: boolean;

Property Value

true if the structure of this document has been parsed; otherwise, false.

Remarks

Bookmarks will contain an empty list if the structure of the document has not been parsed yet (the value of IsParsed is false). This list will be populated with the items found in the original document when Parse is called and the value of ParseBookmarks is true (the default value). When Parse returns, the value of IsParsed will be set to true.

Parse will also parse the document for any links found in the pages if the value of ParsePageLinks is true (the default value), these can be obtain through the DocumentPage.GetLinks method.

Note that if this is a virtual document with children, then the value of this property will false if any of the child document report false or if the document has no children and will be true only if all the children report true.

Example

For an example, refer to DocumentStructure.

Requirements

Target Platforms