←Select platform

Size Property (DocumentPage)

Summary

Size of this page.

Syntax

Java

C++

public LeadSizeD Size { get; }

Public ReadOnly Property Size() As LeadSizeD 
   Get

public:  
   property LeadSizeD^ Size 
   { 
      LeadSizeD^ get() 
   }

public LeadSizeD getSize()

Property Value

The size of this DocumentPage in document units.

Remarks

If this DocumentPage corresponds to an original page in the document, then the size of the page is determined from the original physical size and resolution when the Document was loaded. If this page was added to the document by the user, then the size is the value passed to DocumentPages.CreatePage.

OriginalPageNumber is the page number of this DocumentPage in the original document. It is -1 if this page was added by the user.

Refer to Loading Using LEADTOOLS Documents Library for more information.

Size and Resolution will always contain a value and is populated for all pages of the document upon initialization. The LEADTOOLS Document Viewer relies on this to create empty items for each page in the image viewer control. Each item will have the correct size but no image data. It will then loads the raster image or SVG objects for the page in a background thread.

The raster image returned from GetImage() or GetImage(resolution) will have the same size in value as Size (the size will be in pixels and if transformed using Resolution will result in the same value as Size).

If the value of ImageScale is a value greater than 1, then the raster or SVG objects returned will have a size that is equal to Size / ImageScale.

When the user sets a new raster image using SetImage, the Size and Resolution values of the page are updated from the RasterImage object. If the value passed is null, then Size and Resolution will be updated using DocumentPages.DefaultPageSize and DocumentPages.DefaultResolution.

Size is in document units, refer to Documents Library Coordinate System for more information.

Example

For an example, refer to DocumentPage.

Requirements

Target Platforms

See Also