com.esri.arcgis.display
Interface IMultiLayerFillSymbol

All Superinterfaces:

IFillSymbol, Serializable

All Known Implementing Classes:

MultiLayerFillSymbol

public interface IMultiLayerFillSymbol
extends IFillSymbol, Serializable

Provides access to members that control the multilayer fill symbol.

Description

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

Product Availability

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

Method Summary

void	addLayer(IFillSymbol fillLayer) Add fill symbol layer.
void	clearLayers() Remove all symbol layers.
void	deleteLayer(IFillSymbol fillLayer) Delete fill symbol layer.
void	drawLayer(int index, IGeometry geometry) Draw a symbol layer.
IFillSymbol	getLayer(int index) Fill symbol per layer position.
int	getLayerCount() Symbol layer count.
void	moveLayer(IFillSymbol fillLayer, int toIndex) Change symbol layer position index.

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

getColor, getOutline, setColor, setOutline

Method Detail

getLayerCount

int getLayerCount()
                  throws IOException,
                         AutomationException

Symbol layer count.

Description

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

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

IFillSymbol getLayer(int index)
                     throws IOException,
                            AutomationException

Fill symbol per layer 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.IFillSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addLayer

void addLayer(IFillSymbol fillLayer)
              throws IOException,
                     AutomationException

Add fill symbol layer.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

deleteLayer

void deleteLayer(IFillSymbol fillLayer)
                 throws IOException,
                        AutomationException

Delete fill symbol layer.

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:

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

moveLayer

void moveLayer(IFillSymbol fillLayer,
               int toIndex)
               throws IOException,
                      AutomationException

Change symbol layer position index.

Description

MoveLayer moves the spcefied IFillSymbol to the specified index within the IMultiLayerFillSymbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

fillLayer - A reference to a com.esri.arcgis.display.IFillSymbol (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 the layers contained within the IMultiLayerFillSymbol.

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 IFillSymbol stored at the specified index within the IMultiLayerFillSymbol.

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.