com.esri.arcgis.display
Interface IMultiLayerMarkerSymbol

All Superinterfaces:
IMarkerSymbol, Serializable
All Known Implementing Classes:
MultiLayerMarkerSymbol

public interface IMultiLayerMarkerSymbol
extends IMarkerSymbol, Serializable

Provides access to members that control the multiLayer marker symbol.

Description

IMultiLayerMarkerSymbol is a marker symbol that contains a list of other markers that are displayed stacked one upon the other. The constituent marker symbols can be of any other IMarkerSymbol interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
ICharacterMarkerSymbol, IPictureMarkerSymbol, IMarkerSymbol, IArrowMarkerSymbol, IMultiLayerMarkerSymbol, ICartographicMarkerSymbol

Method Summary
 void addLayer(IMarkerSymbol markerLayer)
          Add marker symbol layer.
 void clearLayers()
          Remove all symbol layers.
 void deleteLayer(IMarkerSymbol markerLayer)
          Delete marker symbol layer.
 void drawLayer(int index, IGeometry geometry)
          Draw a symbol layer.
 IMarkerSymbol getLayer(int index)
          Marker symbol per index position.
 int getLayerCount()
          Symbol layer count.
 void moveLayer(IMarkerSymbol markerLayer, int toIndex)
          Change layer index position.
 
Methods inherited from interface com.esri.arcgis.display.IMarkerSymbol
getAngle, getColor, getSize, getXOffset, getYOffset, setAngle, setColor, setSize, setXOffset, setYOffset
 

Method Detail

getLayerCount

int getLayerCount()
                  throws IOException,
                         AutomationException
Symbol layer count.

Description

LayerCount returns the number of constituent symbols.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getLayer

IMarkerSymbol getLayer(int index)
                       throws IOException,
                              AutomationException
Marker symbol per index position.

Product Availability

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

Parameters:
index - The index (in)
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.

addLayer

void addLayer(IMarkerSymbol markerLayer)
              throws IOException,
                     AutomationException
Add marker symbol layer.

Description

AddLayer adds the specified marker symbol to a IMultiLayerMarkerSymbol . This symbol will draw in the topmost position in the IMultiLayerMarkerSymbol. The layer can be of any type supported by the IMarkerSymbol interface except types implementing IMultiLayerMarkerSymbol. In this case an E_INVALIDARG HRESULT will be thrown. Therefore, a MultiLayerMarkerSymbol cannot be imbeded within another MultiLayerMarkerSymbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
markerLayer - 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.

deleteLayer

void deleteLayer(IMarkerSymbol markerLayer)
                 throws IOException,
                        AutomationException
Delete marker symbol layer.

Description

DeleteLayer deletes the specified layer in a IMultiLayerMarkerSymbol . Use LayerCount beforehand to determine how many layers currently exist in a IMultiLayerMarkerSymbol .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
markerLayer - 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.

moveLayer

void moveLayer(IMarkerSymbol markerLayer,
               int toIndex)
               throws IOException,
                      AutomationException
Change layer index position.

Description

MoveLayer moves the marker symbol to the specified index in an IMultiLayerMarkerSymbol 's list of constituent symbols. Use LayerCount beforehand to determine how many layers currently exist in a IMultiLayerMarkerSymbol . Note that the marker symbol you specify should be determined using the Layer method on the current IMultiLayerMarkerSymbol .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

clearLayers

void clearLayers()
                 throws IOException,
                        AutomationException
Remove all symbol layers.

Description

ClearLayers removes all layers in an IMultiLayerMarkerSymbol .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

drawLayer

void drawLayer(int index,
               IGeometry geometry)
               throws IOException,
                      AutomationException
Draw a symbol layer.

Description

DrawLayer draws the IMarkerSymbol stored at the specified index within the IMultiLayerMarkerSymbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
index - The index (in)
geometry - 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.