com.esri.arcgis.carto
Interface ILayerDescription2

All Superinterfaces:

ILayerDescription, Serializable

All Known Subinterfaces:

ILayerDescription3

All Known Implementing Classes:

LayerDescription

public interface ILayerDescription2
extends ILayerDescription, Serializable

Provides access to the available properties of a layer description object.

Superseded By

ILayerDescription3

Product Availability

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

Method Summary

IFillSymbol	getSelectionBufferSymbol() Symbol used for drawing selection buffer.
String	getSourceID() The id of the source to use when drawing the layer.
void	setSelectionBufferSymbolByRef(IFillSymbol bufferSymbol) Symbol used for drawing selection buffer.
void	setSourceID(String srcID) The id of the source to use when drawing the layer.

Methods inherited from interface com.esri.arcgis.carto.ILayerDescription

getDefinitionExpression, getID, getSelectionBufferDistance, getSelectionColor, getSelectionFeatures, getSelectionSymbol, isScaleSymbols, isSetSelectionSymbol, isShowLabels, isShowSelectionBuffer, isVisible, setDefinitionExpression, setID, setScaleSymbols, setSelectionBufferDistance, setSelectionColorByRef, setSelectionFeatures, setSelectionSymbolByRef, setSetSelectionSymbol, setShowLabels, setShowSelectionBuffer, setVisible

Method Detail

getSourceID

String getSourceID()
                   throws IOException,
                          AutomationException

The id of the source to use when drawing the layer.

Remarks

SourceID is used for map service interaction with the GPServer. It is a unique job id assigned to a geoprocessing service each time it runs on the server. This property can be used to find out which geoprocessing job has created this layer.

It is important to note that LayerID, SourceID and the index of layers (see MapLayerInfos) in map document are not the same.

Product Availability

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

Returns:

The srcID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceID

void setSourceID(String srcID)
                 throws IOException,
                        AutomationException

The id of the source to use when drawing the layer.

Product Availability

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

Parameters:

srcID - The srcID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectionBufferSymbol

IFillSymbol getSelectionBufferSymbol()
                                     throws IOException,
                                            AutomationException

Symbol used for drawing selection buffer.

Remarks

Use this property when you want something other than the default symbology to symbolize buffers. Only ISimpleMarkerSymbol, ICharacterMarkerSymbol, IPictureMarkerSymbol, ISimpleLineSymbol and ISimpleFillSymbol, IPictureFillSymbol are supported when accessing a MapServer object through AGSServerConnection (LAN or internet).

Product Availability

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

Returns:

A reference to a com.esri.arcgis.display.IFillSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSelectionBufferSymbolByRef

void setSelectionBufferSymbolByRef(IFillSymbol bufferSymbol)
                                   throws IOException,
                                          AutomationException

Symbol used for drawing selection buffer.

Product Availability

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

Parameters:

bufferSymbol - A reference to a com.esri.arcgis.display.IFillSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.