com.esri.arcgis.display
Interface IOutputContext

All Superinterfaces:
Serializable
All Known Implementing Classes:
OutputContext

public interface IOutputContext
extends Serializable

Provides access to members that allow to manage the geometry transformation from the map context to the ouput device.

Remarks

OutputContext is used to trasform geometries from Map reference frame to Output reference frame. Use IMapContext to convert all geometries from geographic units to map units before passing them to the OutputContext for display/printing.

Product Availability

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


Method Summary
 IGeometry fromMapToOutput(IGeometry ingeom)
          Converts map geometry to output geometry.
 int getHDC()
          The device context that the display is currently drawing to.
 ITrackCancel getTrackCancel()
          Drawing will react on Cancel of ITrackCancel is not NULL.
 void init(double refScale, double currentScale, double resolution, double rotation, IPoint currentScreenCenter, tagRECT deviceRect, int outputDevice)
          Initializes the output context.
 void setTrackCancel(ITrackCancel trackCancel)
          Drawing will react on Cancel of ITrackCancel is not NULL.
 

Method Detail

init

void init(double refScale,
          double currentScale,
          double resolution,
          double rotation,
          IPoint currentScreenCenter,
          tagRECT deviceRect,
          int outputDevice)
          throws IOException,
                 AutomationException
Initializes the output context.

Remarks

CurrentScreenCenter must be in Map reference frame.

Product Availability

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

Parameters:
refScale - The refScale (in)
currentScale - The currentScale (in)
resolution - The resolution (in)
rotation - The rotation (in)
currentScreenCenter - A reference to a com.esri.arcgis.geometry.IPoint (in)
deviceRect - A Structure: com.esri.arcgis.system.tagRECT (in)
outputDevice - The outputDevice (A COM typedef) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

fromMapToOutput

IGeometry fromMapToOutput(IGeometry ingeom)
                          throws IOException,
                                 AutomationException
Converts map geometry to output geometry.

Product Availability

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

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

setTrackCancel

void setTrackCancel(ITrackCancel trackCancel)
                    throws IOException,
                           AutomationException
Drawing will react on Cancel of ITrackCancel is not NULL.

Product Availability

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

Parameters:
trackCancel - 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.

getTrackCancel

ITrackCancel getTrackCancel()
                            throws IOException,
                                   AutomationException
Drawing will react on Cancel of ITrackCancel is not NULL.

Product Availability

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

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

getHDC

int getHDC()
           throws IOException,
                  AutomationException
The device context that the display is currently drawing to.

Remarks

Initialize OutputContext before accessing this property.

Product Availability

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

Returns:
The hDC (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.