com.esri.arcgis.cartoUI
Interface IAVObjectConverter

All Superinterfaces:

Serializable

All Known Implementing Classes:

AVObjectConverter

public interface IAVObjectConverter
extends Serializable

Provides access to members that control the ArcView (3.x) object converter.

Product Availability

Available with ArcGIS Desktop.

Method Summary

IMap	connectToView(IAVObject viewObject) Returns the map associated with an AV view object.
IEnvelope	convertBounds(IAVObject rectObject, double xOrigin, double yOrigin) Converts an AV rectangle (or MapDpy) object to an envelope.
IColor	convertColor(IAVObject colorObject) Converts an AV color object.
IElement	convertElement(IAVObject graphicObject, double xOrigin, double yOrigin, short pass, IGraphicsContainer gContainer) Converts an AV graphic object into an element.
Font	convertFont(IAVObject fontObject) Converts an AV font object.
IGeometry	convertGeometry(IAVObject shapeObject, double xOrigin, double yOrigin) Converts an AV shape object to a geometry object.
IFeatureRenderer	convertLegend(IAVObject legendObject) Returns a Renderer from an ArcView legend object.
ISpatialReference	convertProjection(IAVObject projectionObj) Converts an AV projection object to a spatial reference object.
ISymbol	convertSymbol(IAVObject symbolObj) Returns a symbol from an ArcView symbol object.
IMap	getMap(int index) The converted map at the given index.
int	getMapCount() The number of maps converted.
void	importLayout(String layoutName, IPageLayout pLayout) Imports a layout from an APR file.
void	importView(String viewName, IMap pMap) Imports a view from an APR file.
IAVObject	nextObject() Returns the next object in the project.
IFeatureClass	queryFeatureClass(IAVObject fThemeObject) Returns a feature class with the same properties as the input feature theme object.
IAVObject	queryObjectByID(int objID) Returns the object specified by the given object id.
IAVObject	queryObjectProperty(IAVObject obj, String propertyName) Returns the named property object associated with the given object.
void	readObjects(String filePath) Reads an ArcView 3.x ODL file.
void	reset() Resets the enumerator.
void	setFeatureSymbology(IAVObject themeObject, IFeatureLayer flayer) Sets the layer symbology for a given feature layer, based on a feature theme's legend.

Method Detail

readObjects

void readObjects(String filePath)
                 throws IOException,
                        AutomationException

Reads an ArcView 3.x ODL file.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

filePath - The filePath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

nextObject

IAVObject nextObject()
                     throws IOException,
                            AutomationException

Returns the next object in the project.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.cartoUI.IAVObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

void reset()
           throws IOException,
                  AutomationException

Resets the enumerator.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

importView

void importView(String viewName,
                IMap pMap)
                throws IOException,
                       AutomationException

Imports a view from an APR file.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

viewName - The viewName (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.

importLayout

void importLayout(String layoutName,
                  IPageLayout pLayout)
                  throws IOException,
                         AutomationException

Imports a layout from an APR file.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

layoutName - The layoutName (in)

pLayout - A reference to a com.esri.arcgis.carto.IPageLayout (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryObjectProperty

IAVObject queryObjectProperty(IAVObject obj,
                              String propertyName)
                              throws IOException,
                                     AutomationException

Returns the named property object associated with the given object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

obj - A reference to a com.esri.arcgis.cartoUI.IAVObject (in)

propertyName - The propertyName (in)

Returns:

A reference to a com.esri.arcgis.cartoUI.IAVObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryObjectByID

IAVObject queryObjectByID(int objID)
                          throws IOException,
                                 AutomationException

Returns the object specified by the given object id.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

objID - The objID (in)

Returns:

A reference to a com.esri.arcgis.cartoUI.IAVObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryFeatureClass

IFeatureClass queryFeatureClass(IAVObject fThemeObject)
                                throws IOException,
                                       AutomationException

Returns a feature class with the same properties as the input feature theme object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

fThemeObject - A reference to a com.esri.arcgis.cartoUI.IAVObject (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IFeatureClass

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFeatureSymbology

void setFeatureSymbology(IAVObject themeObject,
                         IFeatureLayer flayer)
                         throws IOException,
                                AutomationException

Sets the layer symbology for a given feature layer, based on a feature theme's legend.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

themeObject - A reference to a com.esri.arcgis.cartoUI.IAVObject (in)

flayer - A reference to a com.esri.arcgis.carto.IFeatureLayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertLegend

IFeatureRenderer convertLegend(IAVObject legendObject)
                               throws IOException,
                                      AutomationException

Returns a Renderer from an ArcView legend object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

legendObject - A reference to a com.esri.arcgis.cartoUI.IAVObject (in)

Returns:

A reference to a com.esri.arcgis.carto.IFeatureRenderer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertSymbol

ISymbol convertSymbol(IAVObject symbolObj)
                      throws IOException,
                             AutomationException

Returns a symbol from an ArcView symbol object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

symbolObj - A reference to a com.esri.arcgis.cartoUI.IAVObject (in)

Returns:

A reference to a com.esri.arcgis.display.ISymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertColor

IColor convertColor(IAVObject colorObject)
                    throws IOException,
                           AutomationException

Converts an AV color object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

colorObject - A reference to a com.esri.arcgis.cartoUI.IAVObject (in)

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertFont

Font convertFont(IAVObject fontObject)
                 throws IOException,
                        AutomationException

Converts an AV font object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

fontObject - A reference to a com.esri.arcgis.cartoUI.IAVObject (in)

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertElement

IElement convertElement(IAVObject graphicObject,
                        double xOrigin,
                        double yOrigin,
                        short pass,
                        IGraphicsContainer gContainer)
                        throws IOException,
                               AutomationException

Converts an AV graphic object into an element. All elements except MapSurrounds are converted when 'pass' is 0. Only MapSurrounds are converted when 'pass' is 1.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

graphicObject - A reference to a com.esri.arcgis.cartoUI.IAVObject (in)

xOrigin - The xOrigin (in)

yOrigin - The yOrigin (in)

pass - The pass (in)

gContainer - A reference to a com.esri.arcgis.carto.IGraphicsContainer (in)

Returns:

A reference to a com.esri.arcgis.carto.IElement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertBounds

IEnvelope convertBounds(IAVObject rectObject,
                        double xOrigin,
                        double yOrigin)
                        throws IOException,
                               AutomationException

Converts an AV rectangle (or MapDpy) object to an envelope.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

rectObject - A reference to a com.esri.arcgis.cartoUI.IAVObject (in)

xOrigin - The xOrigin (in)

yOrigin - The yOrigin (in)

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.

convertGeometry

IGeometry convertGeometry(IAVObject shapeObject,
                          double xOrigin,
                          double yOrigin)
                          throws IOException,
                                 AutomationException

Converts an AV shape object to a geometry object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

shapeObject - A reference to a com.esri.arcgis.cartoUI.IAVObject (in)

xOrigin - The xOrigin (in)

yOrigin - The yOrigin (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.

convertProjection

ISpatialReference convertProjection(IAVObject projectionObj)
                                    throws IOException,
                                           AutomationException

Converts an AV projection object to a spatial reference object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

projectionObj - A reference to a com.esri.arcgis.cartoUI.IAVObject (in)

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

connectToView

IMap connectToView(IAVObject viewObject)
                   throws IOException,
                          AutomationException

Returns the map associated with an AV view object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

viewObject - A reference to a com.esri.arcgis.cartoUI.IAVObject (in)

Returns:

A reference to a com.esri.arcgis.carto.IMap

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapCount

int getMapCount()
                throws IOException,
                       AutomationException

The number of maps converted.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMap

IMap getMap(int index)
            throws IOException,
                   AutomationException

The converted map at the given index.

Product Availability

Available with ArcGIS Desktop.

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.carto.IMap

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.