|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IFeatureLayer
Provides access to members that control common aspects of a feature layer.
This interface has properties that specify the feature
class of the layer, the data source type, the primary display
field, whether or not layer symbols scale based on the map's
reference scale, and whether or not the layer is
selectable.
There is also a method Search for
performing a search on the layer. This method returns a cursor of
features from the layer that meet a given search criteria. If there
is a definition query set on the layer, Search
will work on the subset of the features in the layer that meet the
definition criteria. However, the Search method
will not work on joined fields. If the feature layer has any joins,
use the IGeoFeatureLayer::SearchDisplayFeatures
method instead.
IGeoFeatureLayer provides access to all properties and methods of IFeatureLayer plus additional properties to access a layer's feature renderer and labeling properties. Fewer layer types support IGeoFeatureLayer compared to IFeatureLayer.
ILayer
Method Summary | |
---|---|
String |
getDataSourceType()
Data source type. |
String |
getDisplayField()
Primary display field. |
IFeatureClass |
getFeatureClass()
The layer's feature class. |
boolean |
isScaleSymbols()
Indicates if symbols are scaled for the layer. |
boolean |
isSelectable()
Indicates if layer is selectable. |
IFeatureCursor |
search(IQueryFilter queryFilter,
boolean recycling)
Creates a cursor based upon the search criteria. |
void |
setDataSourceType(String text)
Data source type. |
void |
setDisplayField(String fieldName)
Primary display field. |
void |
setFeatureClassByRef(IFeatureClass fclass)
The layer's feature class. |
void |
setScaleSymbols(boolean scale)
Indicates if symbols are scaled for the layer. |
void |
setSelectable(boolean value)
Indicates if layer is selectable. |
Methods inherited from interface com.esri.arcgis.carto.ILayer |
---|
draw, getAreaOfInterest, getMaximumScale, getMinimumScale, getName, getSupportedDrawPhases, getTipText, isCached, isShowTips, isValid, isVisible, setCached, setMaximumScale, setMinimumScale, setName, setShowTips, setSpatialReferenceByRef, setVisible |
Method Detail |
---|
IFeatureClass getFeatureClass() throws IOException, AutomationException
The FeatureClass data source for the layer.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setFeatureClassByRef(IFeatureClass fclass) throws IOException, AutomationException
fclass
- A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.String getDataSourceType() throws IOException, AutomationException
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:"
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" |
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setDataSourceType(String text) throws IOException, AutomationException
text
- The text (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.String getDisplayField() throws IOException, AutomationException
The name of the layer's primary display field.
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.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setDisplayField(String fieldName) throws IOException, AutomationException
fieldName
- The fieldName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isSelectable() throws IOException, AutomationException
Indicates whether the layer's features are selectable.
The default value for Selectable is False.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setSelectable(boolean value) throws IOException, AutomationException
value
- The value (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IFeatureCursor search(IQueryFilter queryFilter, boolean recycling) throws IOException, AutomationException
Use this method to return a read-only cursor of the layer's features.
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.
queryFilter
- A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)recycling
- The recycling (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isScaleSymbols() throws IOException, AutomationException
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.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setScaleSymbols(boolean scale) throws IOException, AutomationException
scale
- The scale (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |