com.esri.arcgis.output
Interface IPSDriver2

All Superinterfaces:
Serializable
All Known Implementing Classes:
PSDriver, PsPrinter

public interface IPSDriver2
extends Serializable

Provides access to members that control the other options of the PostScript Driver.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void createPS(String inputFileName, String outputFileName)
          Converts the EMF file to a EPS File.
 short getCopies()
          The number of copies.
 int getEmulsion()
          The Emulsion setting for the PostScript Driver.
 IFontMapCollection getFontMapCollection()
          The Font Map Collection for Font Mapping.
 String getFormName()
          The printer page form.
 int getHalfTone(int halfTone)
          The Halftone DPI / LPI.
 int getImage()
          The Image setting (Positive or Negative) for the PostScript Driver.
 int getImageCompression()
          The Image Compression of the PostScript Driver.
 short getMarks()
          The PostScript Marks.
 short getOrientation()
          The printer page orientation (1 = portrait.
 String getPPDFile()
          The PPD (PostScript Printer Description) file to be used.
 IEnvelope getPrintableBounds()
          The printers Printable Bounds - Used for Marks.
 int getPSLanguageLevel()
          The PostScript Driver Language Level.
 boolean isArcPressSeparateImage()
          Indicates whether a separate Image file should be created for ArcPress.
 boolean isArcPressSeparateImageRotate()
          Indicates whether the Image should be rotated 90 degress for ArcPress.
 boolean isOneBitImageTransparency()
          Indicates if the 1-bit Image Transparency setting for the PostScript Driver is set to true.
 boolean isUseEMFFrameBoxForPSBoundingBox()
          Indicates whether the PostScript Driver should use the ENHMETAHEADER rclFrame instead of rclBounds for the PostScript Bounding Box.
 void setArcPressSeparateImage(boolean sepImage)
          Indicates whether a separate Image file should be created for ArcPress.
 void setArcPressSeparateImageRotate(boolean sepImage)
          Indicates whether the Image should be rotated 90 degress for ArcPress.
 void setCopies(short copies)
          The number of copies.
 void setEmulsion(int emulsion)
          The Emulsion setting for the PostScript Driver.
 void setFontMapCollectionByRef(IFontMapCollection fontMapCollection)
          The Font Map Collection for Font Mapping.
 void setFormName(String formName)
          The printer page form.
 void setHalfTone(int halfTone, int value)
          The Halftone DPI / LPI.
 void setImage(int image)
          The Image setting (Positive or Negative) for the PostScript Driver.
 void setImageCompression(int imageCompression)
          The Image Compression of the PostScript Driver.
 void setMarks(short marks)
          The PostScript Marks.
 void setOneBitImageTransparency(boolean imageTransparency)
          Indicates if the 1-bit Image Transparency setting for the PostScript Driver is set to true.
 void setOrientation(short orientation)
          The printer page orientation (1 = portrait.
 void setPPDFile(String pPDFile)
          The PPD (PostScript Printer Description) file to be used.
 void setPrintableBounds(IEnvelope ppBounds)
          The printers Printable Bounds - Used for Marks.
 void setPSLanguageLevel(int pslevel)
          The PostScript Driver Language Level.
 void setStepProgressor(IStepProgressor rhs1)
          PostScript Driver will update a Progress Bar.
 void setUseEMFFrameBoxForPSBoundingBox(boolean useFrameBox)
          Indicates whether the PostScript Driver should use the ENHMETAHEADER rclFrame instead of rclBounds for the PostScript Bounding Box.
 

Method Detail

getCopies

short getCopies()
                throws IOException,
                       AutomationException
The number of copies.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setCopies

void setCopies(short copies)
               throws IOException,
                      AutomationException
The number of copies.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getImageCompression

int getImageCompression()
                        throws IOException,
                               AutomationException
The Image Compression of the PostScript Driver.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.output.esriPSDriverImageCompression constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setImageCompression

void setImageCompression(int imageCompression)
                         throws IOException,
                                AutomationException
The Image Compression of the PostScript Driver.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
imageCompression - A com.esri.arcgis.output.esriPSDriverImageCompression constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isArcPressSeparateImage

boolean isArcPressSeparateImage()
                                throws IOException,
                                       AutomationException
Indicates whether a separate Image file should be created for ArcPress.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setArcPressSeparateImage

void setArcPressSeparateImage(boolean sepImage)
                              throws IOException,
                                     AutomationException
Indicates whether a separate Image file should be created for ArcPress.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isArcPressSeparateImageRotate

boolean isArcPressSeparateImageRotate()
                                      throws IOException,
                                             AutomationException
Indicates whether the Image should be rotated 90 degress for ArcPress.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setArcPressSeparateImageRotate

void setArcPressSeparateImageRotate(boolean sepImage)
                                    throws IOException,
                                           AutomationException
Indicates whether the Image should be rotated 90 degress for ArcPress.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getFontMapCollection

IFontMapCollection getFontMapCollection()
                                        throws IOException,
                                               AutomationException
The Font Map Collection for Font Mapping.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setFontMapCollectionByRef

void setFontMapCollectionByRef(IFontMapCollection fontMapCollection)
                               throws IOException,
                                      AutomationException
The Font Map Collection for Font Mapping.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
fontMapCollection - A reference to a com.esri.arcgis.output.IFontMapCollection (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPPDFile

String getPPDFile()
                  throws IOException,
                         AutomationException
The PPD (PostScript Printer Description) file to be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setPPDFile

void setPPDFile(String pPDFile)
                throws IOException,
                       AutomationException
The PPD (PostScript Printer Description) file to be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getMarks

short getMarks()
               throws IOException,
                      AutomationException
The PostScript Marks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setMarks

void setMarks(short marks)
              throws IOException,
                     AutomationException
The PostScript Marks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getHalfTone

int getHalfTone(int halfTone)
                throws IOException,
                       AutomationException
The Halftone DPI / LPI.

Product Availability

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

Parameters:
halfTone - A com.esri.arcgis.output.esriPSDriverHalfTone constant (in)
Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHalfTone

void setHalfTone(int halfTone,
                 int value)
                 throws IOException,
                        AutomationException
The Halftone DPI / LPI.

Product Availability

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

Parameters:
halfTone - A com.esri.arcgis.output.esriPSDriverHalfTone constant (in)
value - The value (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFormName

String getFormName()
                   throws IOException,
                          AutomationException
The printer page form. Use Win32 DMPAPER_xxx constants.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setFormName

void setFormName(String formName)
                 throws IOException,
                        AutomationException
The printer page form. Use Win32 DMPAPER_xxx constants.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getPrintableBounds

IEnvelope getPrintableBounds()
                             throws IOException,
                                    AutomationException
The printers Printable Bounds - Used for Marks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setPrintableBounds

void setPrintableBounds(IEnvelope ppBounds)
                        throws IOException,
                               AutomationException
The printers Printable Bounds - Used for Marks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
ppBounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOrientation

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setOrientation

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getEmulsion

int getEmulsion()
                throws IOException,
                       AutomationException
The Emulsion setting for the PostScript Driver.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.output.esriPSDriverEmulsion constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEmulsion

void setEmulsion(int emulsion)
                 throws IOException,
                        AutomationException
The Emulsion setting for the PostScript Driver.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
emulsion - A com.esri.arcgis.output.esriPSDriverEmulsion constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getImage

int getImage()
             throws IOException,
                    AutomationException
The Image setting (Positive or Negative) for the PostScript Driver.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.output.esriPSDriverImage constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setImage

void setImage(int image)
              throws IOException,
                     AutomationException
The Image setting (Positive or Negative) for the PostScript Driver.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
image - A com.esri.arcgis.output.esriPSDriverImage constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isOneBitImageTransparency

boolean isOneBitImageTransparency()
                                  throws IOException,
                                         AutomationException
Indicates if the 1-bit Image Transparency setting for the PostScript Driver is set to true.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setOneBitImageTransparency

void setOneBitImageTransparency(boolean imageTransparency)
                                throws IOException,
                                       AutomationException
Indicates if the 1-bit Image Transparency setting for the PostScript Driver is set to true.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isUseEMFFrameBoxForPSBoundingBox

boolean isUseEMFFrameBoxForPSBoundingBox()
                                         throws IOException,
                                                AutomationException
Indicates whether the PostScript Driver should use the ENHMETAHEADER rclFrame instead of rclBounds for the PostScript Bounding Box.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setUseEMFFrameBoxForPSBoundingBox

void setUseEMFFrameBoxForPSBoundingBox(boolean useFrameBox)
                                       throws IOException,
                                              AutomationException
Indicates whether the PostScript Driver should use the ENHMETAHEADER rclFrame instead of rclBounds for the PostScript Bounding Box.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getPSLanguageLevel

int getPSLanguageLevel()
                       throws IOException,
                              AutomationException
The PostScript Driver Language Level.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.output.esriPSDriverPSLanguageLevel constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPSLanguageLevel

void setPSLanguageLevel(int pslevel)
                        throws IOException,
                               AutomationException
The PostScript Driver Language Level.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pslevel - A com.esri.arcgis.output.esriPSDriverPSLanguageLevel constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStepProgressor

void setStepProgressor(IStepProgressor rhs1)
                       throws IOException,
                              AutomationException
PostScript Driver will update a Progress Bar.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
rhs1 - A reference to a com.esri.arcgis.system.IStepProgressor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createPS

void createPS(String inputFileName,
              String outputFileName)
              throws IOException,
                     AutomationException
Converts the EMF file to a EPS File.

Remarks

CreatePS takes an EMF file as input and outputs a PostScript file.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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