com.aspose.words

Class PageInfo

java.lang.Object

com.aspose.words.PageInfo

public class PageInfo
extends java.lang.Object

Represents information about a particular document page.

To learn more, visit the Rendering documentation article.

Remarks:

The page width and height returned by this object represent the "final" size of the page e.g. they are already rotated to the correct orientation.

See Also:

Document.getPageInfo(int)

Method Summary

Modifier and Type	Method and Description
boolean	getColored() Returns true if the page contains colored content.
float	getHeightInPoints() Gets the height of the page in points.
boolean	getLandscape() Returns true if the page orientation specified in the document for this page is landscape.
int	getPaperSize() Gets the paper size as enumeration.
int	getPaperTray() Gets the paper tray (bin) for this page as specified in the document.
java.awt.Dimension	getSizeInPixels(float scale, float dpi) Calculates the page size in pixels for a specified zoom factor and resolution.
java.awt.Dimension	getSizeInPixels(float scale, float horizontalDpi, float verticalDpi) Calculates the page size in pixels for a specified zoom factor and resolution.
java.awt.geom.Point2D.Float	getSizeInPoints() Gets the page size in points.
float	getWidthInPoints() Gets the width of the page in points.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getSizeInPixels

public java.awt.Dimension getSizeInPixels(float scale,
                                          float dpi)

Calculates the page size in pixels for a specified zoom factor and resolution.

Parameters:

scale - The zoom factor (1.0 is 100%).

dpi - The resolution (horizontal and vertical) to convert from points to pixels (dots per inch).

Returns:

The size of the page in pixels.

getSizeInPixels

public java.awt.Dimension getSizeInPixels(float scale,
                                          float horizontalDpi,
                                          float verticalDpi)

Calculates the page size in pixels for a specified zoom factor and resolution.

Parameters:

scale - The zoom factor (1.0 is 100%).

horizontalDpi - The horizontal resolution to convert from points to pixels (dots per inch).

verticalDpi - The vertical resolution to convert from points to pixels (dots per inch).

Returns:

The size of the page in pixels.

getPaperSize

public int getPaperSize()

Gets the paper size as enumeration.

Returns:

The paper size as enumeration. The returned value is one of PaperSize constants.

getWidthInPoints

public float getWidthInPoints()

Gets the width of the page in points.

Returns:

The width of the page in points.

getHeightInPoints

public float getHeightInPoints()

Gets the height of the page in points.

Returns:

The height of the page in points.

getSizeInPoints

public java.awt.geom.Point2D.Float getSizeInPoints()

Gets the page size in points.

Returns:

The page size in points.

getPaperTray

public int getPaperTray()

Gets the paper tray (bin) for this page as specified in the document. The value is implementation (printer) specific.

Returns:

The paper tray (bin) for this page as specified in the document.

getLandscape

public boolean getLandscape()

Returns true if the page orientation specified in the document for this page is landscape.

Returns:

true if the page orientation specified in the document for this page is landscape.

getColored

public boolean getColored()
                   throws java.lang.Exception

Returns true if the page contains colored content.

Examples:

Shows how to check whether the page is in color or not.

 
 Document doc = new Document(getMyDir() + "Document.docx");

 // Check that the first page of the document is not colored.
 Assert.assertFalse(doc.getPageInfo(0).getColored());
 
 

Returns:

true if the page contains colored content.

Throws:

java.lang.Exception