CadAnnotationLayer (ArcObjects Java API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.carto
Class CadAnnotationLayer

java.lang.Object
  com.esri.arcgis.carto.CadAnnotationLayer

All Implemented Interfaces:: IAttributeTable, IBarrierProperties, IBarrierProperties2, ICoverageAnnotationLayer, ICoverageAnnotationLayer2, ICoverageAnnotationLayerWrite, ICoverageAnnotationSel, IDataLayer, IDataLayer2, IDisplayRelationshipClass, IDisplayString, IDisplayTable, IDrawAnnotationGeometry, IFeatureLayer, IFeatureLayer2, IFeatureLayerDefinition, IFeatureLayerDefinition2, IFeatureSelection, IFind, IGeoReference, IHotlinkContainer, IHotlinkExpression, IHotlinkMacro, IHTMLPopupIdentify, IHTMLPopupIdentify2, IHTMLPopupInfo, IHTMLPopupInfo2, IHyperlinkContainer, IIdentify, IIdentify2, IIdentifyDisplay, IInteractiveSearch, ILayer, ILayer2, ILayerDrawingPhase, ILayerDrawingProperties, ILayerEffects, ILayerExtensions, ILayerFields, ILayerGeneralProperties, ILayerInfo, ILayerPosition, ILayerSymbologyExtents, IOrderedLayerFields, IPublishLayer, IRelationshipClassCollection, IRelationshipClassCollectionEdit, ISecureLayer, ITableDefinition, ITableSelection, ITemporaryLayer, ICadDrawingLayers, ICadTransformations, IConnectionPointContainer, IDisplayAdmin, IDisplayFilterManager, IMapLevel, IClass, IDataset, IGeoDataset, IObjectClassSchemaEvents, ITable, ITableCapabilities, ITableFields, IWorkspaceEvents, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IPropertySupport, Externalizable, Serializable, EventListener

public class CadAnnotationLayer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ICoverageAnnotationLayer, ICoverageAnnotationLayer2, ICoverageAnnotationLayerWrite, ICoverageAnnotationSel, ICadDrawingLayers, ICadTransformations, ILayer, ILayer2, IFeatureLayer, IFeatureLayer2, IFeatureLayerDefinition, IFeatureLayerDefinition2, IFeatureSelection, ILayerFields, ITableFields, IGeoDataset, IBarrierProperties, IBarrierProperties2, IPersistStream, IPersist, ILayerInfo, IDataLayer, IDataLayer2, IAttributeTable, IFind, IHotlinkContainer, IHotlinkMacro, IHotlinkExpression, IHyperlinkContainer, IIdentify, IIdentify2, IInteractiveSearch, IPublishLayer, ILayerDrawingPhase, ILayerDrawingProperties, ILayerEffects, ILayerExtensions, ILayerPosition, ILayerSymbologyExtents, ILayerGeneralProperties, IDrawAnnotationGeometry, IHTMLPopupInfo, IHTMLPopupInfo2, IHTMLPopupIdentify, IHTMLPopupIdentify2, IDisplayRelationshipClass, IDisplayTable, IGeoReference, IRelationshipClassCollection, IRelationshipClassCollectionEdit, ISecureLayer, ITableDefinition, ITableSelection, ITemporaryLayer, IDisplayAdmin, IDisplayFilterManager, IMapLevel, IClass, IDataset, IObjectClassSchemaEvents, ITable, ITableCapabilities, IPropertySupport, IConnectionPointContainer, IDisplayString, IIdentifyDisplay, IOrderedLayerFields, IWorkspaceEvents, Externalizable
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ICoverageAnnotationLayer, ICoverageAnnotationLayer2, ICoverageAnnotationLayerWrite, ICoverageAnnotationSel, ICadDrawingLayers, ICadTransformations, ILayer, ILayer2, IFeatureLayer, IFeatureLayer2, IFeatureLayerDefinition, IFeatureLayerDefinition2, IFeatureSelection, ILayerFields, ITableFields, IGeoDataset, IBarrierProperties, IBarrierProperties2, IPersistStream, IPersist, ILayerInfo, IDataLayer, IDataLayer2, IAttributeTable, IFind, IHotlinkContainer, IHotlinkMacro, IHotlinkExpression, IHyperlinkContainer, IIdentify, IIdentify2, IInteractiveSearch, IPublishLayer, ILayerDrawingPhase, ILayerDrawingProperties, ILayerEffects, ILayerExtensions, ILayerPosition, ILayerSymbologyExtents, ILayerGeneralProperties, IDrawAnnotationGeometry, IHTMLPopupInfo, IHTMLPopupInfo2, IHTMLPopupIdentify, IHTMLPopupIdentify2, IDisplayRelationshipClass, IDisplayTable, IGeoReference, IRelationshipClassCollection, IRelationshipClassCollectionEdit, ISecureLayer, ITableDefinition, ITableSelection, ITemporaryLayer, IDisplayAdmin, IDisplayFilterManager, IMapLevel, IClass, IDataset, IObjectClassSchemaEvents, ITable, ITableCapabilities, IPropertySupport, IConnectionPointContainer, IDisplayString, IIdentifyDisplay, IOrderedLayerFields, IWorkspaceEvents, Externalizable

An ESRI Cad annotation layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:: Serialized Form

Constructor Summary
`CadAnnotationLayer()` Constructs a CadAnnotationLayer using ArcGIS Engine.
`CadAnnotationLayer(Object obj)` Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. `CadAnnotationLayer theCadAnnotationLayer = (CadAnnotationLayer) obj;`

Method Summary
`void`	`add(IFeature feature)` Adds a feature to the selection set.
`void`	`addExtension(Object ext)` Adds a new extension.
`void`	`addField(IField field)` Adds a field to this object class.
`void`	`addHyperlink(IHyperlink link)` Adds a hyperlink.
`void`	`addIndex(IIndex index)` Adds an index to this object class.
`void`	`addRelationshipClass(IRelationshipClass relationshipClass)` Adds the specified memory relationship class to a standalone table or layer.
`void`	`addRow(IRow row)` Adds a row to the selection set (honoring the current combination method).
`boolean`	`applies(Object pUnk)` Indicates if the receiver can apply the given object at any given time.
`Object`	`apply(Object newObject)` Applies the given property to the receiver and returns the old object.
`void`	`beginAddElements(IDisplay pDisplay)` Begins a batch process for adding elements to a annotation layer.
`boolean`	`canApply(Object pUnk)` Indicates if the receiver can apply the given object at that particular moment.
`boolean`	`canCopy()` True if this dataset can be copied.
`boolean`	`canDelete()` True if this dataset can be deleted.
`boolean`	`canRename()` True if this dataset can be renamed.
`void`	`clear()` Clears the selection.
`void`	`clearPassword(boolean bForceReconnect)` Removes the passwords from the layer used to access data, and forces a reconnection to the data.
`void`	`clearSymbols()` Erases all symbols and levels.
`boolean`	`connect(IName pOptRepairName)` Connects the layer to its data source.
`IDataset`	`copy(String copyName, IWorkspace copyWorkspace)` Copies this dataset to a new dataset with the specified name.
`IRow`	`createRow()` Creates a row in the database with a system assigned object ID and null property values.
`IRowBuffer`	`createRowBuffer()` Creates a row buffer that can be used with an insert cursor.
`IFeatureLayer`	`createSelectionLayer(String layerName, boolean useCurrentSelection, String joinTableNames, String expression)` Creates a new feature layer from the existing layer based on the current selection and the specified query expression.
`void`	`delete()` Deletes this dataset.
`void`	`deleteField(IField field)` Deletes a field from this object class.
`void`	`deleteIndex(IIndex index)` Deletes an index from this object class.
`void`	`deleteSearchedRows(IQueryFilter queryFilter)` Delete the Rows in the database selected by the specified query.
`void`	`disconnect()` Disconnects the data from the layer.
`void`	`displayRelationshipClass(IRelationshipClass relClass, int joinType)` Sets a join based on the specified relationship class and join type.
`void`	`doAddFeature(IFeature pFeature, IElement pElement)` Adds a feature and its corresponding element to a annotation layer.
`void`	`draw(int drawPhase, IDisplay display, ITrackCancel trackCancel)` Draws the layer to the specified display for the given draw phase.
`void`	`endAddElements()` Ends the batch process for adding elements to a annotation layer.
`void`	`enumConnectionPoints(IEnumConnectionPoints[] ppEnum)` enumConnectionPoints
`boolean`	`equals(Object o)` Compare this object with another
`String`	`executeExpression(IObject pObject)` Finds the hyperlink for the given feature based on the current expression properties.
`void`	`expandRegionForSymbols(IDisplay display, IGeometry region)` Expands the given geometry by an amount that will include the layer's symbology for the given display.
`IArray`	`find(String search, boolean contains, Object fields, ITrackCancel trackCancel)` Finds the specified search string in the given attribute fields.
`void`	`findConnectionPoint(GUID riid, IConnectionPoint[] ppCP)` findConnectionPoint
`String`	`findDisplayString(IObject pObject)` Finds the display string for the given feature based on the current expression properties.
`int`	`findField(String fieldName)` Returns the index of the field with the specified name.
`IEnumRelationshipClass`	`findRelationshipClasses(IObjectClass objectClass, int role)` Finds all relationship classes in the collection that reference the given object class in the specified role.
`void`	`flip()` Flip operation of layer.
`IEnumElement`	`generateGraphics(IEnvelope box, IDisplay display)` Generates graphic elements from the annotation features.
`IEnumElement`	`generateGraphics(IEnvelope box, IDisplay display, boolean useGroupSymbolElement)` Generates graphic elements from the annotation features.
`IEnvelope`	`getAreaOfInterest()` The default area of interest for the layer.
`ILineSymbol`	`getArrowSymbol()` The line symbol for the arrow.
`ITable`	`getAttributeTable()` The attribute table.
`void`	`getBarriers(IDisplay display, IGeometryCollection pBarriers, IEnvelope extent)` List of barriers within the specified extent, or all barriers if no extent given.
`short`	`getBrightness()` Layer brightness in percent (-100 - 100).
`String`	`getBrowseName()` The browse name of the dataset.
`double`	`getBufferDistance()` Buffer distance used for the selection.
`String`	`getCategory()` The category of the dataset.
`void`	`getClassID(GUID[] pClassID)` getClassID
`static String`	`getClsid()` getClsid.
`IUID`	`getCLSID()` The GUID for the COM Class (CoClass) corresponding to instances of this object class.
`int`	`getCombinationMethod()` Combination method for the selection.
`short`	`getContrast()` Layer contrast in percent (-100 - 100).
`Object`	`getCurrent(Object pUnk)` The object currently being used.
`String`	`getDataDetails(String bsPadding)` Details of the layer's data.
`IName`	`getDataSourceName()` Name of the data object for the layer.
`String`	`getDataSourceType()` Data source type.
`String`	`getDefinitionExpression()` Definition query expression for the existing layer.
`ISelectionSet`	`getDefinitionSelectionSet()` The selection set that defines the subset of features in a selection layer.
`String`	`getDisplayField()` Primary display field.
`IDisplayFilter`	`getDisplayFilter()` The display filter.
`ISelectionSet`	`getDisplaySelectionSet()` The selected set of rows from the display table.
`ITable`	`getDisplayTable()` The display table.
`ILineSymbol`	`getDrawGeometryLineSymbol()` The line symbol for drawing the geometry.
`IMarkerSymbol`	`getDrawGeometryMarkerSymbol()` The marker symbol for drawing the geometry.
`int`	`getDrawingLayerCount()` The number of layers in the CAD drawing.
`String`	`getDrawingLayerName(int index)` The name of the CAD drawing layer at the specified index.
`int`	`getDrawPhase()` Draw phase in which layer is drawn.
`IDisplayExpressionProperties`	`getExpressionProperties()` Properties that describe the display expression.
`IUID`	`getEXTCLSID()` The GUID for the COM Class (CoClass) corresponding to the class extension for this object class.
`Object`	`getExtension()` The extension for this object class.
`Object`	`getExtension(int index)` The extension at the specified index.
`int`	`getExtensionCount()` Number of extensions.
`IPropertySet`	`getExtensionProperties()` The extension properties for this object class.
`IEnvelope`	`getExtent()` The extent of the GeoDataset.
`IFeatureClass`	`getFeatureClass()` The layer's feature class.
`IField`	`getField(int index)` The field at the specified index.
`int`	`getFieldCount()` The number of fields.
`IFieldInfo`	`getFieldInfo(int index)` Extended field information for the field at the specified index.
`IFieldInfoSet`	`getFieldInfos()` The fields in order.
`IFields`	`getFields()` The fields collection for this object class.
`String`	`getFindDisplayField()` The display field.
`Object`	`getFindFields()` The attribute fields.
`Font`	`getFont(int symbolNumber)` The font for the specified symbol number.
`IColor`	`getFontColor(int symbolNumber)` The font color for the specified symbol number.
`void`	`getFromToTransform(_WKSPoint[] fromPoint1, _WKSPoint[] fromPoint2, _WKSPoint[] toPoint1, _WKSPoint[] toPoint2)` Returns the points of a two point transformation.
`IName`	`getFullName()` The associated name object.
`String`	`getHotlinkField()` Field used for hotlinks.
`int`	`getHotlinkType()` Hotlink type.
`String`	`getHTMLOutput(IFeature pFeature)` The content is the XML text for the input feature.
`int`	`getHTMLPresentationStyle()` Indicates the content formating style for the HTML Popup tool.
`String`	`getHTMLRedirectField()` Indicates the fieldname of the layer that contains the HTML redirect URL values.
`String`	`getHTMLRedirectFieldPrefix()` Indicates the text to precede the HTMLRedirectField value for the redirect URL.
`String`	`getHTMLRedirectFieldSuffix()` Indicates the text to follow the HTMLRedirectField value for the redirect URL.
`String`	`getHTMLXSLStylesheet()` Indicates the content of the XSL stylesheet to parse the feature attributes through.
`IHyperlink`	`getHyperlink(int index)` The hyperlink at the specified index.
`int`	`getHyperlinkCount()` Number of hyperlinks.
`IIndexes`	`getIndexes()` The indexes collection for this object class.
`int`	`getJoinType()` Join type for the most recent join performed.
`int`	`getLargeImage()` Large image that represents the layer.
`int`	`getLargeSelectedImage()` Large image that represents the layer when it is selected.
`double`	`getLastMaximumScale()` Last maximum scale setting used by layer.
`double`	`getLastMinimumScale()` Last minimum scale setting used by layer.
`double`	`getLayerWeight()` Default layer position.
`int`	`getLevelCount()` The number of levels in the layer.
`int`	`getLevelNumber(int index)` The level number at the specified index.
`String`	`getMacroName()` Name of macro used for the hotlink.
`int`	`getMapLevel()` Current map level for drawing multi-level symbols.
`double`	`getMaximumScale()` Maximum scale (representative fraction) at which the layer will display.
`double`	`getMinimumScale()` Minimum scale (representative fraction) at which the layer will display.
`String`	`getName()` Layer name.
`IElement`	`getNextGraphic()` Generates the next graphic element in the graphics generation loop.
`String`	`getOIDFieldName()` The name of the field corresponding to the OID.
`IPropertySet`	`getPropertySet()` The set of properties for the dataset.
`String`	`getPublishingDescription()` The layer description reported to the publisher.
`IRelationshipClass`	`getRelationshipClass()` The current relationship class used to display related fields.
`IEnumRelationshipClass`	`getRelationshipClasses()` The memory relationship classes.
`String`	`getRelativeBase()` Base path used when storing relative path names.
`IRow`	`getRow(int oID)` The row from the database with the specified object ID.
`ICursor`	`getRows(Object oids, boolean recycling)` The cursor of rows based on a set of object ids.
`int`	`getSearchOrder()` Flag that specifies the search order used when applying a mixed attribute-spatial query.
`IColor`	`getSelectionColor()` Selection color.
`ISelectionSet`	`getSelectionSet()` The selected set of features.
`ISymbol`	`getSelectionSymbol()` Selection symbol.
`int`	`getShapeType()` The layer's shape type.
`void`	`getSizeMax(_ULARGE_INTEGER[] pcbSize)` getSizeMax
`int`	`getSmallImage()` Small image that represents the layer.
`int`	`getSmallSelectedImage()` Small image that represents the layer when it is selected.
`ISpatialReference`	`getSpatialReference()` The spatial reference of the GeoDataset.
`IEnumDataset`	`getSubsets()` Datasets contained within this dataset.
`int`	`getSupportedDrawPhases()` Supported draw phases.
`int`	`getSymbolCount()` The number of symbols used by the layer.
`int`	`getSymbolNumber(int index)` The symbol number at the specified index.
`ITextSymbol`	`getTextSymbol(int symbolNumber)` The text symbol for the specified symbol number.
`String`	`getTipText(double x, double y, double tolerance)` Map tip text at the specified location.
`void`	`getTransformation(_WKSPoint[] from, _WKSPoint[] to, double[] angle, double[] scale)` Returns the rotation, scale, and translation of a transformation.
`int`	`getTransformMode()` The transformation type.
`short`	`getTransparency()` Layer transparency in percent (0-100).
`int`	`getType()` The type of the Dataset.
`int`	`getWeight()` Weight of the barriers in this layer.
`IWorkspace`	`getWorkspace()` The workspace containing this dataset.
`String`	`getWorldFileName()` The pathname of the world file.
`int`	`hashCode()` the hashcode for this object
`void`	`hTMLIdentify(IDisplay pDisplay, IGeometry pGeometry, IPropertySet pOptions, IStringArray[] ppItemNames, IStringArray[] ppItemHTML)` The content is the XML text at the specified point.
`String`	`hTMLIdentify(IPoint pPoint, double tolerance)` The content is the XML text at the specified point.
`String`	`hTMLOutput(IFeature pFeature, IPropertySet pOptions)` The content is the XML text for the input feature, pOptions is an optional parameter.
`String`	`hTMLTipText(IPoint pPoint, double tolerance)` The tooltip at the specified point.
`IArray`	`identify(IGeometry pGeom)` Identifies objects at the specified location.
`IArray`	`identify(IGeometry pGeom, ITrackCancel pTrackCancel)` Identifies objects at the specified location.
`IArray`	`identifyEx(IDisplay pDisplay, IGeometry pGeom, ITrackCancel pTrackCancel)` Identifies objects at the specified location for the given display.
`IHotLinkExpressionProperties`	`IHotlinkExpression_getExpressionProperties()` Properties that describe the hyperlink expression.
`String`	`ILayerGeneralProperties_getLayerDescription()` Description for the layer.
`ICursor`	`insert(boolean useBuffering)` Returns a cursor that can be used to insert new Rows.
`boolean`	`inWorkspace(IWorkspace workspace)` Returns TRUE if the layer is in the specified workspace.
`boolean`	`isCached()` Indicates if the layer needs its own display cache.
`boolean`	`isCanGeoRef()` Indicates if layer can be georeferenced.
`boolean`	`isCanSelect()` Indicates if the table supports selection.
`boolean`	`isDataSourceSupported(IName name)` Indicates if the specified data object name is supported by the layer.
`boolean`	`isDataValid()` Indicates if the data for the layer is currently valid.
`void`	`isDirty()` isDirty
`boolean`	`isDrawGeometry()` Indicates if the annotation geometry will draw.
`boolean`	`isDrawingLayerVisible(int index)` Indicates if the specified CAD drawing layer visible in the CAD layer in ArcMap.
`boolean`	`isDrawingPropsDirty()` Indicates if the layer drawing properties are dirty.
`boolean`	`isEnableTransformations()` Indicates if global transformations are enabled.
`boolean`	`isHasOID()` Indicates if the class has an object identity (OID) field.
`boolean`	`isHTMLDownloadAttachmentData()` Indicates that all data for attachments will be retrieved.
`boolean`	`isHTMLHideFieldNameColumn()` Indicates if Field name column will be output to the HTML Popup tool.
`boolean`	`isHTMLPopupEnabled()` Indicates if this layer currently responds to the HTML Popup tool.
`boolean`	`isHTMLUseCodedDomainValues()` Indicates whether to use coded values (rather than literal stored values) for feature values.
`boolean`	`isLevelVisibility(int levelNumber)` Indicates if the level at the specified level number is visible.
`boolean`	`isOriginalDrawingLayerVisible(int index)` Indicates if the specified CAD drawing layer visible in the CAD drawing itself.
`boolean`	`isScaleRangeReadOnly()` Indicates if the minimum and maximum scale range values are read-only.
`boolean`	`isScaleSymbols()` Indicates if symbols are scaled for the layer.
`boolean`	`isSelectable()` Indicates if layer is selectable.
`boolean`	`isSetSelectionSymbol()` Indicates if the selected set of features is drawn using the SelectionSymbol.
`boolean`	`isShowTips()` Indicates if the layer shows map tips.
`boolean`	`isSupportsBrightnessChange()` Indicates if the layer supports brightness changes.
`boolean`	`isSupportsContrastChange()` Indicates if the layer supports contrast changes.
`boolean`	`isSupportsInteractive()` Indicates if the layer supports interactive effects changes.
`boolean`	`isSupportsPublishing()` Indicates if the layer supports the publishing process.
`boolean`	`isSupportsTransparency()` Indicates if the layer supports transparency.
`boolean`	`isTemporary()` Indicates if the layer is a temporary layer.
`boolean`	`isUsesFilter()` Indicates if the current object draws using a filter.
`boolean`	`isValid()` Indicates if the layer is currently valid.
`boolean`	`isVisible()` Indicates if the layer is currently visible.
`ICursor`	`ITable_search(IQueryFilter queryFilter, boolean recycling)` An object cursor that can be used to fetch row objects selected by the specified query.
`void`	`load(IStream pstm)` load
`void`	`mirror()` Mirror operation of layer.
`void`	`nextFeatureAndGraphic(IFeature[] feature, IElement[] element)` Generates the next feature and graphic element in the graphics generation loop.
`void`	`nextSelectedFeatureAndGraphic(IFeature[] feature, IElement[] element)` Generates the next selected feature and graphic element in the graphics generation loop.
`void`	`onAddField(IObjectClassSchemaEventsOnAddFieldEvent theEvent)` This event is fired when a new field is added to the object class.
`void`	`onBehaviorChanged(IObjectClassSchemaEventsOnBehaviorChangedEvent theEvent)` This event is fired when the behavior class for the object class changes.
`void`	`onCreateDataset(IWorkspaceEventsOnCreateDatasetEvent theEvent)` This event is fired when a dataset is created.
`void`	`onDeleteDataset(IWorkspaceEventsOnDeleteDatasetEvent theEvent)` This event is fired when a dataset is deleted.
`void`	`onDeleteField(IObjectClassSchemaEventsOnDeleteFieldEvent theEvent)` This event is fired when a field is deleted from the object class.
`void`	`onRenameDataset(IWorkspaceEventsOnRenameDatasetEvent theEvent)` This event is fired when a dataset is renamed.
`IPointCollection`	`pointsTransform(IPointCollection inPoints, boolean isForward)` Transform operation of Raster.
`void`	`prepareForPublishing()` Prepare the layer for the publishing process.
`void`	`queryBarriers(IDisplay display, IGeometryCollection pBarriers, IEnvelope extent, ITrackCancel trackCancel)` List of barriers within the specified extent, or all barriers if no extent given.
`void`	`readExternal(ObjectInput in)`
`void`	`rectify(String fullpath, String format)` Save transformed result to a new dataset.
`void`	`register()` Save transformation parameters and tie-points.
`void`	`removeAllRelationshipClasses()` Removes all memory relationship classes from a standalone table or layer.
`void`	`removeExtension(int index)` Removes the specified extension.
`void`	`removeHyperlink(int index)` Removes the hyperlink at the specified index.
`void`	`removeRelationshipClass(IRelationshipClass relationshipClass)` Removes the specified memory relationship class from a standalone table or layer.
`void`	`rename(String name)` Renames this Dataset.
`void`	`reScale(double xScale, double yScale)` ReScale operation of layer.
`void`	`reset()` Reset operation of layer.
`void`	`rotate(IPoint ipPivotPoint, double angle)` Rotate operation of layer.
`int`	`rowCount(IQueryFilter queryFilter)` The number of Rows selected by the specified query.
`void`	`save(IStream pstm, int fClearDirty)` save
`IFeatureCursor`	`search(IQueryFilter queryFilter, boolean recycling)` Creates a cursor based upon the search criteria.
`ICursor`	`searchDisplayTable(IQueryFilter pQueryFilter, boolean recycling)` Creates a cursor from the display table based upon the search criteria.
`ISelectionSet`	`select(IQueryFilter queryFilter, int selType, int selOption, IWorkspace selectionContainer)` A selection that contains the object ids selected by the specified query.
`ISelectionSet`	`selectDisplayTable(IQueryFilter pQueryFilter, int selType, int selOption, IWorkspace pSelWorkspace)` Creates a selection set from the display table based upon the search criteria.
`void`	`selectFeatures(IQueryFilter filter, int method, boolean justOne)` Selects features based upon the specifed criteria and combination method.
`void`	`selectionChanged()` Fires the features layer update event.
`void`	`selectRows(IQueryFilter filter, int method, boolean justOne)` Selects rows based upon the specified criteria and combination method.
`void`	`setAreaOfInterest(IEnvelope aoi)` The default area of interest for the layer.
`void`	`setArrowSymbolByRef(ILineSymbol symbol)` The line symbol for the arrow.
`void`	`setBrightness(short brightnessValue)` Layer brightness in percent (-100 - 100).
`void`	`setBrowseName(String name)` The browse name of the dataset.
`void`	`setBufferDistance(double distance)` Buffer distance used for the selection.
`void`	`setCached(boolean cached)` Indicates if the layer needs its own display cache.
`void`	`setCombinationMethod(int method)` Combination method for the selection.
`void`	`setContrast(short contrastValue)` Layer contrast in percent (-100 - 100).
`void`	`setDataSourceName(IName name)` Name of the data object for the layer.
`void`	`setDataSourceType(String text)` Data source type.
`void`	`setDefinitionExpression(String expression)` Definition query expression for the existing layer.
`void`	`setDisplayField(String fieldName)` Primary display field.
`void`	`setDisplayFilter(IDisplayFilter displayFilter)` The display filter.
`void`	`setDrawGeometry(boolean pUseScale)` Indicates if the annotation geometry will draw.
`void`	`setDrawGeometryLineSymbolByRef(ILineSymbol symbol)` The line symbol for drawing the geometry.
`void`	`setDrawGeometryMarkerSymbolByRef(IMarkerSymbol symbol)` The marker symbol for drawing the geometry.
`void`	`setDrawingLayerVisible(int index, boolean visible)` Indicates if the specified CAD drawing layer visible in the CAD layer in ArcMap.
`void`	`setDrawingPropsDirty(boolean dirty)` Indicates if the layer drawing properties are dirty.
`void`	`setDrawPhase(int pDrawPhase)` Draw phase in which layer is drawn.
`void`	`setEnableTransformations(boolean enabled)` Indicates if global transformations are enabled.
`void`	`setExpressionPropertiesByRef(IDisplayExpressionProperties displayExpressionProperties)` Properties that describe the display expression.
`void`	`setExpressionPropertiesByRef(IHotLinkExpressionProperties ppHotLinkExpressionProperties)` Properties that describe the hyperlink expression.
`void`	`setFeatureClassByRef(IFeatureClass fclass)` The layer's feature class.
`void`	`setFieldOrder(IFieldInfoSet fieldInfoSet)` A new order for the fields.
`void`	`setFontByRef(int symbolNumber, Font font)` The font for the specified symbol number.
`void`	`setFontColorByRef(int symbolNumber, IColor color)` The font color for the specified symbol number.
`void`	`setFromToTransform(_WKSPoint fromPoint1, _WKSPoint fromPoint2, _WKSPoint toPoint1, _WKSPoint toPoint2)` Sets the points of a two point transformation.
`void`	`setHotlinkField(String fieldName)` Field used for hotlinks.
`void`	`setHotlinkType(int linkType)` Hotlink type.
`void`	`setHTMLDownloadAttachmentData(boolean pDownloadAttachmentData)` Indicates that all data for attachments will be retrieved.
`void`	`setHTMLHideFieldNameColumn(boolean pHide)` Indicates if Field name column will be output to the HTML Popup tool.
`void`	`setHTMLPopupEnabled(boolean pEnabled)` Indicates if this layer currently responds to the HTML Popup tool.
`void`	`setHTMLPresentationStyle(int pStyle)` Indicates the content formating style for the HTML Popup tool.
`void`	`setHTMLRedirectField(String pField)` Indicates the fieldname of the layer that contains the HTML redirect URL values.
`void`	`setHTMLRedirectFieldPrefix(String pPrefix)` Indicates the text to precede the HTMLRedirectField value for the redirect URL.
`void`	`setHTMLRedirectFieldSuffix(String pSufix)` Indicates the text to follow the HTMLRedirectField value for the redirect URL.
`void`	`setHTMLUseCodedDomainValues(boolean pCodedValues)` Indicates whether to use coded values (rather than literal stored values) for feature values.
`void`	`setHTMLXSLStylesheet(String pStyleSheet)` Indicates the content of the XSL stylesheet to parse the feature attributes through.
`void`	`setHyperlinkByRef(int index, IHyperlink link)` The hyperlink at the specified index.
`void`	`setLayerDescription(String text)` Description for the layer.
`void`	`setLayerWeight(double layerWeight)` Default layer position.
`void`	`setLevelVisibility(int levelNumber, boolean visible)` Indicates if the level at the specified level number is visible.
`void`	`setMacroName(String name)` Name of macro used for the hotlink.
`void`	`setMapLevel(int mapLevel)` Current map level for drawing multi-level symbols.
`void`	`setMaximumScale(double maxScale)` Maximum scale (representative fraction) at which the layer will display.
`void`	`setMinimumScale(double minScale)` Minimum scale (representative fraction) at which the layer will display.
`void`	`setName(String name)` Layer name.
`void`	`setRelationshipClassByRef(IRelationshipClass relClass)` The current relationship class used to display related fields.
`void`	`setRelativeBase(String basePath)` Base path used when storing relative path names.
`void`	`setScale(double rhs1)` The current scale of the display.
`void`	`setScaleSymbols(boolean scale)` Indicates if symbols are scaled for the layer.
`void`	`setSearchOrder(int order)` Flag that specifies the search order used when applying a mixed attribute-spatial query.
`void`	`setSelectable(boolean value)` Indicates if layer is selectable.
`void`	`setSelectionColorByRef(IColor color)` Selection color.
`void`	`setSelectionSetByRef(ISelectionSet selectionSet)` The selected set of features.
`void`	`setSelectionSymbolByRef(ISymbol symbol)` Selection symbol.
`void`	`setSetSelectionSymbol(boolean setSymbol)` Indicates if the selected set of features is drawn using the SelectionSymbol.
`void`	`setShowTips(boolean show)` Indicates if the layer shows map tips.
`void`	`setSpatialReferenceByRef(ISpatialReference rhs1)` Spatial reference for the layer.
`void`	`setSupportsInteractive(boolean supported)` Indicates if the layer supports interactive effects changes.
`void`	`setTemporary(boolean temporary)` Indicates if the layer is a temporary layer.
`void`	`setTextSymbolByRef(int symbolNumber, ITextSymbol symbol)` The text symbol for the specified symbol number.
`void`	`setTransformation(_WKSPoint from, _WKSPoint to, double angle, double scale)` Sets the rotation, scale, and translation of a transformation.
`void`	`setTransformMode(int mode)` The transformation type.
`void`	`setTransparency(short alpha)` Layer transparency in percent (0-100).
`void`	`setupAttributeConversion(int numAttributes, Object inCols, Object outCols)` Sets up attribute conversion parameters for batch conversion.
`void`	`setVisible(boolean visible)` Indicates if the layer is currently visible.
`void`	`setWeight(int weight)` Weight of the barriers in this layer.
`void`	`setWorldFileName(String filePath)` The pathname of the world file.
`void`	`shift(double deltaX, double deltaY)` Shift operation of layer.
`void`	`startGeneratingGraphics(IEnvelope box, IDisplay display, boolean withAttributes)` Starts a graphics generation process from the annotation features.
`void`	`startGeneratingGraphics(IEnvelope box, IDisplay display, boolean withAttributes, boolean useGroupSymbolElement)` Starts a graphics generation process from the annotation features.
`void`	`startGeneratingSelectedGraphics(IDisplay display, boolean withAttributes, boolean useGroupSymbolElement)` Starts a graphics generation process from the selected annotation features.
`void`	`twoPointsAdjust(IPointCollection fromPoints, IPointCollection toPoints)` Two points adjust operation of layer.
`ICursor`	`update(IQueryFilter queryFilter, boolean recycling)` Returns a cursor that can be used to update Rows selected by the specified query.
`void`	`updateSearchedRows(IQueryFilter queryFilter, IRowBuffer buffer)` Update the Rows in the database selected by the specified query.
`void`	`visibleFeatures(IQueryFilter filter)` Updates query to include only visible features.
`void`	`warp(IPointCollection fromPoints, IPointCollection toPoints, int order)` Warp operation of layer.
`void`	`writeExternal(ObjectOutput out)`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
`getJintegraDispatch, release`

Constructor Detail

CadAnnotationLayer

public CadAnnotationLayer()
                   throws IOException,
                          UnknownHostException

Constructs a CadAnnotationLayer using ArcGIS Engine.

Throws:: IOException - if there are interop problems; UnknownHostException - if there are interop problems

CadAnnotationLayer

public CadAnnotationLayer(Object obj)
                   throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
CadAnnotationLayer theCadAnnotationLayer = (CadAnnotationLayer) obj;

Construct a CadAnnotationLayer using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to CadAnnotationLayer.

Parameters:: obj - an object returned from ArcGIS Engine or Server
Throws:: IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:: equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:: hashCode in class Object

getSymbolCount

public int getSymbolCount()
                   throws IOException,
                          AutomationException

The number of symbols used by the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSymbolCount in interface ICoverageAnnotationLayer
Specified by:: getSymbolCount in interface ICoverageAnnotationLayer2

Returns:: The count
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSymbolNumber

public int getSymbolNumber(int index)
                    throws IOException,
                           AutomationException

The symbol number at the specified index.

Product Availability

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

Specified by:: getSymbolNumber in interface ICoverageAnnotationLayer
Specified by:: getSymbolNumber in interface ICoverageAnnotationLayer2

Parameters:: index - The index (in)
Returns:: The symbolNumber
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getFont

public Font getFont(int symbolNumber)
             throws IOException,
                    AutomationException

The font for the specified symbol number.

Product Availability

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

Specified by:: getFont in interface ICoverageAnnotationLayer
Specified by:: getFont in interface ICoverageAnnotationLayer2

Parameters:: symbolNumber - The symbolNumber (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.

setFontByRef

public void setFontByRef(int symbolNumber,
                         Font font)
                  throws IOException,
                         AutomationException

The font for the specified symbol number.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setFontByRef in interface ICoverageAnnotationLayer
Specified by:: setFontByRef in interface ICoverageAnnotationLayer2

Parameters:: symbolNumber - The symbolNumber (in); font - A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef) (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getFontColor

public IColor getFontColor(int symbolNumber)
                    throws IOException,
                           AutomationException

The font color for the specified symbol number.

Product Availability

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

Specified by:: getFontColor in interface ICoverageAnnotationLayer
Specified by:: getFontColor in interface ICoverageAnnotationLayer2

Parameters:: symbolNumber - The symbolNumber (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.

setFontColorByRef

public void setFontColorByRef(int symbolNumber,
                              IColor color)
                       throws IOException,
                              AutomationException

The font color for the specified symbol number.

Product Availability

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

Specified by:: setFontColorByRef in interface ICoverageAnnotationLayer
Specified by:: setFontColorByRef in interface ICoverageAnnotationLayer2

Parameters:: symbolNumber - The symbolNumber (in); color - A reference to a com.esri.arcgis.display.IColor (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTextSymbol

public ITextSymbol getTextSymbol(int symbolNumber)
                          throws IOException,
                                 AutomationException

The text symbol for the specified symbol number.

Product Availability

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

Specified by:: getTextSymbol in interface ICoverageAnnotationLayer
Specified by:: getTextSymbol in interface ICoverageAnnotationLayer2

Parameters:: symbolNumber - The symbolNumber (in)
Returns:: A reference to a com.esri.arcgis.display.ITextSymbol
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTextSymbolByRef

public void setTextSymbolByRef(int symbolNumber,
                               ITextSymbol symbol)
                        throws IOException,
                               AutomationException

The text symbol for the specified symbol number.

Product Availability

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

Specified by:: setTextSymbolByRef in interface ICoverageAnnotationLayer
Specified by:: setTextSymbolByRef in interface ICoverageAnnotationLayer2

Parameters:: symbolNumber - The symbolNumber (in); symbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLevelCount

public int getLevelCount()
                  throws IOException,
                         AutomationException

The number of levels in the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLevelCount in interface ICoverageAnnotationLayer
Specified by:: getLevelCount in interface ICoverageAnnotationLayer2

Returns:: The count
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLevelNumber

public int getLevelNumber(int index)
                   throws IOException,
                          AutomationException

The level number at the specified index.

Product Availability

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

Specified by:: getLevelNumber in interface ICoverageAnnotationLayer
Specified by:: getLevelNumber in interface ICoverageAnnotationLayer2

Parameters:: index - The index (in)
Returns:: The pLevelNumber
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isLevelVisibility

public boolean isLevelVisibility(int levelNumber)
                          throws IOException,
                                 AutomationException

Indicates if the level at the specified level number is visible.

Product Availability

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

Specified by:: isLevelVisibility in interface ICoverageAnnotationLayer
Specified by:: isLevelVisibility in interface ICoverageAnnotationLayer2

Parameters:: levelNumber - The levelNumber (in)
Returns:: The visible
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setLevelVisibility

public void setLevelVisibility(int levelNumber,
                               boolean visible)
                        throws IOException,
                               AutomationException

Indicates if the level at the specified level number is visible.

Product Availability

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

Specified by:: setLevelVisibility in interface ICoverageAnnotationLayer
Specified by:: setLevelVisibility in interface ICoverageAnnotationLayer2

Parameters:: levelNumber - The levelNumber (in); visible - The visible (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getArrowSymbol

public ILineSymbol getArrowSymbol()
                           throws IOException,
                                  AutomationException

The line symbol for the arrow.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getArrowSymbol in interface ICoverageAnnotationLayer
Specified by:: getArrowSymbol in interface ICoverageAnnotationLayer2

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

setArrowSymbolByRef

public void setArrowSymbolByRef(ILineSymbol symbol)
                         throws IOException,
                                AutomationException

The line symbol for the arrow.

Product Availability

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

Specified by:: setArrowSymbolByRef in interface ICoverageAnnotationLayer
Specified by:: setArrowSymbolByRef in interface ICoverageAnnotationLayer2

Parameters:: symbol - A reference to a com.esri.arcgis.display.ILineSymbol (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

generateGraphics

public IEnumElement generateGraphics(IEnvelope box,
                                     IDisplay display)
                              throws IOException,
                                     AutomationException

Generates graphic elements from the annotation features. The optional envelope specifies a bounding box. The display is used for converting from map units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: generateGraphics in interface ICoverageAnnotationLayer

Parameters:: box - A reference to a com.esri.arcgis.geometry.IEnvelope (in); display - A reference to a com.esri.arcgis.display.IDisplay (in)
Returns:: A reference to a com.esri.arcgis.carto.IEnumElement
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

startGeneratingGraphics

public void startGeneratingGraphics(IEnvelope box,
                                    IDisplay display,
                                    boolean withAttributes)
                             throws IOException,
                                    AutomationException

Starts a graphics generation process from the annotation features. The optional envelope specifies a bounding box. The display is used for converting from map units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: startGeneratingGraphics in interface ICoverageAnnotationLayer

Parameters:: box - A reference to a com.esri.arcgis.geometry.IEnvelope (in); display - A reference to a com.esri.arcgis.display.IDisplay (in); withAttributes - The withAttributes (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getNextGraphic

public IElement getNextGraphic()
                        throws IOException,
                               AutomationException

Generates the next graphic element in the graphics generation loop. Returns a NULL element after the last annotation feature has been read. Call only after StartGeneratingGraphics.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getNextGraphic in interface ICoverageAnnotationLayer
Specified by:: getNextGraphic in interface ICoverageAnnotationLayer2

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.

nextFeatureAndGraphic

public void nextFeatureAndGraphic(IFeature[] feature,
                                  IElement[] element)
                           throws IOException,
                                  AutomationException

Generates the next feature and graphic element in the graphics generation loop. Returns a NULL feature and element after the last annotation feature has been read. Call only after StartGeneratingGraphics.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: nextFeatureAndGraphic in interface ICoverageAnnotationLayer
Specified by:: nextFeatureAndGraphic in interface ICoverageAnnotationLayer2

Parameters:: feature - A reference to a com.esri.arcgis.geodatabase.IFeature (out: use single element array); element - A reference to a com.esri.arcgis.carto.IElement (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

generateGraphics

public IEnumElement generateGraphics(IEnvelope box,
                                     IDisplay display,
                                     boolean useGroupSymbolElement)
                              throws IOException,
                                     AutomationException

Generates graphic elements from the annotation features. The optional envelope specifies a bounding box. The display is used for converting from map units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: generateGraphics in interface ICoverageAnnotationLayer2

Parameters:: box - A reference to a com.esri.arcgis.geometry.IEnvelope (in); display - A reference to a com.esri.arcgis.display.IDisplay (in); useGroupSymbolElement - The useGroupSymbolElement (in)
Returns:: A reference to a com.esri.arcgis.carto.IEnumElement
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

startGeneratingGraphics

public void startGeneratingGraphics(IEnvelope box,
                                    IDisplay display,
                                    boolean withAttributes,
                                    boolean useGroupSymbolElement)
                             throws IOException,
                                    AutomationException

Starts a graphics generation process from the annotation features. The optional envelope specifies a bounding box. The display is used for converting from map units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: startGeneratingGraphics in interface ICoverageAnnotationLayer2

Parameters:: box - A reference to a com.esri.arcgis.geometry.IEnvelope (in); display - A reference to a com.esri.arcgis.display.IDisplay (in); withAttributes - The withAttributes (in); useGroupSymbolElement - The useGroupSymbolElement (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

beginAddElements

public void beginAddElements(IDisplay pDisplay)
                      throws IOException,
                             AutomationException

Begins a batch process for adding elements to a annotation layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: beginAddElements in interface ICoverageAnnotationLayerWrite

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.

setupAttributeConversion

public void setupAttributeConversion(int numAttributes,
                                     Object inCols,
                                     Object outCols)
                              throws IOException,
                                     AutomationException

Sets up attribute conversion parameters for batch conversion.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setupAttributeConversion in interface ICoverageAnnotationLayerWrite

Parameters:: numAttributes - The numAttributes (in); inCols - A Variant (in); outCols - A Variant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

doAddFeature

public void doAddFeature(IFeature pFeature,
                         IElement pElement)
                  throws IOException,
                         AutomationException

Adds a feature and its corresponding element to a annotation layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: doAddFeature in interface ICoverageAnnotationLayerWrite

Parameters:: pFeature - A reference to a com.esri.arcgis.geodatabase.IFeature (in); pElement - A reference to a com.esri.arcgis.carto.IElement (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

endAddElements

public void endAddElements()
                    throws IOException,
                           AutomationException

Ends the batch process for adding elements to a annotation layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: endAddElements in interface ICoverageAnnotationLayerWrite

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

clearSymbols

public void clearSymbols()
                  throws IOException,
                         AutomationException

Erases all symbols and levels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: clearSymbols in interface ICoverageAnnotationLayerWrite

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

startGeneratingSelectedGraphics

public void startGeneratingSelectedGraphics(IDisplay display,
                                            boolean withAttributes,
                                            boolean useGroupSymbolElement)
                                     throws IOException,
                                            AutomationException

Starts a graphics generation process from the selected annotation features. The optional envelope specifies a bounding box. The display is used for converting from map units.

Product Availability

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

Specified by:: startGeneratingSelectedGraphics in interface ICoverageAnnotationSel

Parameters:: display - A reference to a com.esri.arcgis.display.IDisplay (in); withAttributes - The withAttributes (in); useGroupSymbolElement - The useGroupSymbolElement (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

nextSelectedFeatureAndGraphic

public void nextSelectedFeatureAndGraphic(IFeature[] feature,
                                          IElement[] element)
                                   throws IOException,
                                          AutomationException

Generates the next selected feature and graphic element in the graphics generation loop. Returns a NULL feature and element after the last annotation feature has been read. Call only after StartGeneratingGraphics.

Product Availability

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

Specified by:: nextSelectedFeatureAndGraphic in interface ICoverageAnnotationSel

Parameters:: feature - A reference to a com.esri.arcgis.geodatabase.IFeature (out: use single element array); element - A reference to a com.esri.arcgis.carto.IElement (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDrawingLayerCount

public int getDrawingLayerCount()
                         throws IOException,
                                AutomationException

The number of layers in the CAD drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDrawingLayerCount in interface ICadDrawingLayers

Returns:: The count
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDrawingLayerName

public String getDrawingLayerName(int index)
                           throws IOException,
                                  AutomationException

The name of the CAD drawing layer at the specified index.

Product Availability

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

Specified by:: getDrawingLayerName in interface ICadDrawingLayers

Parameters:: index - The index (in)
Returns:: The filePath
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isDrawingLayerVisible

public boolean isDrawingLayerVisible(int index)
                              throws IOException,
                                     AutomationException

Indicates if the specified CAD drawing layer visible in the CAD layer in ArcMap.

Product Availability

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

Specified by:: isDrawingLayerVisible in interface ICadDrawingLayers

Parameters:: index - The index (in)
Returns:: The visible
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDrawingLayerVisible

public void setDrawingLayerVisible(int index,
                                   boolean visible)
                            throws IOException,
                                   AutomationException

Indicates if the specified CAD drawing layer visible in the CAD layer in ArcMap.

Product Availability

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

Specified by:: setDrawingLayerVisible in interface ICadDrawingLayers

Parameters:: index - The index (in); visible - The visible (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isOriginalDrawingLayerVisible

public boolean isOriginalDrawingLayerVisible(int index)
                                      throws IOException,
                                             AutomationException

Indicates if the specified CAD drawing layer visible in the CAD drawing itself.

Product Availability

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

Specified by:: isOriginalDrawingLayerVisible in interface ICadDrawingLayers

Parameters:: index - The index (in)
Returns:: The visible
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isEnableTransformations

public boolean isEnableTransformations()
                                throws IOException,
                                       AutomationException

Indicates if global transformations are enabled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isEnableTransformations in interface ICadTransformations

Returns:: The enabled
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setEnableTransformations

public void setEnableTransformations(boolean enabled)
                              throws IOException,
                                     AutomationException

Indicates if global transformations are enabled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setEnableTransformations in interface ICadTransformations

Parameters:: enabled - The enabled (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getWorldFileName

public String getWorldFileName()
                        throws IOException,
                               AutomationException

The pathname of the world file.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getWorldFileName in interface ICadTransformations

Returns:: The filePath
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setWorldFileName

public void setWorldFileName(String filePath)
                      throws IOException,
                             AutomationException

The pathname of the world file.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setWorldFileName in interface ICadTransformations

Parameters:: filePath - The filePath (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTransformMode

public int getTransformMode()
                     throws IOException,
                            AutomationException

The transformation type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getTransformMode in interface ICadTransformations

Returns:: A com.esri.arcgis.datasourcesfile.esriCadTransform constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTransformMode

public void setTransformMode(int mode)
                      throws IOException,
                             AutomationException

The transformation type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setTransformMode in interface ICadTransformations

Parameters:: mode - A com.esri.arcgis.datasourcesfile.esriCadTransform constant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getFromToTransform

public void getFromToTransform(_WKSPoint[] fromPoint1,
                               _WKSPoint[] fromPoint2,
                               _WKSPoint[] toPoint1,
                               _WKSPoint[] toPoint2)
                        throws IOException,
                               AutomationException

Returns the points of a two point transformation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getFromToTransform in interface ICadTransformations

Parameters:: fromPoint1 - A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef) (out: use single element array); fromPoint2 - A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef) (out: use single element array); toPoint1 - A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef) (out: use single element array); toPoint2 - A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef) (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setFromToTransform

public void setFromToTransform(_WKSPoint fromPoint1,
                               _WKSPoint fromPoint2,
                               _WKSPoint toPoint1,
                               _WKSPoint toPoint2)
                        throws IOException,
                               AutomationException

Sets the points of a two point transformation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setFromToTransform in interface ICadTransformations

Parameters:: fromPoint1 - A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef) (in); fromPoint2 - A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef) (in); toPoint1 - A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef) (in); toPoint2 - A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef) (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTransformation

public void getTransformation(_WKSPoint[] from,
                              _WKSPoint[] to,
                              double[] angle,
                              double[] scale)
                       throws IOException,
                              AutomationException

Returns the rotation, scale, and translation of a transformation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getTransformation in interface ICadTransformations

Parameters:: from - A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef) (out: use single element array); to - A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef) (out: use single element array); angle - The angle (out: use single element array); scale - The scale (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTransformation

public void setTransformation(_WKSPoint from,
                              _WKSPoint to,
                              double angle,
                              double scale)
                       throws IOException,
                              AutomationException

Sets the rotation, scale, and translation of a transformation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setTransformation in interface ICadTransformations

Parameters:: from - A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef) (in); to - A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef) (in); angle - The angle (in); scale - The scale (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

Layer name.

Description

Remarks

Use this property to associate a string with a layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getName in interface ILayer
Specified by:: getName in interface ILayer2
Specified by:: getName in interface IDataset

Returns:: The name
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException

Layer name.

Description

Use the Name property to associate a string with the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setName in interface ILayer
Specified by:: setName in interface ILayer2

Parameters:: name - The name (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isValid

public boolean isValid()
                throws IOException,
                       AutomationException

Indicates if the layer is currently valid.

Remarks

The valid property indicates if the layer is currently valid. Layers that reference feature classes are valid when they hold a reference to a valid feature class. The property does not however validate the integrity of the feature classes reference to the database. Therefore, in rare situations if a datasource is removed after a layer is initialized, the layer will report itself as valid but query attempts to the data source will error due to the lack of underlying data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isValid in interface ILayer
Specified by:: isValid in interface ILayer2

Returns:: The valid
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getAreaOfInterest

public IEnvelope getAreaOfInterest()
                            throws IOException,
                                   AutomationException

The default area of interest for the layer.

Remarks

Returns the spatial-referenced extent of the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getAreaOfInterest in interface ILayer
Specified by:: getAreaOfInterest in interface ILayer2

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.

getMinimumScale

public double getMinimumScale()
                       throws IOException,
                              AutomationException

Minimum scale (representative fraction) at which the layer will display.

Remarks

Specifies the minimum scale at which the layer will be displayed. This means that if you zoom out beyond this scale, the layer will not display. For example, specify 1000 to have the layer not display when zoomed out beyond 1:1000.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getMinimumScale in interface ILayer
Specified by:: getMinimumScale in interface ILayer2

Returns:: The minScale
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setMinimumScale

public void setMinimumScale(double minScale)
                     throws IOException,
                            AutomationException

Minimum scale (representative fraction) at which the layer will display.

Description

MinimumScale property specifies the minimum scale at which the layer will be displayed. Assign a Double value to set this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setMinimumScale in interface ILayer
Specified by:: setMinimumScale in interface ILayer2

Parameters:: minScale - The minScale (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getMaximumScale

public double getMaximumScale()
                       throws IOException,
                              AutomationException

Maximum scale (representative fraction) at which the layer will display.

Remarks

Specifies the maximum scale at which the layer will be displayed. This means that if you zoom in beyond this scale, the layer will not display. For example, specify 500 to have the layer not display when zoomed in beyond 1:500.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getMaximumScale in interface ILayer
Specified by:: getMaximumScale in interface ILayer2

Returns:: The maxScale
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setMaximumScale

public void setMaximumScale(double maxScale)
                     throws IOException,
                            AutomationException

Maximum scale (representative fraction) at which the layer will display.

Description

MaximumScale property specifies the maximum scale at which the layer will be displayed. Assign a Double value to set this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setMaximumScale in interface ILayer
Specified by:: setMaximumScale in interface ILayer2

Parameters:: maxScale - The maxScale (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if the layer is currently visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isVisible in interface ILayer
Specified by:: isVisible in interface ILayer2

Returns:: The visible
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean visible)
                throws IOException,
                       AutomationException

Indicates if the layer is currently visible.

Description

Use Visible property to set the visibility of the layer. When assigned False, the layer is invisible in the current view.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setVisible in interface ILayer
Specified by:: setVisible in interface ILayer2

Parameters:: visible - The visible (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isShowTips

public boolean isShowTips()
                   throws IOException,
                          AutomationException

Indicates if the layer shows map tips.

Remarks

Indicates whether or not map tips are shown for the layer. If set to True, then map tips will be shown for the layer. You can determine the text that will be shown via TipText. For a FeatureLayer, this text comes from the data for IFeatureLayer::DisplayField.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isShowTips in interface ILayer
Specified by:: isShowTips in interface ILayer2

Returns:: The show
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setShowTips

public void setShowTips(boolean show)
                 throws IOException,
                        AutomationException

Indicates if the layer shows map tips.

Description

ShowTips is set to True when the layer shows map tips specified in the TipText property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setShowTips in interface ILayer
Specified by:: setShowTips in interface ILayer2

Parameters:: show - The show (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTipText

public String getTipText(double x,
                         double y,
                         double tolerance)
                  throws IOException,
                         AutomationException

Map tip text at the specified location.

Product Availability

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

Specified by:: getTipText in interface ILayer
Specified by:: getTipText in interface ILayer2

Parameters:: x - The x (in); y - The y (in); tolerance - The tolerance (in)
Returns:: The text
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isCached

public boolean isCached()
                 throws IOException,
                        AutomationException

Indicates if the layer needs its own display cache.

Remarks

This property indicates whether or not the layer requires its own display cache. If this property is True, then the Map will use a separate display cache for the layer so that it can be refreshed indpendently of other layers.

The Map is responsible for cache management. See IScreenDisplay::AddCache for more information on caches.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isCached in interface ILayer
Specified by:: isCached in interface ILayer2

Returns:: The cached
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setCached

public void setCached(boolean cached)
               throws IOException,
                      AutomationException

Indicates if the layer needs its own display cache.

Description

Use Cached property to indicate if the layer needs its own cache for display.

Remarks

Informational property. Container is responsible for cache management.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setCached in interface ILayer
Specified by:: setCached in interface ILayer2

Parameters:: cached - The cached (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSupportedDrawPhases

public int getSupportedDrawPhases()
                           throws IOException,
                                  AutomationException

Supported draw phases.

Remarks

Indicates the draw phases supported by the layer (esriDPGeography, esriDPAnnotation, esriDPSelection, or any combination of the three). The supported draw phases are defined by esriDrawPhase. When multiple draw phases are supported, the sum of the constants is used. For example, if SupportedDrawPhases = 3 then the layer supports drawing in the geography and annotation phases.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSupportedDrawPhases in interface ILayer
Specified by:: getSupportedDrawPhases in interface ILayer2

Returns:: The drawPhases
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference rhs1)
                              throws IOException,
                                     AutomationException

Spatial reference for the layer.

Remarks

This property is only used for map display, setting this property does not change the spatial reference of the layer's underlying data. The ArcGIS framework uses this property to pass the spatial reference from the map to the layer in order to support on-the-fly projection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSpatialReferenceByRef in interface ILayer
Specified by:: setSpatialReferenceByRef in interface ILayer2

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

draw

public void draw(int drawPhase,
                 IDisplay display,
                 ITrackCancel trackCancel)
          throws IOException,
                 AutomationException

Draws the layer to the specified display for the given draw phase.

Remarks

This method draws the layer to the Display for the specified DrawPhase. Use the TrackCancel object to allow the drawing of the layer to be interrupted by the user.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: draw in interface ILayer
Specified by:: draw in interface ILayer2

Parameters:: drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in); display - A reference to a com.esri.arcgis.display.IDisplay (in); 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.

isScaleRangeReadOnly

public boolean isScaleRangeReadOnly()
                             throws IOException,
                                    AutomationException

Indicates if the minimum and maximum scale range values are read-only.

Remarks

Some layer types do not support a writeable MinimumScale or MaximumScale. Use this property to determine whether or not a layer supports this.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isScaleRangeReadOnly in interface ILayer2

Returns:: The flag
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setAreaOfInterest

public void setAreaOfInterest(IEnvelope aoi)
                       throws IOException,
                              AutomationException

The default area of interest for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setAreaOfInterest in interface ILayer2

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

getFeatureClass

public IFeatureClass getFeatureClass()
                              throws IOException,
                                     AutomationException

The layer's feature class.

Description

The FeatureClass data source for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getFeatureClass in interface IFeatureLayer
Specified by:: getFeatureClass in interface IFeatureLayer2

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.

setFeatureClassByRef

public void setFeatureClassByRef(IFeatureClass fclass)
                          throws IOException,
                                 AutomationException

The layer's feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setFeatureClassByRef in interface IFeatureLayer
Specified by:: setFeatureClassByRef in interface IFeatureLayer2

Parameters:: fclass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDataSourceType

public String getDataSourceType()
                         throws IOException,
                                AutomationException

Data source type.

Description

Describes the type of data referenced by the feature layer. In ArcMap and ArcCatalog this description appears on the layer's properties dialog on the Source tab after "Data Type:"

Remarks

By default, the DataSourceType for a layer matches the value returned by IDataset::Category when you access the layer's feature class through IDataset. You can set a layer's DataSourceType to any string.

Here is a list of default values for DataSourceType for common feature layer types:

Layer Type	Value
Personal Geodatabase	"Personal Geodatabase Feature Class"
SDE	"SDE Feature Class"
Shapefile	"Shapefile Feature Class"
ArcInfo or PC ArcInfo Coverage (annotation)	"Annotation Feature Class"
ArcInfo or PC ArcInfo Coverage (point)	"Point Feature Class"
ArcInfo or PC ArcInfo Coverage (line)	"Arc Feature Class"
ArcInfo or PC ArcInfo Coverage (polygon)	"Polygon Feature Class"
Edge	"StreetMap Feature Class"
CAD (annotation)	"CAD Annotation Feature Class"
CAD (point)	"CAD Point Feature Class"
CAD (line)	"CAD Polyline Feature Class"
CAD (polygon)	"CAD Polygon Feature Class"

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDataSourceType in interface IFeatureLayer
Specified by:: getDataSourceType in interface IFeatureLayer2

Returns:: The text
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDataSourceType

public void setDataSourceType(String text)
                       throws IOException,
                              AutomationException

Data source type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDataSourceType in interface IFeatureLayer
Specified by:: setDataSourceType in interface IFeatureLayer2

Parameters:: text - The text (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDisplayField

public String getDisplayField()
                       throws IOException,
                              AutomationException

Primary display field.

Description

The name of the layer's primary display field.

Remarks

Usually this field name contains the string "name", or is the first string field found in the layer's attributes. This field is used to show map tips for the layer. The value of this property must match the name of one of the fields in the layer's FeatureClass.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDisplayField in interface IFeatureLayer
Specified by:: getDisplayField in interface IFeatureLayer2

Returns:: The fieldName
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDisplayField

public void setDisplayField(String fieldName)
                     throws IOException,
                            AutomationException

Primary display field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDisplayField in interface IFeatureLayer
Specified by:: setDisplayField in interface IFeatureLayer2

Parameters:: fieldName - The fieldName (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSelectable

public boolean isSelectable()
                     throws IOException,
                            AutomationException

Indicates if layer is selectable.

Description

Indicates whether the layer's features are selectable.

Remarks

The default value for Selectable is False.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSelectable in interface IFeatureLayer
Specified by:: isSelectable in interface IFeatureLayer2

Returns:: The value
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSelectable

public void setSelectable(boolean value)
                   throws IOException,
                          AutomationException

Indicates if layer is selectable.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSelectable in interface IFeatureLayer
Specified by:: setSelectable in interface IFeatureLayer2

Parameters:: value - The value (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

search

public IFeatureCursor search(IQueryFilter queryFilter,
                             boolean recycling)
                      throws IOException,
                             AutomationException

Creates a cursor based upon the search criteria.

Description

Use this method to return a read-only cursor of the layer's features.

Remarks

If there is a definition query set on the layer, the Search method will automatically work on the subset of features in the layer that meet the definition criteria. You specify an additional query that will be applied after the layer's definition query by passing valid IQueryFilter object for the QueryFilter parameter.

This Search method will not work on joined fields. If the FeatureLayer has any joins, you should use the IGeoFeatureLayer::SearchDisplayFeatures method instead.

You cannot use the cursor returned by IFeatureLayer::Search to update features, instead use IFeatureClass::Update.

Recycling specifies whether the resulting feature cursor will be recycling or non-recycling. Use True for recycling cursor and False for a non-recycling cursor. See the topic for IFeatureClass::Search for more information.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: search in interface IFeatureLayer
Specified by:: search in interface IFeatureLayer2

Parameters:: queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in); recycling - The recycling (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.IFeatureCursor
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isScaleSymbols

public boolean isScaleSymbols()
                       throws IOException,
                              AutomationException

Indicates if symbols are scaled for the layer.

Description

Indicates whether the symbols for this layer will respect the reference scale of the map containing the layer. Set this property to True for your layer and set a map reference scale to have your layer symbology scale as you zoom in and out.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isScaleSymbols in interface IFeatureLayer
Specified by:: isScaleSymbols in interface IFeatureLayer2

Returns:: The scale
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setScaleSymbols

public void setScaleSymbols(boolean scale)
                     throws IOException,
                            AutomationException

Indicates if symbols are scaled for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setScaleSymbols in interface IFeatureLayer
Specified by:: setScaleSymbols in interface IFeatureLayer2

Parameters:: scale - The scale (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getShapeType

public int getShapeType()
                 throws IOException,
                        AutomationException

The layer's shape type.

Remarks

Returns the basic geometry type of the layer's underlying feature class. See IFeatureClass::ShapeType for more information.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getShapeType in interface IFeatureLayer2

Returns:: A com.esri.arcgis.geometry.esriGeometryType constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

expandRegionForSymbols

public void expandRegionForSymbols(IDisplay display,
                                   IGeometry region)
                            throws IOException,
                                   AutomationException

Expands the given geometry by an amount that will include the layer's symbology for the given display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: expandRegionForSymbols in interface IFeatureLayer2
Specified by:: expandRegionForSymbols in interface ILayerSymbologyExtents

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

getDefinitionExpression

public String getDefinitionExpression()
                               throws IOException,
                                      AutomationException

Definition query expression for the existing layer.

Description

Use the DefinitionExpression property to read or set the definition query for an existing layer just like you would in the Definition Query tab of the layer's properties dialog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDefinitionExpression in interface IFeatureLayerDefinition
Specified by:: getDefinitionExpression in interface IFeatureLayerDefinition2
Specified by:: getDefinitionExpression in interface ITableDefinition

Returns:: The expression
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDefinitionExpression

public void setDefinitionExpression(String expression)
                             throws IOException,
                                    AutomationException

Definition query expression for the existing layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDefinitionExpression in interface IFeatureLayerDefinition
Specified by:: setDefinitionExpression in interface IFeatureLayerDefinition2
Specified by:: setDefinitionExpression in interface ITableDefinition

Parameters:: expression - The expression (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDefinitionSelectionSet

public ISelectionSet getDefinitionSelectionSet()
                                        throws IOException,
                                               AutomationException

The selection set that defines the subset of features in a selection layer.

Remarks

You can use the DefintionSelectionSet property to get the selection set that was used to define the new layer created by the IFeatureLayerDefintion::CreateSelectionLayer method. Note, before calling CreateSelectionLayer, the selection set returned by DefintionSelectionSet will be Nothing. Therefore, you can only use this property after you have called the CreateSelectionLayer method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDefinitionSelectionSet in interface IFeatureLayerDefinition
Specified by:: getDefinitionSelectionSet in interface IFeatureLayerDefinition2
Specified by:: getDefinitionSelectionSet in interface ITableDefinition

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

createSelectionLayer

public IFeatureLayer createSelectionLayer(String layerName,
                                          boolean useCurrentSelection,
                                          String joinTableNames,
                                          String expression)
                                   throws IOException,
                                          AutomationException

Creates a new feature layer from the existing layer based on the current selection and the specified query expression.

Description

CreateSelectionLayer creates a new FeatureLayer from an existing FeatureLayer.

LayerName defines the new layer's name.

Set useCurrentSelection = TRUE here if you want to use the currently selected features on the existing layer.

joinTableNames may contain the name of related table(s) separated by commas. The existing join(s) will then be passed on to the new layer.

The DefinitionExpression parameter can be used to set a definition expression on the newly created layer but currently this will be defined at the feature class rather than at the layer level and will not show up in the UI. If you want to set a definition query on the newly created layer, it is best to use IFeatureLayerDefinition again to set the definition query after the layer has been created.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: createSelectionLayer in interface IFeatureLayerDefinition
Specified by:: createSelectionLayer in interface IFeatureLayerDefinition2

Parameters:: layerName - The layerName (in); useCurrentSelection - The useCurrentSelection (in); joinTableNames - The joinTableNames (in); expression - The expression (in)
Returns:: A reference to a com.esri.arcgis.carto.IFeatureLayer
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getRelationshipClass

public IRelationshipClass getRelationshipClass()
                                        throws IOException,
                                               AutomationException

The current relationship class used to display related fields.

Remarks

RelClass must be a defined relationship class on the base feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getRelationshipClass in interface IDisplayRelationshipClass
Specified by:: getRelationshipClass in interface IFeatureLayerDefinition
Specified by:: getRelationshipClass in interface IFeatureLayerDefinition2

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

setRelationshipClassByRef

public void setRelationshipClassByRef(IRelationshipClass relClass)
                               throws IOException,
                                      AutomationException

The current relationship class used to display related fields.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setRelationshipClassByRef in interface IFeatureLayerDefinition
Specified by:: setRelationshipClassByRef in interface IFeatureLayerDefinition2

Parameters:: relClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSearchOrder

public int getSearchOrder()
                   throws IOException,
                          AutomationException

Flag that specifies the search order used when applying a mixed attribute-spatial query.

Product Availability

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

Specified by:: getSearchOrder in interface IFeatureLayerDefinition2

Returns:: A com.esri.arcgis.geodatabase.esriSearchOrder constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSearchOrder

public void setSearchOrder(int order)
                    throws IOException,
                           AutomationException

Flag that specifies the search order used when applying a mixed attribute-spatial query.

Product Availability

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

Specified by:: setSearchOrder in interface IFeatureLayerDefinition2

Parameters:: order - A com.esri.arcgis.geodatabase.esriSearchOrder constant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSelectionSet

public ISelectionSet getSelectionSet()
                              throws IOException,
                                     AutomationException

The selected set of features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSelectionSet in interface IFeatureSelection
Specified by:: getSelectionSet in interface ITableSelection

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

setSelectionSetByRef

public void setSelectionSetByRef(ISelectionSet selectionSet)
                          throws IOException,
                                 AutomationException

The selected set of features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSelectionSetByRef in interface IFeatureSelection
Specified by:: setSelectionSetByRef in interface ITableSelection

Parameters:: selectionSet - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getCombinationMethod

public int getCombinationMethod()
                         throws IOException,
                                AutomationException

Combination method for the selection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getCombinationMethod in interface IFeatureSelection

Returns:: A com.esri.arcgis.carto.esriSelectionResultEnum constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setCombinationMethod

public void setCombinationMethod(int method)
                          throws IOException,
                                 AutomationException

Combination method for the selection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setCombinationMethod in interface IFeatureSelection

Parameters:: method - A com.esri.arcgis.carto.esriSelectionResultEnum constant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getBufferDistance

public double getBufferDistance()
                         throws IOException,
                                AutomationException

Buffer distance used for the selection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getBufferDistance in interface IFeatureSelection

Returns:: The distance
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setBufferDistance

public void setBufferDistance(double distance)
                       throws IOException,
                              AutomationException

Buffer distance used for the selection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setBufferDistance in interface IFeatureSelection

Parameters:: distance - The distance (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSetSelectionSymbol

public boolean isSetSelectionSymbol()
                             throws IOException,
                                    AutomationException

Indicates if the selected set of features is drawn using the SelectionSymbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSetSelectionSymbol in interface IFeatureSelection

Returns:: The setSymbol
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSetSelectionSymbol

public void setSetSelectionSymbol(boolean setSymbol)
                           throws IOException,
                                  AutomationException

Indicates if the selected set of features is drawn using the SelectionSymbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSetSelectionSymbol in interface IFeatureSelection

Parameters:: setSymbol - The setSymbol (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSelectionColor

public IColor getSelectionColor()
                         throws IOException,
                                AutomationException

Selection color. (used when SetSelectionSymbol = FALSE).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSelectionColor in interface IFeatureSelection

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.

setSelectionColorByRef

public void setSelectionColorByRef(IColor color)
                            throws IOException,
                                   AutomationException

Selection color. (used when SetSelectionSymbol = FALSE).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSelectionColorByRef in interface IFeatureSelection

Parameters:: color - A reference to a com.esri.arcgis.display.IColor (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSelectionSymbol

public ISymbol getSelectionSymbol()
                           throws IOException,
                                  AutomationException

Selection symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSelectionSymbol in interface IFeatureSelection

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.

setSelectionSymbolByRef

public void setSelectionSymbolByRef(ISymbol symbol)
                             throws IOException,
                                    AutomationException

Selection symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSelectionSymbolByRef in interface IFeatureSelection

Parameters:: symbol - A reference to a com.esri.arcgis.display.ISymbol (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

add

public void add(IFeature feature)
         throws IOException,
                AutomationException

Adds a feature to the selection set.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: add in interface IFeatureSelection

Parameters:: feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

selectFeatures

public void selectFeatures(IQueryFilter filter,
                           int method,
                           boolean justOne)
                    throws IOException,
                           AutomationException

Selects features based upon the specifed criteria and combination method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: selectFeatures in interface IFeatureSelection

Parameters:: filter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in); method - A com.esri.arcgis.carto.esriSelectionResultEnum constant (in); justOne - The justOne (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

clear

public void clear()
           throws IOException,
                  AutomationException

Clears the selection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: clear in interface IFeatureSelection
Specified by:: clear in interface ITableSelection

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

selectionChanged

public void selectionChanged()
                      throws IOException,
                             AutomationException

Fires the features layer update event. Required when SelectionSet changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: selectionChanged in interface IFeatureSelection
Specified by:: selectionChanged in interface ITableSelection

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getFieldCount

public int getFieldCount()
                  throws IOException,
                         AutomationException

The number of fields.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getFieldCount in interface ILayerFields
Specified by:: getFieldCount in interface ITableFields

Returns:: The count
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getField

public IField getField(int index)
                throws IOException,
                       AutomationException

The field at the specified index.

Product Availability

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

Specified by:: getField in interface ILayerFields
Specified by:: getField in interface ITableFields

Parameters:: index - The index (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.IField
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getFieldInfo

public IFieldInfo getFieldInfo(int index)
                        throws IOException,
                               AutomationException

Extended field information for the field at the specified index.

Product Availability

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

Specified by:: getFieldInfo in interface ILayerFields
Specified by:: getFieldInfo in interface ITableFields

Parameters:: index - The index (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.IFieldInfo
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

findField

public int findField(String fieldName)
              throws IOException,
                     AutomationException

Returns the index of the field with the specified name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: findField in interface ILayerFields
Specified by:: findField in interface IClass
Specified by:: findField in interface ITableFields

Parameters:: fieldName - The fieldName (in)
Returns:: The index
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException

The spatial reference of the GeoDataset.

Remarks

This property is read only. For layers, when the first layer is added to ArcMap, its spatial reference is read by this property, and the map is set to this spatial reference.

Instances of the esriCarto.GroupLayer class will return null for this property, as a group layer can contain multiple datasets with different spatial references.

Modifications to a spatial reference returned by this property will not be persisted. To modify the spatial reference of a dataset, the IGeoDatasetSchemaEdit and IGeoDatasetSchemaEdit2 interfaces should be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSpatialReference in interface IGeoDataset

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.

getExtent

public IEnvelope getExtent()
                    throws IOException,
                           AutomationException

The extent of the GeoDataset.

Remarks

The IGeoDataset::Extent property returns an envelope representing the maximum extent of data which has been stored in the dataset.

Consider the following scenario. A new feature class has features added to it. The IGeoDataset::Extent is then requested and an envelope is returned. The extents of the envelope returned are represented by the red box in the image below.

The red box represents the IGeoDataset extent

If a portion of the features were then deleted and the extent is again requested an envelope with the exact same extents as during the first request would be returned (see image below). This is because the deletion of features does not shrink the extent. However all additions of features outside the red box would increase the envelope returned to encompass the newly added features.

The red box represents the IGeoDataset extent after some of the features have been deleted

If you would like to update the IGeoDataset::Extent property to reflect the current features in your dataset please see IFeatureClassManage::UpdateExtent (also see IFeatureClassLoad). In the image below the extent has been updated and a new envelope is being returned.

The red box represents the IGeoDataset extent after it has been updated

ESRI's GroupLayer implements this property differently from most other layer coclasses. When you instantiate a new GroupLayer, this property will return a valid envelope with zero height and width. With most other newly instantiated layers (for example FeatureLayer, RasterLayer, TinLayer), this property initally returns Nothing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getExtent in interface IGeoDataset

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.

getWeight

public int getWeight()
              throws IOException,
                     AutomationException

Weight of the barriers in this layer.

Description

A Long value corresponding to a weight in esriBasicOverposterWeight.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getWeight in interface IBarrierProperties
Specified by:: getWeight in interface IBarrierProperties2

Returns:: The weight
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setWeight

public void setWeight(int weight)
               throws IOException,
                      AutomationException

Weight of the barriers in this layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setWeight in interface IBarrierProperties
Specified by:: setWeight in interface IBarrierProperties2

Parameters:: weight - The weight (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getBarriers

public void getBarriers(IDisplay display,
                        IGeometryCollection pBarriers,
                        IEnvelope extent)
                 throws IOException,
                        AutomationException

List of barriers within the specified extent, or all barriers if no extent given.

Product Availability

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

Specified by:: getBarriers in interface IBarrierProperties

Parameters:: display - A reference to a com.esri.arcgis.display.IDisplay (in); pBarriers - A reference to a com.esri.arcgis.geometry.IGeometryCollection (in); extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in, optional, pass 0 if not required)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

queryBarriers

public void queryBarriers(IDisplay display,
                          IGeometryCollection pBarriers,
                          IEnvelope extent,
                          ITrackCancel trackCancel)
                   throws IOException,
                          AutomationException

List of barriers within the specified extent, or all barriers if no extent given.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: queryBarriers in interface IBarrierProperties2

Parameters:: display - A reference to a com.esri.arcgis.display.IDisplay (in); pBarriers - A reference to a com.esri.arcgis.geometry.IGeometryCollection (in); extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in); 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.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isDirty in interface IPersistStream

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: load in interface IPersistStream

Parameters:: pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: save in interface IPersistStream

Parameters:: pstm - A reference to a com.esri.arcgis.system.IStream (in); fClearDirty - The fClearDirty (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSizeMax in interface IPersistStream

Parameters:: pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getClassID in interface IPersist

Parameters:: pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSmallImage

public int getSmallImage()
                  throws IOException,
                         AutomationException

Small image that represents the layer.

Description

The icon used to represent the layer in ArcCatalog's 'List' and 'Details' views.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSmallImage in interface ILayerInfo

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

getSmallSelectedImage

public int getSmallSelectedImage()
                          throws IOException,
                                 AutomationException

Small image that represents the layer when it is selected.

Description

The icon used to represent the layer when it is selected in ArcCatalog's 'List' and 'Details' views.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSmallSelectedImage in interface ILayerInfo

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

getLargeImage

public int getLargeImage()
                  throws IOException,
                         AutomationException

Large image that represents the layer.

Description

The icon used to represent the layer in ArcCatalog's 'Large Icon' view.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLargeImage in interface ILayerInfo

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

getLargeSelectedImage

public int getLargeSelectedImage()
                          throws IOException,
                                 AutomationException

Large image that represents the layer when it is selected.

Description

The icon used to represent the layer when it is selected in ArcCatalog's 'Large Icon' view.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLargeSelectedImage in interface ILayerInfo

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

getDataSourceName

public IName getDataSourceName()
                        throws IOException,
                               AutomationException

Name of the data object for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDataSourceName in interface IDataLayer
Specified by:: getDataSourceName in interface IDataLayer2

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

setDataSourceName

public void setDataSourceName(IName name)
                       throws IOException,
                              AutomationException

Name of the data object for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDataSourceName in interface IDataLayer
Specified by:: setDataSourceName in interface IDataLayer2

Parameters:: name - A reference to a com.esri.arcgis.system.IName (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isDataSourceSupported

public boolean isDataSourceSupported(IName name)
                              throws IOException,
                                     AutomationException

Indicates if the specified data object name is supported by the layer.

Product Availability

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

Specified by:: isDataSourceSupported in interface IDataLayer
Specified by:: isDataSourceSupported in interface IDataLayer2

Parameters:: name - A reference to a com.esri.arcgis.system.IName (in)
Returns:: The supported
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

connect

public boolean connect(IName pOptRepairName)
                throws IOException,
                       AutomationException

Connects the layer to its data source. An optional name object can be specified to aid in repairing a lost connection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: connect in interface IDataLayer
Specified by:: connect in interface IDataLayer2

Parameters:: pOptRepairName - A reference to a com.esri.arcgis.system.IName (in)
Returns:: The succeeded
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getRelativeBase

public String getRelativeBase()
                       throws IOException,
                              AutomationException

Base path used when storing relative path names.

Remarks

The RelativeBase property is used internally when persisting and loading documents with a relative path. When a document has been fully loaded the path is realized to a complete path.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getRelativeBase in interface IDataLayer
Specified by:: getRelativeBase in interface IDataLayer2

Returns:: The basePath
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setRelativeBase

public void setRelativeBase(String basePath)
                     throws IOException,
                            AutomationException

Base path used when storing relative path names.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setRelativeBase in interface IDataLayer
Specified by:: setRelativeBase in interface IDataLayer2

Parameters:: basePath - The basePath (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

disconnect

public void disconnect()
                throws IOException,
                       AutomationException

Disconnects the data from the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: disconnect in interface IDataLayer2

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

inWorkspace

public boolean inWorkspace(IWorkspace workspace)
                    throws IOException,
                           AutomationException

Returns TRUE if the layer is in the specified workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: inWorkspace in interface IDataLayer2

Parameters:: workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Returns:: The inWorkspace
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getAttributeTable

public ITable getAttributeTable()
                         throws IOException,
                                AutomationException

The attribute table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getAttributeTable in interface IAttributeTable

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

find

public IArray find(String search,
                   boolean contains,
                   Object fields,
                   ITrackCancel trackCancel)
            throws IOException,
                   AutomationException

Finds the specified search string in the given attribute fields.

Remarks

This method returns an reference to an Array of FeatureFindData objects. To search, pass in a reference to an Fields object along with the search string and a boolean option to return features that have attributes that contain the string. If Contains = False, only objects with an attribute that consists of the entire search string will be returned.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: find in interface IFind

Parameters:: search - The search (in); contains - The contains (in); fields - A Variant (in); trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Returns:: A reference to a com.esri.arcgis.system.IArray
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getFindFields

public Object getFindFields()
                     throws IOException,
                            AutomationException

The attribute fields.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getFindFields in interface IFind

Returns:: A Variant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getFindDisplayField

public String getFindDisplayField()
                           throws IOException,
                                  AutomationException

The display field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getFindDisplayField in interface IFind

Returns:: The field
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getHotlinkField

public String getHotlinkField()
                       throws IOException,
                              AutomationException

Field used for hotlinks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getHotlinkField in interface IHotlinkContainer

Returns:: The fieldName
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHotlinkField

public void setHotlinkField(String fieldName)
                     throws IOException,
                            AutomationException

Field used for hotlinks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setHotlinkField in interface IHotlinkContainer

Parameters:: fieldName - The fieldName (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getHotlinkType

public int getHotlinkType()
                   throws IOException,
                          AutomationException

Hotlink type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getHotlinkType in interface IHotlinkContainer

Returns:: A com.esri.arcgis.carto.esriHyperlinkType constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHotlinkType

public void setHotlinkType(int linkType)
                    throws IOException,
                           AutomationException

Hotlink type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setHotlinkType in interface IHotlinkContainer

Parameters:: linkType - A com.esri.arcgis.carto.esriHyperlinkType constant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getMacroName

public String getMacroName()
                    throws IOException,
                           AutomationException

Name of macro used for the hotlink.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getMacroName in interface IHotlinkMacro

Returns:: The name
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setMacroName

public void setMacroName(String name)
                  throws IOException,
                         AutomationException

Name of macro used for the hotlink.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setMacroName in interface IHotlinkMacro

Parameters:: name - The name (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

IHotlinkExpression_getExpressionProperties

public IHotLinkExpressionProperties IHotlinkExpression_getExpressionProperties()
                                                                        throws IOException,
                                                                               AutomationException

Properties that describe the hyperlink expression.

Product Availability

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

Specified by:: IHotlinkExpression_getExpressionProperties in interface IHotlinkExpression

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

setExpressionPropertiesByRef

public void setExpressionPropertiesByRef(IHotLinkExpressionProperties ppHotLinkExpressionProperties)
                                  throws IOException,
                                         AutomationException

Properties that describe the hyperlink expression.

Product Availability

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

Specified by:: setExpressionPropertiesByRef in interface IHotlinkExpression

Parameters:: ppHotLinkExpressionProperties - A reference to a com.esri.arcgis.carto.IHotLinkExpressionProperties (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

executeExpression

public String executeExpression(IObject pObject)
                         throws IOException,
                                AutomationException

Finds the hyperlink for the given feature based on the current expression properties.

Product Availability

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

Specified by:: executeExpression in interface IHotlinkExpression

Parameters:: pObject - A reference to a com.esri.arcgis.geodatabase.IObject (in)
Returns:: The text
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getHyperlinkCount

public int getHyperlinkCount()
                      throws IOException,
                             AutomationException

Number of hyperlinks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getHyperlinkCount in interface IHyperlinkContainer

Returns:: The count
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getHyperlink

public IHyperlink getHyperlink(int index)
                        throws IOException,
                               AutomationException

The hyperlink at the specified index.

Product Availability

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

Specified by:: getHyperlink in interface IHyperlinkContainer

Parameters:: index - The index (in)
Returns:: A reference to a com.esri.arcgis.carto.IHyperlink
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHyperlinkByRef

public void setHyperlinkByRef(int index,
                              IHyperlink link)
                       throws IOException,
                              AutomationException

The hyperlink at the specified index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setHyperlinkByRef in interface IHyperlinkContainer

Parameters:: index - The index (in); link - A reference to a com.esri.arcgis.carto.IHyperlink (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addHyperlink

public void addHyperlink(IHyperlink link)
                  throws IOException,
                         AutomationException

Adds a hyperlink.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addHyperlink in interface IHyperlinkContainer

Parameters:: link - A reference to a com.esri.arcgis.carto.IHyperlink (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

removeHyperlink

public void removeHyperlink(int index)
                     throws IOException,
                            AutomationException

Removes the hyperlink at the specified index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: removeHyperlink in interface IHyperlinkContainer

Parameters:: index - The index (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

identify

public IArray identify(IGeometry pGeom)
                throws IOException,
                       AutomationException

Identifies objects at the specified location.

Remarks

When the IIdentify interface is on a map layer, the Identify method returns an array of FeatureIdentifyObject objects.

On a FeatureIdentifyObject, you can do a QI to the IIdentifyObj interface to get more information about the identified feature. The IIdentifyObj interface returns the window handle, layer, and name of the feature; it has methods to flash the feature in the display and to display a context menu at the Identify location.

This method performs an identify operation with the provided geometry. When identifying layers, typically a small envelope is passed in rather than a point to account for differences in the precision of the display and the feature geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: identify in interface IIdentify

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

identify

public IArray identify(IGeometry pGeom,
                       ITrackCancel pTrackCancel)
                throws IOException,
                       AutomationException

Identifies objects at the specified location.

Remarks

When the IIdentify interface is on a map layer, the Identify method returns an array of FeatureIdentifyObject objects.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: identify in interface IIdentify2

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

setScale

public void setScale(double rhs1)
              throws IOException,
                     AutomationException

The current scale of the display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setScale in interface IIdentify2

Parameters:: rhs1 - The rhs1 (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

visibleFeatures

public void visibleFeatures(IQueryFilter filter)
                     throws IOException,
                            AutomationException

Updates query to include only visible features.

Product Availability

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

Specified by:: visibleFeatures in interface IInteractiveSearch

Parameters:: filter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSupportsPublishing

public boolean isSupportsPublishing()
                             throws IOException,
                                    AutomationException

Indicates if the layer supports the publishing process.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSupportsPublishing in interface IPublishLayer

Returns:: The bValid
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getPublishingDescription

public String getPublishingDescription()
                                throws IOException,
                                       AutomationException

The layer description reported to the publisher.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getPublishingDescription in interface IPublishLayer

Returns:: The bsDescription
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isDataValid

public boolean isDataValid()
                    throws IOException,
                           AutomationException

Indicates if the data for the layer is currently valid.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isDataValid in interface IPublishLayer

Returns:: The bDataValid
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDataDetails

public String getDataDetails(String bsPadding)
                      throws IOException,
                             AutomationException

Details of the layer's data.

Product Availability

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

Specified by:: getDataDetails in interface IPublishLayer

Parameters:: bsPadding - The bsPadding (in)
Returns:: The bsDataDetails
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

prepareForPublishing

public void prepareForPublishing()
                          throws IOException,
                                 AutomationException

Prepare the layer for the publishing process.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: prepareForPublishing in interface IPublishLayer

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDrawPhase

public int getDrawPhase()
                 throws IOException,
                        AutomationException

Draw phase in which layer is drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDrawPhase in interface ILayerDrawingPhase

Returns:: A com.esri.arcgis.system.esriDrawPhase constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDrawPhase

public void setDrawPhase(int pDrawPhase)
                  throws IOException,
                         AutomationException

Draw phase in which layer is drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDrawPhase in interface ILayerDrawingPhase

Parameters:: pDrawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isDrawingPropsDirty

public boolean isDrawingPropsDirty()
                            throws IOException,
                                   AutomationException

Indicates if the layer drawing properties are dirty.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isDrawingPropsDirty in interface ILayerDrawingProperties

Returns:: The dirty
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDrawingPropsDirty

public void setDrawingPropsDirty(boolean dirty)
                          throws IOException,
                                 AutomationException

Indicates if the layer drawing properties are dirty.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDrawingPropsDirty in interface ILayerDrawingProperties

Parameters:: dirty - The dirty (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSupportsTransparency

public boolean isSupportsTransparency()
                               throws IOException,
                                      AutomationException

Indicates if the layer supports transparency.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSupportsTransparency in interface ILayerEffects

Returns:: The supported
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSupportsContrastChange

public boolean isSupportsContrastChange()
                                 throws IOException,
                                        AutomationException

Indicates if the layer supports contrast changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSupportsContrastChange in interface ILayerEffects

Returns:: The supported
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSupportsBrightnessChange

public boolean isSupportsBrightnessChange()
                                   throws IOException,
                                          AutomationException

Indicates if the layer supports brightness changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSupportsBrightnessChange in interface ILayerEffects

Returns:: The supported
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSupportsInteractive

public void setSupportsInteractive(boolean supported)
                            throws IOException,
                                   AutomationException

Indicates if the layer supports interactive effects changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSupportsInteractive in interface ILayerEffects

Parameters:: supported - The supported (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSupportsInteractive

public boolean isSupportsInteractive()
                              throws IOException,
                                     AutomationException

Indicates if the layer supports interactive effects changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSupportsInteractive in interface ILayerEffects

Returns:: The supported
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTransparency

public short getTransparency()
                      throws IOException,
                             AutomationException

Layer transparency in percent (0-100).

Remarks

When you set Transparency for a FeatureLayer, a TransparencyDisplayFilter is created and applied to the layer. You can accomplish the same effect by manually creating a new TransparencyDisplayFilter using IDisplayFilter, and then assigning it to a layer using IDisplayFilterManager.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getTransparency in interface ILayerEffects

Returns:: The alpha
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTransparency

public void setTransparency(short alpha)
                     throws IOException,
                            AutomationException

Layer transparency in percent (0-100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setTransparency in interface ILayerEffects

Parameters:: alpha - The alpha (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getContrast

public short getContrast()
                  throws IOException,
                         AutomationException

Layer contrast in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getContrast in interface ILayerEffects

Returns:: The contrastValue
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setContrast

public void setContrast(short contrastValue)
                 throws IOException,
                        AutomationException

Layer contrast in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setContrast in interface ILayerEffects

Parameters:: contrastValue - The contrastValue (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getBrightness

public short getBrightness()
                    throws IOException,
                           AutomationException

Layer brightness in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getBrightness in interface ILayerEffects

Returns:: The brightnessValue
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setBrightness

public void setBrightness(short brightnessValue)
                   throws IOException,
                          AutomationException

Layer brightness in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setBrightness in interface ILayerEffects

Parameters:: brightnessValue - The brightnessValue (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getExtensionCount

public int getExtensionCount()
                      throws IOException,
                             AutomationException

Number of extensions.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getExtensionCount in interface ILayerExtensions

Returns:: The count
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getExtension

public Object getExtension(int index)
                    throws IOException,
                           AutomationException

The extension at the specified index.

Product Availability

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

Specified by:: getExtension in interface ILayerExtensions

Parameters:: index - The index (in)
Returns:: A reference to another Object (IUnknown)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addExtension

public void addExtension(Object ext)
                  throws IOException,
                         AutomationException

Adds a new extension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addExtension in interface ILayerExtensions

Parameters:: ext - A reference to another Object (IUnknown) (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

removeExtension

public void removeExtension(int index)
                     throws IOException,
                            AutomationException

Removes the specified extension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: removeExtension in interface ILayerExtensions

Parameters:: index - The index (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLayerWeight

public double getLayerWeight()
                      throws IOException,
                             AutomationException

Default layer position.

Description

The LayerWeight property defines the weight of the layer in the auto arrange order. During auto arrange, the higher weight layers are added to the map first, which means they draw lower in the draw order.

Default weights for layers are these values:
Annotation layers = 97
Points layers = 98
Polyline layers = 99
Polygon Layers = 100

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLayerWeight in interface ILayerPosition

Returns:: The layerWeight
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setLayerWeight

public void setLayerWeight(double layerWeight)
                    throws IOException,
                           AutomationException

Default layer position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setLayerWeight in interface ILayerPosition

Parameters:: layerWeight - The layerWeight (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLastMinimumScale

public double getLastMinimumScale()
                           throws IOException,
                                  AutomationException

Last minimum scale setting used by layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLastMinimumScale in interface ILayerGeneralProperties

Returns:: The minScale
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLastMaximumScale

public double getLastMaximumScale()
                           throws IOException,
                                  AutomationException

Last maximum scale setting used by layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLastMaximumScale in interface ILayerGeneralProperties

Returns:: The maxScale
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

ILayerGeneralProperties_getLayerDescription

public String ILayerGeneralProperties_getLayerDescription()
                                                   throws IOException,
                                                          AutomationException

Description for the layer.

Product Availability

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

Specified by:: ILayerGeneralProperties_getLayerDescription in interface ILayerGeneralProperties

Returns:: The text
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setLayerDescription

public void setLayerDescription(String text)
                         throws IOException,
                                AutomationException

Description for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setLayerDescription in interface ILayerGeneralProperties

Parameters:: text - The text (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isDrawGeometry

public boolean isDrawGeometry()
                       throws IOException,
                              AutomationException

Indicates if the annotation geometry will draw.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isDrawGeometry in interface IDrawAnnotationGeometry

Returns:: The pUseScale
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDrawGeometry

public void setDrawGeometry(boolean pUseScale)
                     throws IOException,
                            AutomationException

Indicates if the annotation geometry will draw.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDrawGeometry in interface IDrawAnnotationGeometry

Parameters:: pUseScale - The pUseScale (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDrawGeometryLineSymbol

public ILineSymbol getDrawGeometryLineSymbol()
                                      throws IOException,
                                             AutomationException

The line symbol for drawing the geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDrawGeometryLineSymbol in interface IDrawAnnotationGeometry

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

setDrawGeometryLineSymbolByRef

public void setDrawGeometryLineSymbolByRef(ILineSymbol symbol)
                                    throws IOException,
                                           AutomationException

The line symbol for drawing the geometry.

Product Availability

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

Specified by:: setDrawGeometryLineSymbolByRef in interface IDrawAnnotationGeometry

Parameters:: symbol - A reference to a com.esri.arcgis.display.ILineSymbol (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDrawGeometryMarkerSymbol

public IMarkerSymbol getDrawGeometryMarkerSymbol()
                                          throws IOException,
                                                 AutomationException

The marker symbol for drawing the geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDrawGeometryMarkerSymbol in interface IDrawAnnotationGeometry

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

setDrawGeometryMarkerSymbolByRef

public void setDrawGeometryMarkerSymbolByRef(IMarkerSymbol symbol)
                                      throws IOException,
                                             AutomationException

The marker symbol for drawing the geometry.

Product Availability

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

Specified by:: setDrawGeometryMarkerSymbolByRef in interface IDrawAnnotationGeometry

Parameters:: symbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isHTMLPopupEnabled

public boolean isHTMLPopupEnabled()
                           throws IOException,
                                  AutomationException

Indicates if this layer currently responds to the HTML Popup tool.

Product Availability

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

Specified by:: isHTMLPopupEnabled in interface IHTMLPopupIdentify
Specified by:: isHTMLPopupEnabled in interface IHTMLPopupInfo

Returns:: The pEnabled
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHTMLPopupEnabled

public void setHTMLPopupEnabled(boolean pEnabled)
                         throws IOException,
                                AutomationException

Indicates if this layer currently responds to the HTML Popup tool.

Product Availability

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

Specified by:: setHTMLPopupEnabled in interface IHTMLPopupInfo

Parameters:: pEnabled - The pEnabled (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getHTMLPresentationStyle

public int getHTMLPresentationStyle()
                             throws IOException,
                                    AutomationException

Indicates the content formating style for the HTML Popup tool.

Product Availability

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

Specified by:: getHTMLPresentationStyle in interface IHTMLPopupIdentify
Specified by:: getHTMLPresentationStyle in interface IHTMLPopupInfo

Returns:: A com.esri.arcgis.carto.esriHTMLPopupStyle constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHTMLPresentationStyle

public void setHTMLPresentationStyle(int pStyle)
                              throws IOException,
                                     AutomationException

Indicates the content formating style for the HTML Popup tool.

Product Availability

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

Specified by:: setHTMLPresentationStyle in interface IHTMLPopupInfo

Parameters:: pStyle - A com.esri.arcgis.carto.esriHTMLPopupStyle constant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isHTMLHideFieldNameColumn

public boolean isHTMLHideFieldNameColumn()
                                  throws IOException,
                                         AutomationException

Indicates if Field name column will be output to the HTML Popup tool.

Product Availability

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

Specified by:: isHTMLHideFieldNameColumn in interface IHTMLPopupInfo

Returns:: The pHide
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHTMLHideFieldNameColumn

public void setHTMLHideFieldNameColumn(boolean pHide)
                                throws IOException,
                                       AutomationException

Indicates if Field name column will be output to the HTML Popup tool.

Product Availability

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

Specified by:: setHTMLHideFieldNameColumn in interface IHTMLPopupInfo

Parameters:: pHide - The pHide (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getHTMLRedirectField

public String getHTMLRedirectField()
                            throws IOException,
                                   AutomationException

Indicates the fieldname of the layer that contains the HTML redirect URL values.

Product Availability

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

Specified by:: getHTMLRedirectField in interface IHTMLPopupInfo

Returns:: The pField
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHTMLRedirectField

public void setHTMLRedirectField(String pField)
                          throws IOException,
                                 AutomationException

Indicates the fieldname of the layer that contains the HTML redirect URL values.

Product Availability

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

Specified by:: setHTMLRedirectField in interface IHTMLPopupInfo

Parameters:: pField - The pField (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getHTMLRedirectFieldPrefix

public String getHTMLRedirectFieldPrefix()
                                  throws IOException,
                                         AutomationException

Indicates the text to precede the HTMLRedirectField value for the redirect URL.

Product Availability

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

Specified by:: getHTMLRedirectFieldPrefix in interface IHTMLPopupInfo

Returns:: The pPrefix
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHTMLRedirectFieldPrefix

public void setHTMLRedirectFieldPrefix(String pPrefix)
                                throws IOException,
                                       AutomationException

Indicates the text to precede the HTMLRedirectField value for the redirect URL.

Product Availability

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

Specified by:: setHTMLRedirectFieldPrefix in interface IHTMLPopupInfo

Parameters:: pPrefix - The pPrefix (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getHTMLRedirectFieldSuffix

public String getHTMLRedirectFieldSuffix()
                                  throws IOException,
                                         AutomationException

Indicates the text to follow the HTMLRedirectField value for the redirect URL.

Product Availability

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

Specified by:: getHTMLRedirectFieldSuffix in interface IHTMLPopupInfo

Returns:: The pSufix
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHTMLRedirectFieldSuffix

public void setHTMLRedirectFieldSuffix(String pSufix)
                                throws IOException,
                                       AutomationException

Indicates the text to follow the HTMLRedirectField value for the redirect URL.

Product Availability

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

Specified by:: setHTMLRedirectFieldSuffix in interface IHTMLPopupInfo

Parameters:: pSufix - The pSufix (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getHTMLXSLStylesheet

public String getHTMLXSLStylesheet()
                            throws IOException,
                                   AutomationException

Indicates the content of the XSL stylesheet to parse the feature attributes through.

Product Availability

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

Specified by:: getHTMLXSLStylesheet in interface IHTMLPopupInfo

Returns:: The pStyleSheet
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHTMLXSLStylesheet

public void setHTMLXSLStylesheet(String pStyleSheet)
                          throws IOException,
                                 AutomationException

Indicates the content of the XSL stylesheet to parse the feature attributes through.

Product Availability

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

Specified by:: setHTMLXSLStylesheet in interface IHTMLPopupInfo

Parameters:: pStyleSheet - The pStyleSheet (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isHTMLUseCodedDomainValues

public boolean isHTMLUseCodedDomainValues()
                                   throws IOException,
                                          AutomationException

Indicates whether to use coded values (rather than literal stored values) for feature values.

Product Availability

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

Specified by:: isHTMLUseCodedDomainValues in interface IHTMLPopupInfo

Returns:: The pCodedValues
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHTMLUseCodedDomainValues

public void setHTMLUseCodedDomainValues(boolean pCodedValues)
                                 throws IOException,
                                        AutomationException

Indicates whether to use coded values (rather than literal stored values) for feature values.

Product Availability

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

Specified by:: setHTMLUseCodedDomainValues in interface IHTMLPopupInfo

Parameters:: pCodedValues - The pCodedValues (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getHTMLOutput

public String getHTMLOutput(IFeature pFeature)
                     throws IOException,
                            AutomationException

The content is the XML text for the input feature.

Product Availability

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

Specified by:: getHTMLOutput in interface IHTMLPopupInfo

Parameters:: pFeature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)
Returns:: The pHtml
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isHTMLDownloadAttachmentData

public boolean isHTMLDownloadAttachmentData()
                                     throws IOException,
                                            AutomationException

Indicates that all data for attachments will be retrieved.

Product Availability

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

Specified by:: isHTMLDownloadAttachmentData in interface IHTMLPopupInfo2

Returns:: The pDownloadAttachmentData
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHTMLDownloadAttachmentData

public void setHTMLDownloadAttachmentData(boolean pDownloadAttachmentData)
                                   throws IOException,
                                          AutomationException

Indicates that all data for attachments will be retrieved.

Product Availability

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

Specified by:: setHTMLDownloadAttachmentData in interface IHTMLPopupInfo2

Parameters:: pDownloadAttachmentData - The pDownloadAttachmentData (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

hTMLOutput

public String hTMLOutput(IFeature pFeature,
                         IPropertySet pOptions)
                  throws IOException,
                         AutomationException

The content is the XML text for the input feature, pOptions is an optional parameter.

Product Availability

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

Specified by:: hTMLOutput in interface IHTMLPopupInfo2

Parameters:: pFeature - A reference to a com.esri.arcgis.geodatabase.IFeature (in); pOptions - A reference to a com.esri.arcgis.system.IPropertySet (in)
Returns:: The pHtml
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

hTMLIdentify

public String hTMLIdentify(IPoint pPoint,
                           double tolerance)
                    throws IOException,
                           AutomationException

The content is the XML text at the specified point.

Product Availability

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

Specified by:: hTMLIdentify in interface IHTMLPopupIdentify

Parameters:: pPoint - A reference to a com.esri.arcgis.geometry.IPoint (in); tolerance - The tolerance (in)
Returns:: The pHtml
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

hTMLTipText

public String hTMLTipText(IPoint pPoint,
                          double tolerance)
                   throws IOException,
                          AutomationException

The tooltip at the specified point.

Product Availability

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

Specified by:: hTMLTipText in interface IHTMLPopupIdentify

Parameters:: pPoint - A reference to a com.esri.arcgis.geometry.IPoint (in); tolerance - The tolerance (in)
Returns:: The pTipText
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

hTMLIdentify

public void hTMLIdentify(IDisplay pDisplay,
                         IGeometry pGeometry,
                         IPropertySet pOptions,
                         IStringArray[] ppItemNames,
                         IStringArray[] ppItemHTML)
                  throws IOException,
                         AutomationException

The content is the XML text at the specified point. tempPath and refPath are optional parameters.

Product Availability

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

Specified by:: hTMLIdentify in interface IHTMLPopupIdentify2

Parameters:: pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in); pGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in); pOptions - A reference to a com.esri.arcgis.system.IPropertySet (in); ppItemNames - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array); ppItemHTML - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getJoinType

public int getJoinType()
                throws IOException,
                       AutomationException

Join type for the most recent join performed.

Description

Indicates the type of the most recent join.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getJoinType in interface IDisplayRelationshipClass

Returns:: A com.esri.arcgis.geodatabase.esriJoinType constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

displayRelationshipClass

public void displayRelationshipClass(IRelationshipClass relClass,
                                     int joinType)
                              throws IOException,
                                     AutomationException

Sets a join based on the specified relationship class and join type.

Description

RelClass can be either a file or memory based relationship class, but must be defined on the base feature class.

Remarks

This method internally initializes a RelQueryTable to perform a join. relClass can be can be either a predefined relationship class in a geodatabase or an in memory relationship class. For more information on relationship clases, see IRelationshipClass

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: displayRelationshipClass in interface IDisplayRelationshipClass

Parameters:: relClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in); joinType - A com.esri.arcgis.geodatabase.esriJoinType constant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDisplayTable

public ITable getDisplayTable()
                       throws IOException,
                              AutomationException

The display table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDisplayTable in interface IDisplayTable

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

searchDisplayTable

public ICursor searchDisplayTable(IQueryFilter pQueryFilter,
                                  boolean recycling)
                           throws IOException,
                                  AutomationException

Creates a cursor from the display table based upon the search criteria.

Description

QueryFilter specifies an IQueryFilterObject to be used for the search.

Recycling specifies whether the resulting cursor is recycling or non-recycling. Use True for recycling cursor and False for a non-recycling cursor.

Remarks

If there is a definition query set on the layer or table, the SearchDisplayTable method will work on the subset of rows that meet the definition criteria. Otherwise, it will search the whole table.

SearchDisplayTable will return an ICursor with all of the rows that satisfy some attribute and/or spatial query as specified by an IQueryFilter object. If Nothing is given as the IQueryFilter, then the cursor will have all of the rows from the table.

This SearchDisplayTable method will also work on joined fields if you qualify the field names. For example, if you want to search a field called "Pop1990" from a joined table called "Demog", you should used "Demog.Pop1990" for the field name in the query filter used in the search method.

The Recycling parameter controls row object allocation behavior. Recycling cursors rehydrate a single row object on each fetch and can be used to optimize read-only access, for example, when drawing. It is illegal to maintain a reference on a row object returned by a recycling cursor across multiple calls to NextRow on the cursor. Row objects returned by a recycling cursor should not be modified.

Non-recycling cursors return a separate row object on each fetch. The objects returned by a non-recycling cursor may be modified and stored with polymorphic behavior. The geodatabase guarantees 'unique instance semantics' on non-recycling feature objects fetched during an edit session.

Recycling cursors should be used only for drawing and read-only access to object state. Use non-recycling search cursors to fetch objects that are to be updated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: searchDisplayTable in interface IDisplayTable

Parameters:: pQueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in); recycling - The recycling (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.ICursor
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

selectDisplayTable

public ISelectionSet selectDisplayTable(IQueryFilter pQueryFilter,
                                        int selType,
                                        int selOption,
                                        IWorkspace pSelWorkspace)
                                 throws IOException,
                                        AutomationException

Creates a selection set from the display table based upon the search criteria.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: selectDisplayTable in interface IDisplayTable

Parameters:: pQueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in); selType - A com.esri.arcgis.geodatabase.esriSelectionType constant (in); selOption - A com.esri.arcgis.geodatabase.esriSelectionOption constant (in); pSelWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.ISelectionSet
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDisplaySelectionSet

public ISelectionSet getDisplaySelectionSet()
                                     throws IOException,
                                            AutomationException

The selected set of rows from the display table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDisplaySelectionSet in interface IDisplayTable

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

isCanGeoRef

public boolean isCanGeoRef()
                    throws IOException,
                           AutomationException

Indicates if layer can be georeferenced.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isCanGeoRef in interface IGeoReference

Returns:: The canGeoRef
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

shift

public void shift(double deltaX,
                  double deltaY)
           throws IOException,
                  AutomationException

Shift operation of layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: shift in interface IGeoReference

Parameters:: deltaX - The deltaX (in); deltaY - The deltaY (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

reScale

public void reScale(double xScale,
                    double yScale)
             throws IOException,
                    AutomationException

ReScale operation of layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: reScale in interface IGeoReference

Parameters:: xScale - The xScale (in); yScale - The yScale (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

flip

public void flip()
          throws IOException,
                 AutomationException

Flip operation of layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: flip in interface IGeoReference

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

mirror

public void mirror()
            throws IOException,
                   AutomationException

Mirror operation of layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: mirror in interface IGeoReference

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

rotate

public void rotate(IPoint ipPivotPoint,
                   double angle)
            throws IOException,
                   AutomationException

Rotate operation of layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: rotate in interface IGeoReference

Parameters:: ipPivotPoint - A reference to a com.esri.arcgis.geometry.IPoint (in); angle - The angle (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

pointsTransform

public IPointCollection pointsTransform(IPointCollection inPoints,
                                        boolean isForward)
                                 throws IOException,
                                        AutomationException

Transform operation of Raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: pointsTransform in interface IGeoReference

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

twoPointsAdjust

public void twoPointsAdjust(IPointCollection fromPoints,
                            IPointCollection toPoints)
                     throws IOException,
                            AutomationException

Two points adjust operation of layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: twoPointsAdjust in interface IGeoReference

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

warp

public void warp(IPointCollection fromPoints,
                 IPointCollection toPoints,
                 int order)
          throws IOException,
                 AutomationException

Warp operation of layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: warp in interface IGeoReference

Parameters:: fromPoints - A reference to a com.esri.arcgis.geometry.IPointCollection (in); toPoints - A reference to a com.esri.arcgis.geometry.IPointCollection (in); order - The order (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException

Reset operation of layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: reset in interface IGeoReference

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

register

public void register()
              throws IOException,
                     AutomationException

Save transformation parameters and tie-points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: register in interface IGeoReference

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

rectify

public void rectify(String fullpath,
                    String format)
             throws IOException,
                    AutomationException

Save transformed result to a new dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: rectify in interface IGeoReference

Parameters:: fullpath - The fullpath (in); format - The format (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getRelationshipClasses

public IEnumRelationshipClass getRelationshipClasses()
                                              throws IOException,
                                                     AutomationException

The memory relationship classes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getRelationshipClasses in interface IRelationshipClassCollection

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

findRelationshipClasses

public IEnumRelationshipClass findRelationshipClasses(IObjectClass objectClass,
                                                      int role)
                                               throws IOException,
                                                      AutomationException

Finds all relationship classes in the collection that reference the given object class in the specified role.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: findRelationshipClasses in interface IRelationshipClassCollection

Parameters:: objectClass - A reference to a com.esri.arcgis.geodatabase.IObjectClass (in); role - A com.esri.arcgis.geodatabase.esriRelRole constant (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.IEnumRelationshipClass
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addRelationshipClass

public void addRelationshipClass(IRelationshipClass relationshipClass)
                          throws IOException,
                                 AutomationException

Adds the specified memory relationship class to a standalone table or layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addRelationshipClass in interface IRelationshipClassCollectionEdit

Parameters:: relationshipClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

removeRelationshipClass

public void removeRelationshipClass(IRelationshipClass relationshipClass)
                             throws IOException,
                                    AutomationException

Removes the specified memory relationship class from a standalone table or layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: removeRelationshipClass in interface IRelationshipClassCollectionEdit

Parameters:: relationshipClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

removeAllRelationshipClasses

public void removeAllRelationshipClasses()
                                  throws IOException,
                                         AutomationException

Removes all memory relationship classes from a standalone table or layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: removeAllRelationshipClasses in interface IRelationshipClassCollectionEdit

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

clearPassword

public void clearPassword(boolean bForceReconnect)
                   throws IOException,
                          AutomationException

Removes the passwords from the layer used to access data, and forces a reconnection to the data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: clearPassword in interface ISecureLayer

Parameters:: bForceReconnect - The bForceReconnect (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addRow

public void addRow(IRow row)
            throws IOException,
                   AutomationException

Adds a row to the selection set (honoring the current combination method).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addRow in interface ITableSelection

Parameters:: row - A reference to a com.esri.arcgis.geodatabase.IRow (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

selectRows

public void selectRows(IQueryFilter filter,
                       int method,
                       boolean justOne)
                throws IOException,
                       AutomationException

Selects rows based upon the specified criteria and combination method.

Description

The justOne parameter tells the search to stop once it has found one feature.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: selectRows in interface ITableSelection

Parameters:: filter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in); method - A com.esri.arcgis.carto.esriSelectionResultEnum constant (in); justOne - The justOne (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTemporary

public void setTemporary(boolean temporary)
                  throws IOException,
                         AutomationException

Indicates if the layer is a temporary layer.

Product Availability

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

Specified by:: setTemporary in interface ITemporaryLayer

Parameters:: temporary - The temporary (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isTemporary

public boolean isTemporary()
                    throws IOException,
                           AutomationException

Indicates if the layer is a temporary layer.

Product Availability

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

Specified by:: isTemporary in interface ITemporaryLayer

Returns:: The temporary
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isUsesFilter

public boolean isUsesFilter()
                     throws IOException,
                            AutomationException

Indicates if the current object draws using a filter.

Remarks

The UsesFilter property returns true when the object in question will draw with a filter. Drawing with a filter means means that an object that would normally draw as vector graphics will instead draw as raster. The UsesFilter property is particularly useful for detecting vector map layers that will be rasterized at time of print or export.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isUsesFilter in interface IDisplayAdmin

Returns:: The usesFilter
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDisplayFilter

public void setDisplayFilter(IDisplayFilter displayFilter)
                      throws IOException,
                             AutomationException

The display filter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDisplayFilter in interface IDisplayFilterManager

Parameters:: displayFilter - A reference to a com.esri.arcgis.display.IDisplayFilter (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDisplayFilter

public IDisplayFilter getDisplayFilter()
                                throws IOException,
                                       AutomationException

The display filter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDisplayFilter in interface IDisplayFilterManager

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

getMapLevel

public int getMapLevel()
                throws IOException,
                       AutomationException

Current map level for drawing multi-level symbols.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getMapLevel in interface IMapLevel

Returns:: The mapLevel
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setMapLevel

public void setMapLevel(int mapLevel)
                 throws IOException,
                        AutomationException

Current map level for drawing multi-level symbols.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setMapLevel in interface IMapLevel

Parameters:: mapLevel - The mapLevel (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getFields

public IFields getFields()
                  throws IOException,
                         AutomationException

The fields collection for this object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getFields in interface IClass

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

getIndexes

public IIndexes getIndexes()
                    throws IOException,
                           AutomationException

The indexes collection for this object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getIndexes in interface IClass

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

addField

public void addField(IField field)
              throws IOException,
                     AutomationException

Adds a field to this object class.

Remarks

Prior to adding a new field to a class, an exclusive schema lock should be obtained using the ISchemaLock interface.

Attempting to add a new field that does not allow null values will fail, if the class already has data in it. The only solution is to recreate the class with the non-nullable field, then copy the rows from the original class into the new class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addField in interface IClass

Parameters:: field - A reference to a com.esri.arcgis.geodatabase.IField (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

deleteField

public void deleteField(IField field)
                 throws IOException,
                        AutomationException

Deletes a field from this object class.

Remarks

DeleteField removes the specified field from a table, object class or feature class. Fields that are required by the Geodatabase and cannot be removed include:

OBJECTID field
SHAPE and shape dependent fields such as SHAPE_Length
Enabled, AncillaryRole and Weight field for network feature classes
Subtype fields. In order to delete a subtype field, it must first be removed as the subtype field, see the help on ISubtypes::SubtypeFieldName

Prior to deleting a field from a class, an exclusive schema lock should be obtained using the ISchemaLock interface.

Example:

// Assume we have a reference to a FeatureClass (pFC)

      IFields pFields;

      IField pField;



      pFields = pFC.getFields();

      pField = pFields.getField(pFields.findField("MyField"));



      pFC.deleteField(pField);

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: deleteField in interface IClass

Parameters:: field - A reference to a com.esri.arcgis.geodatabase.IField (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addIndex

public void addIndex(IIndex index)
              throws IOException,
                     AutomationException

Adds an index to this object class.

Remarks

Prior to adding a new index to a class, an exclusive schema lock should be obtained using the ISchemaLock interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addIndex in interface IClass

Parameters:: index - A reference to a com.esri.arcgis.geodatabase.IIndex (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

deleteIndex

public void deleteIndex(IIndex index)
                 throws IOException,
                        AutomationException

Deletes an index from this object class.

Remarks

Prior to deleting an index from a class, an exclusive schema lock should be obtained using the ISchemaLock interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: deleteIndex in interface IClass

Parameters:: index - A reference to a com.esri.arcgis.geodatabase.IIndex (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isHasOID

public boolean isHasOID()
                 throws IOException,
                        AutomationException

Indicates if the class has an object identity (OID) field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isHasOID in interface IClass

Returns:: The hasOID
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getOIDFieldName

public String getOIDFieldName()
                       throws IOException,
                              AutomationException

The name of the field corresponding to the OID.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getOIDFieldName in interface IClass

Returns:: The name
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getCLSID

public IUID getCLSID()
              throws IOException,
                     AutomationException

The GUID for the COM Class (CoClass) corresponding to instances of this object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getCLSID in interface IClass

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

getEXTCLSID

public IUID getEXTCLSID()
                 throws IOException,
                        AutomationException

The GUID for the COM Class (CoClass) corresponding to the class extension for this object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getEXTCLSID in interface IClass

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

getExtension

public Object getExtension()
                    throws IOException,
                           AutomationException

The extension for this object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getExtension in interface IClass

Returns:: A reference to another Object (IUnknown)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getExtensionProperties

public IPropertySet getExtensionProperties()
                                    throws IOException,
                                           AutomationException

The extension properties for this object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getExtensionProperties in interface IClass

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

getFullName

public IName getFullName()
                  throws IOException,
                         AutomationException

The associated name object.

Remarks

The FullName property returns a Name object for the dataset. The Name object can be persisted and provides a way to get back to the dataset in a future session of the application, via the Open method on the Name object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getFullName in interface IDataset

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

getBrowseName

public String getBrowseName()
                     throws IOException,
                            AutomationException

The browse name of the dataset.

Remarks

BrowseName returns file names without their extension. For example, States.shp would appear as States.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getBrowseName in interface IDataset

Returns:: The name
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setBrowseName

public void setBrowseName(String name)
                   throws IOException,
                          AutomationException

The browse name of the dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setBrowseName in interface IDataset

Parameters:: name - The name (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws IOException,
                   AutomationException

The type of the Dataset.

Remarks

The Type property returns the an esriDatasetType value indicating the dataset type, such as esriDTTable or esriDTFeatureClass.

Example:


// Assume we have a reference to an IfeatureClass (pFeatureClass)

      IDataset pDataset = null;


      pDataset = new IDatasetProxy(pFeatureClass);


      System.out.println(pDataset.getName() + " " + pDataset.getType());


      if(pFeatureClass != null){


        pDataset = pFeatureClass.getFeatureDataset();


        System.out.println(pDataset.getName() + " " + pDataset.getType());


      }


      pDataset = new IDatasetProxy(pDataset.getWorkspace());


     System.out.println(pDataset.getName() + " " + 
pDataset.getType());

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getType in interface IDataset

Returns:: A com.esri.arcgis.geodatabase.esriDatasetType constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getCategory

public String getCategory()
                   throws IOException,
                          AutomationException

The category of the dataset.

Remarks

IDataset::Category returns a description of the category of the dataset. The description returned from the Category property is the same value that is displayed in the Type column within the Contents tab in ArcCatalog. The value will contain a description of the dataset such as "Topology" prefixed with a description of the type of workspace containing the dataset such as "File Geodatabase".

The description returned from IDataset::Category may change between releases of ArcGIS. In addition to this, returned strings are localized, meaning that code relying on a specific string being provided may fail when deployed with a different version of ArcGIS than it was developed with, or when deployed to a client using a different language than it was developed with.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getCategory in interface IDataset

Returns:: The category
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSubsets

public IEnumDataset getSubsets()
                        throws IOException,
                               AutomationException

Datasets contained within this dataset.

Description

The Subsets property returns other Dataset objects contained in this dataset.

Remarks

IDataset::Subsets is not supported for Graph objects such as a Geometric Network. To return the feature classes contained in a Geometric Network, use the IFeatureClassContainer interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSubsets in interface IDataset

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

getWorkspace

public IWorkspace getWorkspace()
                        throws IOException,
                               AutomationException

The workspace containing this dataset.

Description

The Workspace property returns the containing workspace for this dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getWorkspace in interface IDataset

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

getPropertySet

public IPropertySet getPropertySet()
                            throws IOException,
                                   AutomationException

The set of properties for the dataset.

Description

The PropertySet property is used to return any additional intrinsic properties (but not metadata properties) that may apply to the dataset. One use of this property is to distinguish between the types of File Geodatabase datafile formats. If called on a Feature Class or Table in a File Geodatabase the Datafile Format property can either be esriFGDBStandardDatafile or esriFGDBCompressedDatafile.

Most datasets do not implement this property and will either raise an error or return a null value if it's called. There are a handful of exceptions that will return property sets; these include the datasets from file geodatabases (as mentioned above) and coverages.

Remarks

Examples of intrinsic properties for which explicit methods exist include the SpatialReference and the Extent methods available on the IGeoDataset interface. In most cases this PropertySet will be empty.

IDataset::PropertySet is not supported for Graph objects such as a Geometric Network.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getPropertySet in interface IDataset

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

canCopy

public boolean canCopy()
                throws IOException,
                       AutomationException

True if this dataset can be copied.

Remarks

The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.

The CanCopy method is supported by:

CAD Drawings
Coverages
DBase Tables
Info Tables
Raster Datasets
SDC datasets
SDC Network Datasets
Shapefiles
Shapefile Network Datasets

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: canCopy in interface IDataset

Returns:: The canCopy
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

copy

public IDataset copy(String copyName,
                     IWorkspace copyWorkspace)
              throws IOException,
                     AutomationException

Copies this dataset to a new dataset with the specified name.

Remarks

IDataset::Copy should only be used with datasets from file-based data sources, such as shapefiles and coverages.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: copy in interface IDataset

Parameters:: copyName - The copyName (in); copyWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.IDataset
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

canDelete

public boolean canDelete()
                  throws IOException,
                         AutomationException

True if this dataset can be deleted.

Remarks

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: canDelete in interface IDataset

Returns:: The canDelete
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

delete

public void delete()
            throws IOException,
                   AutomationException

Deletes this dataset.

Remarks

Certain feature classes, such as network and topology feature classes, cannot be deleted until their containing objects are deleted.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: delete in interface IDataset

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

canRename

public boolean canRename()
                  throws IOException,
                         AutomationException

True if this dataset can be renamed.

Remarks

The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete or rename a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: canRename in interface IDataset

Returns:: The canRename
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

rename

public void rename(String name)
            throws IOException,
                   AutomationException

Renames this Dataset.

Remarks

IDataset::Rename does not support the renaming of Graph objects such as a Geometric Network. In addition, certain feature classes, such as network feature classes, cannot be renamed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: rename in interface IDataset

Parameters:: name - The name (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

onAddField

public void onAddField(IObjectClassSchemaEventsOnAddFieldEvent theEvent)
                throws IOException,
                       AutomationException

This event is fired when a new field is added to the object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: onAddField in interface IObjectClassSchemaEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

onDeleteField

public void onDeleteField(IObjectClassSchemaEventsOnDeleteFieldEvent theEvent)
                   throws IOException,
                          AutomationException

This event is fired when a field is deleted from the object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: onDeleteField in interface IObjectClassSchemaEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

onBehaviorChanged

public void onBehaviorChanged(IObjectClassSchemaEventsOnBehaviorChangedEvent theEvent)
                       throws IOException,
                              AutomationException

This event is fired when the behavior class for the object class changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: onBehaviorChanged in interface IObjectClassSchemaEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

createRow

public IRow createRow()
               throws IOException,
                      AutomationException

Creates a row in the database with a system assigned object ID and null property values.

Remarks

The CreateRow method creates a new row in the underlying database with a system assigned object id value. A row object representing the created row is returned to the caller. The row object returned has the system assigned object ID as the value of the OIDField. All other fields are initialized to null values if they can be made null and to built-in default values appropriate to the type of the field if they cannot be made null.

The caller is responsible for setting the desired field values into the row and calling the Store method on the row. If the table represents an object class with subtypes, then it is the caller�s responsibility to set the default subtype code into the row and call the InitDefaultValues method on the row before storing, if that is the desired result. For tables without object behavior, insert cursors offer a more efficient way for inserting new rows.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: createRow in interface ITable

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

getRow

public IRow getRow(int oID)
            throws IOException,
                   AutomationException

The row from the database with the specified object ID.

Remarks

The GetRow method returns an existing row object, given its object ID value. The caller can query the returned row object for additional object specific interfaces. The retrieved row may be modified; calling Store on the row object after changing it will trigger messages to related objects and will mark the row for committing to the database.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getRow in interface ITable

Parameters:: oID - The oID (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.IRow
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getRows

public ICursor getRows(Object oids,
                       boolean recycling)
                throws IOException,
                       AutomationException

The cursor of rows based on a set of object ids.

Remarks

The GetRows method returns a cursor that may be used to retrieve a set of rows specified by the input array of object id values. See the description of the Search method to understand the meaning of the recycling parameter. It is far more efficient to retrieve a set of rows using the GetRows method than it is to retrieve each individual row using the GetRow method. The retrieved rows may be modified; Store should be called on the row objects after changing them.

The oids parameter should be passed an integer array. For example:

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

// Get a recycling cursor for the OID array.

int[] oids = new int[] { 10844, 10853, 10871 };

ICursor cursor = table.getRows(oids, true);

Specified by:: getRows in interface ITable

Parameters:: oids - A Variant (in); recycling - The recycling (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.ICursor
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

createRowBuffer

public IRowBuffer createRowBuffer()
                           throws IOException,
                                  AutomationException

Creates a row buffer that can be used with an insert cursor.

Remarks

The CreateRowBuffer method creates a new row buffer object in memory and returns it to the caller. No row is created in the database. The returned row buffer does not have an object ID value. The caller can set values into the row buffer and use it as an argument to the InsertRow method on an insert cursor; the latter is obtained by calling the Insert method on the Table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: createRowBuffer in interface ITable

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

updateSearchedRows

public void updateSearchedRows(IQueryFilter queryFilter,
                               IRowBuffer buffer)
                        throws IOException,
                               AutomationException

Update the Rows in the database selected by the specified query.

Description

This method will edit the rows matching the query filter's constraints. The values in each row will be replaced with the corresponding field's value in the provided row buffer. The fields being edited should be specified in the query filter's SubFields property. If the row buffer contains null values, and the SubFields property is not properly set, the row's values will be overwritten with the row buffer's null values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: updateSearchedRows in interface ITable

Parameters:: queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in); buffer - A reference to a com.esri.arcgis.geodatabase.IRowBuffer (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

deleteSearchedRows

public void deleteSearchedRows(IQueryFilter queryFilter)
                        throws IOException,
                               AutomationException

Delete the Rows in the database selected by the specified query.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: deleteSearchedRows in interface ITable

Parameters:: queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

rowCount

public int rowCount(IQueryFilter queryFilter)
             throws IOException,
                    AutomationException

The number of Rows selected by the specified query.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: rowCount in interface ITable

Parameters:: queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Returns:: The numRows
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

ITable_search

public ICursor ITable_search(IQueryFilter queryFilter,
                             boolean recycling)
                      throws IOException,
                             AutomationException

An object cursor that can be used to fetch row objects selected by the specified query.

Product Availability

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

Specified by:: ITable_search in interface ITable

Parameters:: queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in); recycling - The recycling (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.ICursor
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

update

public ICursor update(IQueryFilter queryFilter,
                      boolean recycling)
               throws IOException,
                      AutomationException

Returns a cursor that can be used to update Rows selected by the specified query.

Remarks

The Update method returns an update cursor that can be used to update or delete rows. It offers somewhat faster performance than multiple calls to Store or Delete on row objects fetched using a non-recycling search cursor for tables storing simple rows and simple features. There is no difference in performance for complex objects and features.

When using cursors within an edit session, they should always be scoped to edit operations. In other words, a cursor should be created after an edit operation has begun and should not be used once that edit operation has been stopped or aborted.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: update in interface ITable

Parameters:: queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in); recycling - The recycling (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.ICursor
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

insert

public ICursor insert(boolean useBuffering)
               throws IOException,
                      AutomationException

Returns a cursor that can be used to insert new Rows.

Remarks

The Insert method returns an insert cursor that can be used to bulk insert rows. It offers significantly faster performance than multiple calls to CreateRow and Store for tables storing simple rows and simple features (that is, for tables whose CLSID is esriGeoDatabase.Row, esriGeoDatabase.Object, or esriGeoDatabase.Feature).

Insert cursors on tables containing complex objects use the CreateRow and Store methods to achieve polymorphism, and there is no difference in performance in these cases.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: insert in interface ITable

Parameters:: useBuffering - The useBuffering (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.ICursor
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

select

public ISelectionSet select(IQueryFilter queryFilter,
                            int selType,
                            int selOption,
                            IWorkspace selectionContainer)
                     throws IOException,
                            AutomationException

A selection that contains the object ids selected by the specified query.

Remarks

The Select method returns a selection set that holds either row IDs or row objects from the Table depending on the selection option. Multiple selection sets can be created on the same table. It is up to a client application or object to keep a reference on created selections and use them as appropriate. For example, a FeatureLayer creates and uses selections on a FeatureClass (a type of Table).

The selType parameter determines the type of selection set that will be created: an ID set, a snapshot, or a hybrid. See the ISelectionSet interface for a comparison of the three types.

When calling Select the selectionContainer parameter is no longer required. A null value should be passed as this parameter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: select in interface ITable

Parameters:: queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in); selType - A com.esri.arcgis.geodatabase.esriSelectionType constant (in); selOption - A com.esri.arcgis.geodatabase.esriSelectionOption constant (in); selectionContainer - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.ISelectionSet
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isCanSelect

public boolean isCanSelect()
                    throws IOException,
                           AutomationException

Indicates if the table supports selection.

Remarks

Use CanSelect to determine if you can open a selection set on the table. A situation where CanSelect will be False is a standalone database table without an OID column.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isCanSelect in interface ITableCapabilities

Returns:: The canSelect
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

applies

public boolean applies(Object pUnk)
                throws IOException,
                       AutomationException

Indicates if the receiver can apply the given object at any given time.

Remarks

Applies indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: applies in interface IPropertySupport

Parameters:: pUnk - A reference to another Object (IUnknown) (in)
Returns:: The applies
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

canApply

public boolean canApply(Object pUnk)
                 throws IOException,
                        AutomationException

Indicates if the receiver can apply the given object at that particular moment.

Remarks

CanApply indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: canApply in interface IPropertySupport

Parameters:: pUnk - A reference to another Object (IUnknown) (in)
Returns:: The canApply
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getCurrent

public Object getCurrent(Object pUnk)
                  throws IOException,
                         AutomationException

The object currently being used.

Product Availability

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

Specified by:: getCurrent in interface IPropertySupport

Parameters:: pUnk - A reference to another Object (IUnknown) (in)
Returns:: A reference to another Object (IUnknown)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

apply

public Object apply(Object newObject)
             throws IOException,
                    AutomationException

Applies the given property to the receiver and returns the old object.

Remarks

Apply will apply the specified object to the current object. For instance, I might apply a Color object to my RectangleElement. When I execute Apply, the object I replace (the old object) is returned.

Use the Applies and CanApply methods to determine if an Apply can be used on an object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: apply in interface IPropertySupport

Parameters:: newObject - A reference to another Object (IUnknown) (in)
Returns:: A reference to another Object (IUnknown)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws IOException,
                                 AutomationException

enumConnectionPoints

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: enumConnectionPoints in interface IConnectionPointContainer

Parameters:: ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws IOException,
                                AutomationException

findConnectionPoint

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: findConnectionPoint in interface IConnectionPointContainer

Parameters:: riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in); ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getExpressionProperties

public IDisplayExpressionProperties getExpressionProperties()
                                                     throws IOException,
                                                            AutomationException

Properties that describe the display expression.

Product Availability

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

Specified by:: getExpressionProperties in interface IDisplayString

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

setExpressionPropertiesByRef

public void setExpressionPropertiesByRef(IDisplayExpressionProperties displayExpressionProperties)
                                  throws IOException,
                                         AutomationException

Properties that describe the display expression.

Product Availability

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

Specified by:: setExpressionPropertiesByRef in interface IDisplayString

Parameters:: displayExpressionProperties - A reference to a com.esri.arcgis.carto.IDisplayExpressionProperties (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

findDisplayString

public String findDisplayString(IObject pObject)
                         throws IOException,
                                AutomationException

Finds the display string for the given feature based on the current expression properties.

Product Availability

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

Specified by:: findDisplayString in interface IDisplayString

Parameters:: pObject - A reference to a com.esri.arcgis.geodatabase.IObject (in)
Returns:: The text
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

identifyEx

public IArray identifyEx(IDisplay pDisplay,
                         IGeometry pGeom,
                         ITrackCancel pTrackCancel)
                  throws IOException,
                         AutomationException

Identifies objects at the specified location for the given display.

Product Availability

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

Specified by:: identifyEx in interface IIdentifyDisplay

Parameters:: pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in); pGeom - A reference to a com.esri.arcgis.geometry.IGeometry (in); pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Returns:: A reference to a com.esri.arcgis.system.IArray
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getFieldInfos

public IFieldInfoSet getFieldInfos()
                            throws IOException,
                                   AutomationException

The fields in order.

Product Availability

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

Specified by:: getFieldInfos in interface IOrderedLayerFields

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

setFieldOrder

public void setFieldOrder(IFieldInfoSet fieldInfoSet)
                   throws IOException,
                          AutomationException

A new order for the fields.

Product Availability

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

Specified by:: setFieldOrder in interface IOrderedLayerFields

Parameters:: fieldInfoSet - A reference to a com.esri.arcgis.carto.IFieldInfoSet (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

onCreateDataset

public void onCreateDataset(IWorkspaceEventsOnCreateDatasetEvent theEvent)
                     throws IOException,
                            AutomationException

This event is fired when a dataset is created.

Remarks

The OnCreateDataset method is fired after a dataset has been created.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: onCreateDataset in interface IWorkspaceEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

onRenameDataset

public void onRenameDataset(IWorkspaceEventsOnRenameDatasetEvent theEvent)
                     throws IOException,
                            AutomationException

This event is fired when a dataset is renamed.

Remarks

The OnRenameDataset method is fired after a dataset has been renamed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: onRenameDataset in interface IWorkspaceEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

onDeleteDataset

public void onDeleteDataset(IWorkspaceEventsOnDeleteDatasetEvent theEvent)
                     throws IOException,
                            AutomationException

This event is fired when a dataset is deleted.

Remarks

The OnDeleteDataset method is fired after a dataset has been created.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: onDeleteDataset in interface IWorkspaceEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:: writeExternal in interface Externalizable

Throws:: IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:: readExternal in interface Externalizable

Throws:: IOException; ClassNotFoundException

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.carto Class CadAnnotationLayer

Product Availability

Supported Platforms

CadAnnotationLayer

CadAnnotationLayer

getClsid

equals

hashCode

getSymbolCount

Product Availability

Supported Platforms

getSymbolNumber

Product Availability

getFont

Product Availability

setFontByRef

Product Availability

Supported Platforms

getFontColor

Product Availability

setFontColorByRef

Product Availability

getTextSymbol

Product Availability

setTextSymbolByRef

Product Availability

getLevelCount

Product Availability

Supported Platforms

getLevelNumber

Product Availability

isLevelVisibility

Product Availability

setLevelVisibility

Product Availability

getArrowSymbol

Product Availability

Supported Platforms

setArrowSymbolByRef

Product Availability

generateGraphics

Product Availability

Supported Platforms

startGeneratingGraphics

Product Availability

Supported Platforms

getNextGraphic

Product Availability

Supported Platforms

nextFeatureAndGraphic

Product Availability

Supported Platforms

generateGraphics

Product Availability

Supported Platforms

startGeneratingGraphics

Product Availability

Supported Platforms

beginAddElements

Product Availability

Supported Platforms

setupAttributeConversion

Product Availability

Supported Platforms

doAddFeature

Product Availability

Supported Platforms

endAddElements

Product Availability

Supported Platforms

clearSymbols

Product Availability

Supported Platforms

startGeneratingSelectedGraphics

Product Availability

nextSelectedFeatureAndGraphic

Product Availability

getDrawingLayerCount

Product Availability

Supported Platforms

com.esri.arcgis.carto
Class CadAnnotationLayer