com.esri.arcgis.carto
Interface IConvertLabelsToAnnotation

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ConvertLabelsToAnnotation, IConvertLabelsToAnnotationProxy

public interface IConvertLabelsToAnnotation
extends java.io.Serializable

COM Interface 'IConvertLabelsToAnnotation'. Generated 3/19/2015 1:20:52 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to the properties that control the conversion of labels to annotation.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID0ae13bc3_f821_4ae4_8b20_1ece97f78874
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addFeatureLayer(IFeatureLayer pFeatureLayer, java.lang.String annoLayerName, IFeatureWorkspace pFeatureWorkspace, IFeatureDataset pFeatureDataset, boolean featureLinked, boolean appendMode, boolean requireSymbolID, boolean autoCreate, boolean autoUpdate, java.lang.String configKeyword) Call this method for each feature layer be converted to annotation.
void	convertLabels() Convert labels to annotation.
IEnumLayer	getAnnoLayers() New database annotation layers created by the conversion process.
java.lang.String	getErrorInfo() Error information generated by the conversion process.
void	initialize(IMap pMap, int storageType, int whichFeatures, boolean generateUnplacedAnnotation, ITrackCancel pTrackCancel, IAnnotationErrorEvents pAnnotationErrorEvents) Call this method first to initialize the converter.

Field Detail

IID0ae13bc3_f821_4ae4_8b20_1ece97f78874

static final int IID0ae13bc3_f821_4ae4_8b20_1ece97f78874

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

initialize

void initialize(IMap pMap,
                int storageType,
                int whichFeatures,
                boolean generateUnplacedAnnotation,
                ITrackCancel pTrackCancel,
                IAnnotationErrorEvents pAnnotationErrorEvents)
                throws java.io.IOException,
                       AutomationException

Call this method first to initialize the converter.

Parameters:

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

storageType - A com.esri.arcgis.carto.esriAnnotationStorageType constant (in)

whichFeatures - A com.esri.arcgis.carto.esriLabelWhichFeatures constant (in)

generateUnplacedAnnotation - The generateUnplacedAnnotation (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

pAnnotationErrorEvents - A reference to a com.esri.arcgis.carto.IAnnotationErrorEvents (in, optional, pass 0 if not required)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addFeatureLayer

void addFeatureLayer(IFeatureLayer pFeatureLayer,
                     java.lang.String annoLayerName,
                     IFeatureWorkspace pFeatureWorkspace,
                     IFeatureDataset pFeatureDataset,
                     boolean featureLinked,
                     boolean appendMode,
                     boolean requireSymbolID,
                     boolean autoCreate,
                     boolean autoUpdate,
                     java.lang.String configKeyword)
                     throws java.io.IOException,
                            AutomationException

Call this method for each feature layer be converted to annotation.

Parameters:

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

annoLayerName - The annoLayerName (in)

pFeatureWorkspace - A reference to a com.esri.arcgis.geodatabase.IFeatureWorkspace (in, optional, pass 0 if not required)

pFeatureDataset - A reference to a com.esri.arcgis.geodatabase.IFeatureDataset (in, optional, pass 0 if not required)

featureLinked - The featureLinked (in, optional, pass false if not required)

appendMode - The appendMode (in, optional, pass false if not required)

requireSymbolID - The requireSymbolID (in, optional, pass false if not required)

autoCreate - The autoCreate (in, optional, pass false if not required)

autoUpdate - The autoUpdate (in, optional, pass false if not required)

configKeyword - The configKeyword (in, optional, pass if not required)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertLabels

void convertLabels()
                   throws java.io.IOException,
                          AutomationException

Convert labels to annotation.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAnnoLayers

IEnumLayer getAnnoLayers()
                         throws java.io.IOException,
                                AutomationException

New database annotation layers created by the conversion process.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getErrorInfo

java.lang.String getErrorInfo()
                              throws java.io.IOException,
                                     AutomationException

Error information generated by the conversion process.

Returns:

The info

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.