|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.carto.PageDescription
public class PageDescription
The Page Description coclass contains a description of the page layout in the current document.
Constructor Summary | |
---|---|
PageDescription()
Constructs a PageDescription using ArcGIS Engine. |
|
PageDescription(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. PageDescription thePageDescription = (PageDescription) obj; |
Method Summary | |
---|---|
void |
deserialize(IXMLSerializeData data)
Deserializes an object from XML. |
boolean |
equals(Object o)
Compare this object with another |
void |
getClassID(GUID[] pClassID)
getClassID |
static String |
getClsid()
getClsid. |
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. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
int |
getUnits()
The page units. |
double |
getWidth()
The width of the page. |
int |
hashCode()
the hashcode for this object |
void |
isDirty()
isDirty |
void |
load(IStream pstm)
load |
void |
readExternal(ObjectInput in)
|
void |
save(IStream pstm,
int fClearDirty)
save |
void |
serialize(IXMLSerializeData data)
Serializes an object to XML. |
void |
setCustomGraphics(IGraphicElements elements)
Custom graphics on the page. |
void |
setExtent(IEnvelope pageExtent)
The current extent of the page. |
void |
writeExternal(ObjectOutput out)
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
---|
getJintegraDispatch, release |
Constructor Detail |
---|
public PageDescription() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic PageDescription(Object obj) throws IOException
PageDescription thePageDescription = (PageDescription) obj;
obj
to PageDescription
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problemsMethod Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public double getHeight() throws IOException, AutomationException
The height is in page units (e.g. inches, centimeters...).
getHeight
in interface IPageDescription
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getWidth() throws IOException, AutomationException
The width is in page units (e.g. inches, centimeters...).
getWidth
in interface IPageDescription
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getUnits() throws IOException, AutomationException
getUnits
in interface IPageDescription
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnvelope getExtent() throws IOException, AutomationException
Use Extent to export a part of the layout page. The extent is in page units (e.g. inches, centimeters...). It is important to note that the default value for this extent property is equal to the full extent of the original page layout. It does not equal the state of layout extent in the Active View before saving the map document (for example, zooming into the page layout before saving the map).
getExtent
in interface IPageDescription
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setExtent(IEnvelope pageExtent) throws IOException, AutomationException
setExtent
in interface IPageDescription
pageExtent
- A reference to a com.esri.arcgis.geometry.IEnvelope (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGraphicElements getCustomGraphics() throws IOException, AutomationException
Use CustomGraphics to add dynamic text or graphics to the exported layout. One common use of CustomGraphics is to add a customizable, dynamic title to each result of an ExportLayout request.
getCustomGraphics
in interface IPageDescription
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCustomGraphics(IGraphicElements elements) throws IOException, AutomationException
setCustomGraphics
in interface IPageDescription
elements
- A reference to a com.esri.arcgis.carto.IGraphicElements (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IMapFrameDescriptions getMapFrames() throws IOException, AutomationException
getMapFrames
in interface IPageDescription
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void serialize(IXMLSerializeData data) throws IOException, AutomationException
serialize
in interface IXMLSerialize
data
- A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void deserialize(IXMLSerializeData data) throws IOException, AutomationException
deserialize
in interface IXMLSerialize
data
- A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void isDirty() throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty
in interface IPersistStream
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void load(IStream pstm) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void save(IStream pstm, int fClearDirty) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)fClearDirty
- The fClearDirty (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getSizeMax(_ULARGE_INTEGER[] pcbSize) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax
in interface IPersistStream
pcbSize
- A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getClassID(GUID[] pClassID) throws IOException, AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID
in interface IPersist
pClassID
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void writeExternal(ObjectOutput out) throws IOException
writeExternal
in interface Externalizable
IOException
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
readExternal
in interface Externalizable
IOException
ClassNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |