com.esri.arcgis.display
Interface IMultiLayerLineSymbol

All Superinterfaces:

ILineSymbol, Serializable

All Known Implementing Classes:

MultiLayerLineSymbol

public interface IMultiLayerLineSymbol
extends ILineSymbol, Serializable

Provides access to members that control the multilayer line symbol.

Description

IMultiLayerLineSymbol is used for creating composite line symbols consisting of multiple layers. A layer can be of any type that is supported by the ILineSymbol interface. Use the ILineSymbol interface for setting additional properties.

Product Availability

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

See Also:

ILineSymbol

Method Summary

void	addLayer(ILineSymbol lineLayer) Adds a layer to the line symbol.
void	clearLayers() Removes all line symbol layers.
void	deleteLayer(ILineSymbol lineLayer) Deletes a layer from the line symbol.
void	drawLayer(int index, IGeometry geometry) Draws a line symbol layer.
ILineSymbol	getLayer(int index) Line symbol per index value.
int	getLayerCount() The number of layers in the symbol.
void	moveLayer(ILineSymbol lineLayer, int toIndex) Move line symbol layer to different layer position.

Methods inherited from interface com.esri.arcgis.display.ILineSymbol

getColor, getWidth, setColor, setWidth

Method Detail

getLayerCount

int getLayerCount()
                  throws IOException,
                         AutomationException

The number of layers in the symbol.

Description

LayerCount returns the total number of layers currently contained in the IMultiLayerLineSymbol.

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

ILineSymbol getLayer(int index)
                     throws IOException,
                            AutomationException

Line symbol per index value.

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.ILineSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addLayer

void addLayer(ILineSymbol lineLayer)
              throws IOException,
                     AutomationException

Adds a layer to the line symbol.

Description

AddLayer adds a single layer to the IMultiLayerLineSymbol. The layer can be of any type supported by the ILineSymbol interface except types implementing IMultiLayerLineSymbol. In this case an E_INVALIDARG HRESULT will be thrown. Therefore, a MultiLayerLineSymbol cannot be imbeded within another MultiLayerLineSymbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

lineLayer - A reference to a com.esri.arcgis.display.ILineSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteLayer

void deleteLayer(ILineSymbol lineLayer)
                 throws IOException,
                        AutomationException

Deletes a layer from the line symbol.

Description

DeleteLayer deletes the layer at the given index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

lineLayer - A reference to a com.esri.arcgis.display.ILineSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

moveLayer

void moveLayer(ILineSymbol lineLayer,
               int toIndex)
               throws IOException,
                      AutomationException

Move line symbol layer to different layer position.

Description

MoveLayer moves the spcefied ILineSymbol to the specified index within the IMultiLayerLineSymbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

lineLayer - A reference to a com.esri.arcgis.display.ILineSymbol (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

Removes all line symbol layers.

Description

ClearLayers removes all the layers contained within the IMultiLayerLineSymbol.

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

Draws a line symbol layer.

Description

DrawLayer draws the ILineSymbol stored at the specified index within the IMultiLayerLineSymbol.

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.