com.esri.arcgis.output
Interface IPaper

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
IPaperProxy, Paper

public interface IPaper
extends java.io.Serializable

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

Description: 'Provides access to members that control the default printer page settings.' 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 IID387bc1d1_3f54_11d1_885e_0000f87808ee
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void attach(int hDevMode, int hDevNames)
          Attach object to specified DEVMODE and DEVNAMES structures.
 short getFormID()
          The printer page form.
 java.lang.String getFormName()
          The Form Name.
 IEnumNamedID getForms()
          Enumerate forms supported by the printer.
 short getOrientation()
          The printer page orientation (1 = portrait.
 IEnvelope getPrintableBounds()
          The area of the printer page that can be printed on.
 int getPrinterInfo(int[] hDevMode)
          Display the Print Setup Dialog.
 java.lang.String getPrinterName()
          The Printer Name.
 short getTrayID()
          The printer tray.
 IEnumNamedID getTrays()
          Enumerate trays supported by the printer.
 int getUnits()
          The units used by the other properties.
 void queryPaperSize(double[] width, double[] height)
          Returns the size of the printer paper.
 void setFormID(short formID)
          The printer page form.
 void setOrientation(short orientation)
          The printer page orientation (1 = portrait.
 void setPrinterName(java.lang.String printerName)
          The Printer Name.
 void setTrayID(short trayID)
          The printer tray.
 

Field Detail

IID387bc1d1_3f54_11d1_885e_0000f87808ee

static final int IID387bc1d1_3f54_11d1_885e_0000f87808ee
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

getUnits

int getUnits()
             throws java.io.IOException,
                    AutomationException
The units used by the other properties.

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.

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.

getOrientation

short getOrientation()
                     throws java.io.IOException,
                            AutomationException
The printer page orientation (1 = portrait. 2 = landscape).

Returns:
The orientation
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOrientation

void setOrientation(short orientation)
                    throws java.io.IOException,
                           AutomationException
The printer page orientation (1 = portrait. 2 = landscape).

Parameters:
orientation - The orientation (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getForms

IEnumNamedID getForms()
                      throws java.io.IOException,
                             AutomationException
Enumerate forms supported by the printer.

Returns:
A reference to a com.esri.arcgis.system.IEnumNamedID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFormName

java.lang.String getFormName()
                             throws java.io.IOException,
                                    AutomationException
The Form Name.

Returns:
The formName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFormID

short getFormID()
                throws java.io.IOException,
                       AutomationException
The printer page form. Use Win32 DMPAPER_xxx constants.

Returns:
The formID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFormID

void setFormID(short formID)
               throws java.io.IOException,
                      AutomationException
The printer page form. Use Win32 DMPAPER_xxx constants.

Parameters:
formID - The formID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTrays

IEnumNamedID getTrays()
                      throws java.io.IOException,
                             AutomationException
Enumerate trays supported by the printer.

Returns:
A reference to a com.esri.arcgis.system.IEnumNamedID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTrayID

short getTrayID()
                throws java.io.IOException,
                       AutomationException
The printer tray. Use Win32 DMBIN_xxx constants.

Returns:
The trayID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTrayID

void setTrayID(short trayID)
               throws java.io.IOException,
                      AutomationException
The printer tray. Use Win32 DMBIN_xxx constants.

Parameters:
trayID - The trayID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPrinterName

java.lang.String getPrinterName()
                                throws java.io.IOException,
                                       AutomationException
The Printer Name.

Returns:
The printerName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPrinterName

void setPrinterName(java.lang.String printerName)
                    throws java.io.IOException,
                           AutomationException
The Printer Name.

Parameters:
printerName - The printerName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

attach

void attach(int hDevMode,
            int hDevNames)
            throws java.io.IOException,
                   AutomationException
Attach object to specified DEVMODE and DEVNAMES structures. This must be called before using other properties and methods.

Parameters:
hDevMode - The hDevMode (A COM typedef) (in)
hDevNames - The hDevNames (A COM typedef) (in)
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 the size of the printer paper. Units property specifies measurement units.

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.

getPrinterInfo

int getPrinterInfo(int[] hDevMode)
                   throws java.io.IOException,
                          AutomationException
Display the Print Setup Dialog.

Parameters:
hDevMode - The hDevMode (A COM typedef) (out: use single element array)
Returns:
The hDevNames (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.