com.esri.arcgis.carto
Interface IPageDescription

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IPageDescriptionProxy, PageDescription

public interface IPageDescription
extends java.io.Serializable

COM Interface 'IPageDescription'. Generated 3/19/2015 1:20:53 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to the available properties of a page description object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID20da6e47_dd79_4b33_abc0_171c4be6c615
static int	xxDummy Deprecated. Internal use only

Method Summary

IGraphicElements	getCustomGraphics() Custom graphics on the page.
IEnvelope	getExtent() The current extent of the page.
double	getHeight() The height of the page.
IMapFrameDescriptions	getMapFrames() Descriptions for the map frames on the page.
int	getUnits() The page units.
double	getWidth() The width of the page.
void	setCustomGraphics(IGraphicElements elements) Custom graphics on the page.
void	setExtent(IEnvelope pageExtent) The current extent of the page.

Field Detail

IID20da6e47_dd79_4b33_abc0_171c4be6c615

static final int IID20da6e47_dd79_4b33_abc0_171c4be6c615

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getHeight

double getHeight()
                 throws java.io.IOException,
                        AutomationException

The height of the page.

Returns:

The pageHeight

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWidth

double getWidth()
                throws java.io.IOException,
                       AutomationException

The width of the page.

Returns:

The pageWidth

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUnits

int getUnits()
             throws java.io.IOException,
                    AutomationException

The page units.

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtent

IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException

The current extent of the page.

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtent

void setExtent(IEnvelope pageExtent)
               throws java.io.IOException,
                      AutomationException

The current extent of the page.

Parameters:

pageExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomGraphics

IGraphicElements getCustomGraphics()
                                   throws java.io.IOException,
                                          AutomationException

Custom graphics on the page.

Returns:

A reference to a com.esri.arcgis.carto.IGraphicElements

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomGraphics

void setCustomGraphics(IGraphicElements elements)
                       throws java.io.IOException,
                              AutomationException

Custom graphics on the page.

Parameters:

elements - A reference to a com.esri.arcgis.carto.IGraphicElements (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapFrames

IMapFrameDescriptions getMapFrames()
                                   throws java.io.IOException,
                                          AutomationException

Descriptions for the map frames on the page.

Returns:

A reference to a com.esri.arcgis.carto.IMapFrameDescriptions

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.