com.esri.arcgis.carto
Class PrintAndExport

java.lang.Object
  extended by com.esri.arcgis.carto.PrintAndExport
All Implemented Interfaces:
IPrintAndExport, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class PrintAndExport
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IPrintAndExport

Print And Export component.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:
Serialized Form

Constructor Summary
PrintAndExport()
          Constructs a PrintAndExport using ArcGIS Engine.
PrintAndExport(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
PrintAndExport thePrintAndExport = (PrintAndExport) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 void export(IActiveView pActiveView, IExport pExport, double resolution, boolean clip2GraphicExtent, ITrackCancel pTrackCancel)
          Export the specified view.
 void exportPages(IActiveView pActiveView, IExportPDF pPDFExport, IPrintAndExportPageOptions options, double resolution, ITrackCancel pTrackCancel)
          Export the specified pages.
static String getClsid()
          getClsid.
 int getPageCount(IActiveView activeView)
          The data driven pages count.
 IRow getPageRow(IActiveView activeView, String pageName)
          The row that defines the specified data driven page.
 IEnumBSTR getPrinterNames()
          The names of available printers.
 int hashCode()
          the hashcode for this object
 void print(IActiveView pActiveView, IPrinter pPrinter, IPage pPage, int pageID, int resRatio, ITrackCancel pTrackCancel)
          Print the specified view.
 void printPages(IActiveView pActiveView, IPrinter pPrinter, IPage pPage, IPrintAndExportPageOptions options, int resRatio, ITrackCancel pTrackCancel)
          Print the specified pages.
 
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

PrintAndExport

public PrintAndExport()
               throws IOException,
                      UnknownHostException
Constructs a PrintAndExport using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

PrintAndExport

public PrintAndExport(Object obj)
               throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
PrintAndExport thePrintAndExport = (PrintAndExport) obj;

Construct a PrintAndExport using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to PrintAndExport.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getPrinterNames

public IEnumBSTR getPrinterNames()
                          throws IOException,
                                 AutomationException
The names of available printers.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getPrinterNames in interface IPrintAndExport
Returns:
A reference to a com.esri.arcgis.system.IEnumBSTR
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPageRow

public IRow getPageRow(IActiveView activeView,
                       String pageName)
                throws IOException,
                       AutomationException
The row that defines the specified data driven page.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getPageRow in interface IPrintAndExport
Parameters:
activeView - A reference to a com.esri.arcgis.carto.IActiveView (in)
pageName - The pageName (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IRow
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPageCount

public int getPageCount(IActiveView activeView)
                 throws IOException,
                        AutomationException
The data driven pages count.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getPageCount in interface IPrintAndExport
Parameters:
activeView - A reference to a com.esri.arcgis.carto.IActiveView (in)
Returns:
The pPageCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

printPages

public void printPages(IActiveView pActiveView,
                       IPrinter pPrinter,
                       IPage pPage,
                       IPrintAndExportPageOptions options,
                       int resRatio,
                       ITrackCancel pTrackCancel)
                throws IOException,
                       AutomationException
Print the specified pages.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
printPages in interface IPrintAndExport
Parameters:
pActiveView - A reference to a com.esri.arcgis.carto.IActiveView (in)
pPrinter - A reference to a com.esri.arcgis.output.IPrinter (in)
pPage - A reference to a com.esri.arcgis.carto.IPage (in)
options - A reference to a com.esri.arcgis.output.IPrintAndExportPageOptions (in)
resRatio - The resRatio (in, optional, pass 0 if not required)
pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in, optional, pass 0 if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

print

public void print(IActiveView pActiveView,
                  IPrinter pPrinter,
                  IPage pPage,
                  int pageID,
                  int resRatio,
                  ITrackCancel pTrackCancel)
           throws IOException,
                  AutomationException
Print the specified view.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
print in interface IPrintAndExport
Parameters:
pActiveView - A reference to a com.esri.arcgis.carto.IActiveView (in)
pPrinter - A reference to a com.esri.arcgis.output.IPrinter (in)
pPage - A reference to a com.esri.arcgis.carto.IPage (in)
pageID - The pageID (in, optional, pass 1 if not required)
resRatio - The resRatio (in, optional, pass 0 if not required)
pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in, optional, pass 0 if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

exportPages

public void exportPages(IActiveView pActiveView,
                        IExportPDF pPDFExport,
                        IPrintAndExportPageOptions options,
                        double resolution,
                        ITrackCancel pTrackCancel)
                 throws IOException,
                        AutomationException
Export the specified pages.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
exportPages in interface IPrintAndExport
Parameters:
pActiveView - A reference to a com.esri.arcgis.carto.IActiveView (in)
pPDFExport - A reference to a com.esri.arcgis.output.IExportPDF (in)
options - A reference to a com.esri.arcgis.output.IPrintAndExportPageOptions (in)
resolution - The resolution (in)
pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

export

public void export(IActiveView pActiveView,
                   IExport pExport,
                   double resolution,
                   boolean clip2GraphicExtent,
                   ITrackCancel pTrackCancel)
            throws IOException,
                   AutomationException
Export the specified view.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
export in interface IPrintAndExport
Parameters:
pActiveView - A reference to a com.esri.arcgis.carto.IActiveView (in)
pExport - A reference to a com.esri.arcgis.output.IExport (in)
resolution - The resolution (in)
clip2GraphicExtent - The clip2GraphicExtent (in)
pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.