com.esri.arcgis.carto
Interface IMapLayerInfo3

All Superinterfaces:
Serializable
All Known Implementing Classes:
MapLayerInfo

public interface IMapLayerInfo3
extends Serializable

Provides access to the available properties of a map layer info object.

Product Availability

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


Method Summary
 String getCopyrightText()
          Copyright information associated with the layer.
 String getDescription()
          The description of the layer.
 String getDisplayField()
          Primary display field.
 IEnvelope getExtent()
          The geographic extent of the layer.
 IStringArray getFieldAliases()
          Array of strings that contains field alias for each field in Fields property.
 IFields getFields()
          Array of attribute fields contained in the layer.
 int getID()
          The layer identifier.
 double getMaxScale()
          The maximum visible scale for the layer.
 double getMinScale()
          The minimum visible scale for the layer.
 String getName()
          The name of the layer.
 int getParentLayerID()
          If the layer is a member of a composite layer, this property identifies the parent layer.
 String getSourceDescription()
          The description of the source information for the layer.
 ILongArray getSubLayers()
          The list identifying the sublayers if the layer is a composite layer.
 String getType()
          The layer type.
 boolean isCanFind()
          Indicates if the layer supports the Find operation.
 boolean isCanIdentify()
          Indicates if the layer supports the Identify operation.
 boolean isCanScaleSymbols()
          Indicates if the layer supports symbol scaling.
 boolean isCanSelect()
          Indicates if the layer supports feature selection.
 boolean isComposite()
          Indicates if the layer is a composite layer.
 boolean isFeatureLayer()
          Indicates if the layer is a feature layer.
 boolean isHasAttributes()
          Indicates if the layer has attributes.
 boolean isHasHyperlinks()
          Indicates if the layer has hyperlinks.
 boolean isHasLabels()
          Indicates if the layer has labels to turn on and off.
 boolean isHasLayerDrawingDescription()
          Indicates if the layter has LayerDrawingDescription or not.
 

Method Detail

isHasLayerDrawingDescription

boolean isHasLayerDrawingDescription()
                                     throws IOException,
                                            AutomationException
Indicates if the layter has LayerDrawingDescription or not.

Product Availability

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

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

getFieldAliases

IStringArray getFieldAliases()
                             throws IOException,
                                    AutomationException
Array of strings that contains field alias for each field in Fields property.

Product Availability

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

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

getCopyrightText

String getCopyrightText()
                        throws IOException,
                               AutomationException
Copyright information associated with the layer.

Product Availability

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

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

getID

int getID()
          throws IOException,
                 AutomationException
The layer identifier. This ID is used throughout to uniquely identify the layer for all requests.

Product Availability

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

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

getName

String getName()
               throws IOException,
                      AutomationException
The name of the layer.

Product Availability

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

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

getDescription

String getDescription()
                      throws IOException,
                             AutomationException
The description of the layer. This property is set in the General tab of the Layer Properties dialog.

Product Availability

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

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

getType

String getType()
               throws IOException,
                      AutomationException
The layer type.

Product Availability

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

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

getSourceDescription

String getSourceDescription()
                            throws IOException,
                                   AutomationException
The description of the source information for the layer.

Remarks

Note: It has been deprecated.

Product Availability

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

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

isHasLabels

boolean isHasLabels()
                    throws IOException,
                           AutomationException
Indicates if the layer has labels to turn on and off.

Remarks

HasLabels returns True only when the label of the layer is turned on in the source map document.

In case where the layer has label but is turned off in the source map document, MapServer returns False.

You may want to use label's scale visibility, when you do not want to draw label all the time.

Product Availability

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

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

isCanSelect

boolean isCanSelect()
                    throws IOException,
                           AutomationException
Indicates if the layer supports feature selection.

Product Availability

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

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

isCanScaleSymbols

boolean isCanScaleSymbols()
                          throws IOException,
                                 AutomationException
Indicates if the layer supports symbol scaling.

Product Availability

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

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

isCanIdentify

boolean isCanIdentify()
                      throws IOException,
                             AutomationException
Indicates if the layer supports the Identify operation.

Product Availability

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

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

isCanFind

boolean isCanFind()
                  throws IOException,
                         AutomationException
Indicates if the layer supports the Find operation.

Product Availability

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

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

isFeatureLayer

boolean isFeatureLayer()
                       throws IOException,
                              AutomationException
Indicates if the layer is a feature layer.

Product Availability

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

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

getMinScale

double getMinScale()
                   throws IOException,
                          AutomationException
The minimum visible scale for the layer.

Product Availability

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

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

getMaxScale

double getMaxScale()
                   throws IOException,
                          AutomationException
The maximum visible scale for the layer.

Product Availability

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

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

getExtent

IEnvelope getExtent()
                    throws IOException,
                           AutomationException
The geographic extent of the layer.

Product Availability

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

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.

isHasHyperlinks

boolean isHasHyperlinks()
                        throws IOException,
                               AutomationException
Indicates if the layer has hyperlinks.

Product Availability

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

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

isHasAttributes

boolean isHasAttributes()
                        throws IOException,
                               AutomationException
Indicates if the layer has attributes.

Product Availability

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

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

getFields

IFields getFields()
                  throws IOException,
                         AutomationException
Array of attribute fields contained in the layer.

Product Availability

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

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.

getDisplayField

String getDisplayField()
                       throws IOException,
                              AutomationException
Primary display field.

Remarks

When DisplayExpression is used by layer in the source map document, MapServer returns the first field used in the DisplayExpression.

Product Availability

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

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

isComposite

boolean isComposite()
                    throws IOException,
                           AutomationException
Indicates if the layer is a composite layer.

Product Availability

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

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

getSubLayers

ILongArray getSubLayers()
                        throws IOException,
                               AutomationException
The list identifying the sublayers if the layer is a composite layer.

Product Availability

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

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

getParentLayerID

int getParentLayerID()
                     throws IOException,
                            AutomationException
If the layer is a member of a composite layer, this property identifies the parent layer.

Product Availability

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

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