com.esri.arcgis.output
Interface IPrinter

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

EmfPrinter, IPrinterProxy, PsPrinter

public interface IPrinter
extends java.io.Serializable

COM Interface 'IPrinter'. Generated 3/19/2015 1:20:51 PM from 'C:\ArcGIS\COM\esriOutput.olb'

Description: 'Provides access to members that control the Printer Driver.' 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	IID2ab49820_9406_11d0_87ef_080009ec732a
static int	xxDummy Deprecated. Internal use only

Method Summary

boolean	doesDriverSupportPrinter(java.lang.String printerName) Indicates if the Printer Name passed into function is supported by the IPrinter Driver.
void	finishPrinting() Finish up Printing.
java.lang.String	getDriverName() The name of Windows Printer Driver.
java.lang.String	getFileExtension() File Extension associated with the Printer Driver.
java.lang.String	getFilter() Filter used in CFileDialog.
java.lang.String	getName() Name of the IPrinter Driver.
IPaper	getPaper() The IPaper interface.
IEnvelope	getPrintableBounds() The area of the printer page that can be printed on.
java.lang.String	getPrintToFile() The name of file if saving to Disk.
short	getResolution() The Printer Driver Resolution.
java.lang.String	getSpoolFileName() The Spool File Name which shows up in the Print Manager.
int	getUnits() The units for PaperSize and PrintableBounds.
void	queryPaperSize(double[] width, double[] height) Returns Page Size for Printer.
void	setPaperByRef(IPaper paper) The IPaper interface.
void	setPrintToFile(java.lang.String fileName) The name of file if saving to Disk.
void	setResolution(short res) The Printer Driver Resolution.
void	setSpoolFileName(java.lang.String spoolFileName) The Spool File Name which shows up in the Print Manager.
void	setStepProgressor(IStepProgressor rhs1) Updates a Progress Bar is set.
int	startPrinting(IEnvelope pixelBounds, int hDcPrinter) Initialize Printing.
boolean	verifyDriverSettings() Indicates if the Printer Driver should validate Printer Driver's local settings.

Field Detail

IID2ab49820_9406_11d0_87ef_080009ec732a

static final int IID2ab49820_9406_11d0_87ef_080009ec732a

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

getName

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

Name of the IPrinter Driver.

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFilter

java.lang.String getFilter()
                           throws java.io.IOException,
                                  AutomationException

Filter used in CFileDialog.

Returns:

The filter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFileExtension

java.lang.String getFileExtension()
                                  throws java.io.IOException,
                                         AutomationException

File Extension associated with the Printer Driver.

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPrintToFile

void setPrintToFile(java.lang.String fileName)
                    throws java.io.IOException,
                           AutomationException

The name of file if saving to Disk.

Parameters:

fileName - The fileName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPrintToFile

java.lang.String getPrintToFile()
                                throws java.io.IOException,
                                       AutomationException

The name of file if saving to Disk.

Returns:

The fileName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDriverName

java.lang.String getDriverName()
                               throws java.io.IOException,
                                      AutomationException

The name of Windows Printer Driver.

Returns:

The driverName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSpoolFileName

void setSpoolFileName(java.lang.String spoolFileName)
                      throws java.io.IOException,
                             AutomationException

The Spool File Name which shows up in the Print Manager.

Parameters:

spoolFileName - The spoolFileName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSpoolFileName

java.lang.String getSpoolFileName()
                                  throws java.io.IOException,
                                         AutomationException

The Spool File Name which shows up in the Print Manager.

Returns:

The spoolFileName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setResolution

void setResolution(short res)
                   throws java.io.IOException,
                          AutomationException

The Printer Driver Resolution.

Parameters:

res - The res (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getResolution

short getResolution()
                    throws java.io.IOException,
                           AutomationException

The Printer Driver Resolution.

Returns:

The res

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStepProgressor

void setStepProgressor(IStepProgressor rhs1)
                       throws java.io.IOException,
                              AutomationException

Updates a Progress Bar is set.

Parameters:

rhs1 - A reference to a com.esri.arcgis.system.IStepProgressor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPaperByRef

void setPaperByRef(IPaper paper)
                   throws java.io.IOException,
                          AutomationException

The IPaper interface.

Parameters:

paper - A reference to a com.esri.arcgis.output.IPaper (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPaper

IPaper getPaper()
                throws java.io.IOException,
                       AutomationException

The IPaper interface.

Returns:

A reference to a com.esri.arcgis.output.IPaper

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryPaperSize

void queryPaperSize(double[] width,
                    double[] height)
                    throws java.io.IOException,
                           AutomationException

Returns Page Size for Printer.

Parameters:

width - The width (out: use single element array)

height - The height (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPrintableBounds

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

The area of the printer page that can be printed on.

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.

getUnits

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

The units for PaperSize and PrintableBounds.

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.

verifyDriverSettings

boolean verifyDriverSettings()
                             throws java.io.IOException,
                                    AutomationException

Indicates if the Printer Driver should validate Printer Driver's local settings.

Returns:

The ok

Throws:

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

AutomationException - If the ArcObject component throws an exception.

doesDriverSupportPrinter

boolean doesDriverSupportPrinter(java.lang.String printerName)
                                 throws java.io.IOException,
                                        AutomationException

Indicates if the Printer Name passed into function is supported by the IPrinter Driver.

Parameters:

printerName - The printerName (in)

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

startPrinting

int startPrinting(IEnvelope pixelBounds,
                  int hDcPrinter)
                  throws java.io.IOException,
                         AutomationException

Initialize Printing.

Parameters:

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

hDcPrinter - The hDcPrinter (A COM typedef) (in)

Returns:

The hDcRet (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

finishPrinting

void finishPrinting()
                    throws java.io.IOException,
                           AutomationException

Finish up Printing.

Throws:

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

AutomationException - If the ArcObject component throws an exception.