Page interface¶

The Page interface represents a single page in an image laid-out document. The page allows access to the words on a page, as well as the ability to render it onto a canvas such as TIFF, PNG, or PDF.

To obtain this interface, call the Extractor::GetPage.

Page::Annotations property	Gets an enumerable collections of annotations on the page.
Page::Close method	The Close method releases any resources associated with the page.
Page::Compare method	The Compare method allows you to compare two pages returning the differences.
Page::FormElements property	Returns an enumerable collections of form elements on the page.
Page::GetAnnotation method	The GetAnnotation method is used to retrieve the annotation on the page at the specified index.
Page::GetAnnotationCount method	The GetAnnotationCount method returns the number of annotations that are on a page. The annotations can be enumerated using the GetFirstAnnotation and GetNextAnnotation methods, or accessed via index using the GetAnnotation method.
Page::GetAttribute method	IGR_Get_Page_Attribute returns style or properties of an open page; see <page> under Structured XML for a full list of options.
Page::GetFirstAnnotation method	The GetFirstAnnotation method is used to enumerate the annotations that are on the page.
Page::GetFirstFormElement method	The GetFirstFormElement method is used to enumerate the form controls that are on the page.
Page::GetFirstHyperlink method	The GetFirstHyperlink method is used to enumerate the hyperlinks that are on the page.
Page::GetFirstImage method	The GetFirstImage method is used to enumerate the embedded images that are on the page. This method is useful if the page images are to be extracted and stored in separate files. These methods are not needed if the page is to be rendered into an image output canvas such as PNG, TIFF, or PDF.
Page::GetFirstWord method	The GetFirstWord method is used to enumerate all the words on the current page. GetFirstWord resets the enumeration back to the beginning. The method will return a reference to a Word object, or NULL if there are no more words.
Page::GetNextAnnotation method	The GetNextAnnotation method is used to enumerate the annotations that are on the page.
Page::GetNextFormElement method	The GetNextFormElement method is used to enumerate the form controls that are on the page.
Page::GetNextHyperlink method	The GetNextHyperlink method is used to enumerate the hyperlinks that are on the page.
Page::GetNextImage method	The GetNextImage method is used to enumerate the embedded images that are on the page. This method is useful if the page images are to be extracted and stored in separate files. These methods are not needed if the page is to be rendered into an image output canvas such as PNG, TIFF, or PDF.
Page::GetNextWord method	The GetNextWord method is used to enumerate all the words on the current page. The method will return a reference to a Word object, or NULL if there are no more words.
Page::GetRootPageElement method	Returns the root page element for this page.
Page::Handle property	Returns the pages IGR_HPAGE handle that can be used with the C API.
Page::Height property	The height property return the dimensions of a page in pixels.
Page::Hyperlinks property	Returns an enumerable collections of hyperlinks on the page.
Page::Images property	Returns an enumerable collections of image elements on the page.
Page::Redact method	Redact removes a range of words and blacks out the location for the specified range from the page.
Page::Text property	The Text property returns all the text contained on the page.
Page::Width property	The width property return the dimensions of a page in pixels.
Page::WordCount property	The WordCount property returns the number of “Word”s that are on a page. The words can be enumerated using the GetFirstWord and GetNextWord methods.
Page::Words property	Returns an enumerable collections of form elements on the page.