Interface IMapLayerInfo

Namespace
ESRI.ArcGIS.Carto
Assembly
ESRI.Server.Carto.dll

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

[Guid("CA469C38-C9E4-4DC3-9C32-86AEF3B33DF2")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface IMapLayerInfo

Properties

CanFind

Indicates if the layer supports the Find operation.

bool CanFind { get; }

Property Value

bool

CanIdentify

Indicates if the layer supports the Identify operation.

bool CanIdentify { get; }

Property Value

bool

CanScaleSymbols

Indicates if the layer supports symbol scaling.

bool CanScaleSymbols { get; }

Property Value

bool

CanSelect

Indicates if the layer supports feature selection.

bool CanSelect { get; }

Property Value

bool

Description

The description of the layer. This property is set in the General tab of the Layer Properties dialog.

string Description { get; }

Property Value

string

DisplayField

Primary display field.

string DisplayField { get; }

Property Value

string

Extent

The geographic extent of the layer.

IEnvelope Extent { get; }

Property Value

IEnvelope

FieldAliases

Array of strings that contains field alias for each field in Fields property.

IStringArray FieldAliases { get; }

Property Value

IStringArray

Fields

Array of attribute fields contained in the layer.

IFields Fields { get; }

Property Value

IFields

HasAttributes

Indicates if the layer has attributes.

bool HasAttributes { get; }

Property Value

bool

Indicates if the layer has hyperlinks.

bool HasHyperlinks { get; }

Property Value

bool

HasLabels

Indicates if the layer has labels to turn on and off.

bool HasLabels { get; }

Property Value

bool

ID

The layer identifier. This ID is used throughout to uniquely identify the layer for all requests.

int ID { get; }

Property Value

int

Remarks

ID is a unique identifier for a layer in a given instance of ArcGIS for Server map service. It is important to note that ID, SourceID and the index of layers (see MapLayerInfos) in map document are not the same. SourceID is used for map service interaction with the GPServer.

When a map service is published, a unique ID is assigned to all layers within the original map document (.mxd) starting from 0 (zero). This ID is accessible from IMapServerObjects2, MapLayerInfo, LayerDescription, MapServerLegendInfo, MapServerIdentifyResult, MapServerFindResult and FeatureExtent.

ID is not re-usable and does not change if the order of the layer is changed. This would change the how each layer is ordered in the index of layers. Adding new a layer results in a new ID being assigned.  IDs keep incrementing as new layers are added to the map service. The limit of id numbers available is the limit of Long data type.

Please note that if the layer order in the TOC of the original map is changed or if layers are added/removed, the IDs will change accordingly.

IsComposite

Indicates if the layer is a composite layer.

bool IsComposite { get; }

Property Value

bool

IsFeatureLayer

Indicates if the layer is a feature layer.

bool IsFeatureLayer { get; }

Property Value

bool

MaxScale

The maximum visible scale for the layer.

double MaxScale { get; }

Property Value

double

MinScale

The minimum visible scale for the layer.

double MinScale { get; }

Property Value

double

Name

The name of the layer.

string Name { get; }

Property Value

string

ParentLayerID

If the layer is a member of a composite layer, this property identifies the parent layer.

int ParentLayerID { get; }

Property Value

int

SourceDescription

The description of the source information for the layer.

string SourceDescription { get; }

Property Value

string

Remarks

With ArcGIS Server 9.3 release, this property is deprecated and always returns empty string.

SubLayers

The list identifying the sublayers if the layer is a composite layer.

ILongArray SubLayers { get; }

Property Value

ILongArray

Type

The layer type.

string Type { get; }

Property Value

string