DocumentPage Class

Summary

Represents a page in the current LEADDocument.

Syntax

C++

Java

[DataContractAttribute()] 
public class DocumentPage

<DataContractAttribute()>  
Public Class DocumentPage

public [DataContractAttribute] 
   ref class DocumentPage

public class DocumentPage implements Serializable

Remarks

DocumentPage represents a page in the current LEADDocument. It can be accessed through the Pages collection.

DocumentPages is populated with an item for each page in the original document. Each DocumentPage will have the value of Size and Resolution initialized to their corresponding value in the document. The other parts of the page are obtained on demand when the user calls the various methods.

Use DocumentPages.CreatePage to create a new page when modifying or creating documents.

The page uses the cache system if available, most of the page data are not kept in memory and is either read from the original document or obtained from the cache on demand. This is done to reduce the memory footprint of LEADDocument and to be able to support document with a large number of pages and data.

DocumentPage has the following features:

Member	Description
Size and Resolution	The size in document units and resolution in DPI of the page.
OriginalPageNumber and PageNumber	The page number of the page in the original document (if any) and the current page number in the collection.
GetImage and IsImageModified	Gets and sets a RasterImage of this page.
GetSvg, SetSvg and IsSvgModified	Gets and sets a SvgDocument of this page.
GetSvgBackImage(RasterColor) and IsSvgBackImageModified	Gets and sets the background RasterImage for the SVG image of this page.
GetText and IsTextModified	Gets and sets a DocumentPageText of this page.
GetAnnotations, SetAnnotations and IsAnnotationsModified	Gets and sets a AnnContainer of this page.
GetLinks, SetLinks and IsLinksModified	Gets and sets an array of DocumentLink objects of this page.
Rotate, Flip, Reverse	Rotates, flips or reverses the page.
IsDeleted	Quickly marks a page as deleted to remove it from viewing or conversion.
ReadBarcodes	Reads any barcodes found on the page.
UserData	Any user-defined data that can be associated with the page (and saved to the cache if needed).

Example

For an example, refer to LEADDocument.

Requirements

Target Platforms

Reference

DocumentPage Members

Leadtools.Document Namespace

Download our FREE evaluation

Help Version 20.0.2020.4.3