com.esri.arcgis.carto
Interface IExportInfoGenerator

All Superinterfaces:

Serializable

All Known Implementing Classes:

ExportInfoGenerator

public interface IExportInfoGenerator
extends Serializable

Provides access to members that help generate export information.

Product Availability

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

Method Summary

void	beginGroup(IDisplay pDisplay, String comment) Generates export information that a group is starting to draw.
void	beginLayer(IDisplay pDisplay, String comment) Generates export information that a layer is starting to draw.
void	beginLayerWithName(IDisplay pDisplay, ILayer pLayer) Generates export information that a layer is starting to draw.
void	beginLayerWithNameAndPhase(IDisplay pDisplay, ILayer pLayer, int viewDrawPhase) Generates export information that a layer is starting to draw.
void	beginMap(IDisplay pDisplay, int hDC, IMap pMap) Generates export information that a map is starting to draw.
void	beginPageLayout(int hDC, int focusMap) Generates export information that a page layout is starting to draw.
void	beginText(IDisplay pDisplay, int type, int kerning, double tracking, double widthScale, double wordSpace, double lineLeading, String text) Generates export information about text that is starting to draw.
void	endGroup(IDisplay pDisplay) Generates export information that a group finished to draw.
void	endLayer(IDisplay pDisplay) Generates export information that a layer finished to draw.
void	endMap(int hDC) Generates export information that a map finished to draw.
void	endPageLayout(int hDC) Generates export information that a page layout finished to draw.
void	endText(IDisplay pDisplay) Generates export information that a started text has ended.
void	setCmykColor(IDisplay pDisplay, int cmykColor, boolean spotColor, int colorType) Generates export information for a CMYK-color.

Method Detail

beginText

void beginText(IDisplay pDisplay,
               int type,
               int kerning,
               double tracking,
               double widthScale,
               double wordSpace,
               double lineLeading,
               String text)
               throws IOException,
                      AutomationException

Generates export information about text that is starting to draw.

Product Availability

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

Parameters:

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

type - The type (in)

kerning - The kerning (in)

tracking - The tracking (in)

widthScale - The widthScale (in)

wordSpace - The wordSpace (in)

lineLeading - The lineLeading (in)

text - The text (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

endText

void endText(IDisplay pDisplay)
             throws IOException,
                    AutomationException

Generates export information that a started text has ended.

Product Availability

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

Parameters:

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCmykColor

void setCmykColor(IDisplay pDisplay,
                  int cmykColor,
                  boolean spotColor,
                  int colorType)
                  throws IOException,
                         AutomationException

Generates export information for a CMYK-color.

Product Availability

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

Parameters:

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

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

spotColor - The spotColor (in)

colorType - The colorType (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

beginLayer

void beginLayer(IDisplay pDisplay,
                String comment)
                throws IOException,
                       AutomationException

Generates export information that a layer is starting to draw. Adds the comment to the information.

Product Availability

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

Parameters:

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

comment - The comment (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

beginLayerWithName

void beginLayerWithName(IDisplay pDisplay,
                        ILayer pLayer)
                        throws IOException,
                               AutomationException

Generates export information that a layer is starting to draw. Adds the layer name to the information.

Product Availability

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

Parameters:

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

beginLayerWithNameAndPhase

void beginLayerWithNameAndPhase(IDisplay pDisplay,
                                ILayer pLayer,
                                int viewDrawPhase)
                                throws IOException,
                                       AutomationException

Generates export information that a layer is starting to draw. Adds the layer name and draw phase to the information.

Product Availability

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

Parameters:

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

viewDrawPhase - A com.esri.arcgis.carto.esriViewDrawPhase constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

endLayer

void endLayer(IDisplay pDisplay)
              throws IOException,
                     AutomationException

Generates export information that a layer finished to draw.

Product Availability

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

Parameters:

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

beginGroup

void beginGroup(IDisplay pDisplay,
                String comment)
                throws IOException,
                       AutomationException

Generates export information that a group is starting to draw.

Product Availability

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

Parameters:

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

comment - The comment (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

endGroup

void endGroup(IDisplay pDisplay)
              throws IOException,
                     AutomationException

Generates export information that a group finished to draw.

Product Availability

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

Parameters:

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

beginMap

void beginMap(IDisplay pDisplay,
              int hDC,
              IMap pMap)
              throws IOException,
                     AutomationException

Generates export information that a map is starting to draw.

Product Availability

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

Parameters:

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

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

pMap - A reference to a com.esri.arcgis.carto.IMap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

endMap

void endMap(int hDC)
            throws IOException,
                   AutomationException

Generates export information that a map finished to draw.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

beginPageLayout

void beginPageLayout(int hDC,
                     int focusMap)
                     throws IOException,
                            AutomationException

Generates export information that a page layout is starting to draw.

Product Availability

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

Parameters:

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

focusMap - The focusMap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

endPageLayout

void endPageLayout(int hDC)
                   throws IOException,
                          AutomationException

Generates export information that a page layout finished to draw.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.