com.esri.arcgis.carto
Interface IAnnotationLayerFactory

All Superinterfaces:

Serializable

All Known Implementing Classes:

FDOGraphicsLayerFactory

public interface IAnnotationLayerFactory
extends Serializable

Provides access to members that create/find annotation layers.

Product Availability

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

Method Summary

IAnnotationLayer	createAnnotationLayer(IFeatureWorkspace workspace, IFeatureDataset featureDataset, String annotationClassName, IGeometryDef pGeometryDef, IFeatureClass pAssociatedFeatureClass, IAnnotateLayerPropertiesCollection annoLayerProps, IGraphicsLayerScale referenceScale, ISymbolCollection symbolCollection, boolean autoCreate, boolean updateOnShapeChange, boolean requireSymbolID, boolean allowSymbolOverrides, IOverposterProperties overposterProperties, String configKeyword) Creates a new annotation feature class and returns a layer for it.
IEnumBSTR	findAnnotationFeatureClassNames(IFeatureWorkspace workspace) Returns the names of existing annotation feature classes.
IAnnotationLayer	openAnnotationLayer(IFeatureWorkspace workspace, IFeatureDataset featureDataset, String annotationClassName) Opens an annotation feature class and returns a layer for it.

Method Detail

createAnnotationLayer

IAnnotationLayer createAnnotationLayer(IFeatureWorkspace workspace,
                                       IFeatureDataset featureDataset,
                                       String annotationClassName,
                                       IGeometryDef pGeometryDef,
                                       IFeatureClass pAssociatedFeatureClass,
                                       IAnnotateLayerPropertiesCollection annoLayerProps,
                                       IGraphicsLayerScale referenceScale,
                                       ISymbolCollection symbolCollection,
                                       boolean autoCreate,
                                       boolean updateOnShapeChange,
                                       boolean requireSymbolID,
                                       boolean allowSymbolOverrides,
                                       IOverposterProperties overposterProperties,
                                       String configKeyword)
                                       throws IOException,
                                              AutomationException

Creates a new annotation feature class and returns a layer for it.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

workspace - A reference to a com.esri.arcgis.geodatabase.IFeatureWorkspace (in)

featureDataset - A reference to a com.esri.arcgis.geodatabase.IFeatureDataset (in)

annotationClassName - The annotationClassName (in)

pGeometryDef - A reference to a com.esri.arcgis.geodatabase.IGeometryDef (in)

pAssociatedFeatureClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

annoLayerProps - A reference to a com.esri.arcgis.carto.IAnnotateLayerPropertiesCollection (in)

referenceScale - A reference to a com.esri.arcgis.carto.IGraphicsLayerScale (in)

symbolCollection - A reference to a com.esri.arcgis.display.ISymbolCollection (in)

autoCreate - The autoCreate (in)

updateOnShapeChange - The updateOnShapeChange (in)

requireSymbolID - The requireSymbolID (in)

allowSymbolOverrides - The allowSymbolOverrides (in)

overposterProperties - A reference to a com.esri.arcgis.carto.IOverposterProperties (in)

configKeyword - The configKeyword (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openAnnotationLayer

IAnnotationLayer openAnnotationLayer(IFeatureWorkspace workspace,
                                     IFeatureDataset featureDataset,
                                     String annotationClassName)
                                     throws IOException,
                                            AutomationException

Opens an annotation feature class and returns a layer for it.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

workspace - A reference to a com.esri.arcgis.geodatabase.IFeatureWorkspace (in)

featureDataset - A reference to a com.esri.arcgis.geodatabase.IFeatureDataset (in)

annotationClassName - The annotationClassName (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findAnnotationFeatureClassNames

IEnumBSTR findAnnotationFeatureClassNames(IFeatureWorkspace workspace)
                                          throws IOException,
                                                 AutomationException

Returns the names of existing annotation feature classes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

workspace - A reference to a com.esri.arcgis.geodatabase.IFeatureWorkspace (in)

Returns:

A reference to a com.esri.arcgis.system.IEnumBSTR

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.