com.esri.arcgis.display
Interface ILayerColorLock

All Superinterfaces:

Serializable

All Known Implementing Classes:

MultiLayerFillSymbol, MultiLayerLineSymbol, MultiLayerMarkerSymbol

public interface ILayerColorLock
extends Serializable

Provides access to members that control the layer color locking.

Description

ILayerColorLock is implemented by the multilayer symbol objects: MultiLayerFillSymbol, MultiLayerMarkerSymbol and MultiLayerLineSymbol.

Product Availability

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

Method Summary

boolean	isLayerColorLock(int layerIndex) Indicates if a color lock is present for the layer at the specified index.
void	setAllColorLocked(boolean allLocked) Indicates if the color is locked for all layers.
void	setLayerColorLock(int layerIndex, boolean colorLock) Indicates if a color lock is present for the layer at the specified index.

Method Detail

isLayerColorLock

boolean isLayerColorLock(int layerIndex)
                         throws IOException,
                                AutomationException

Indicates if a color lock is present for the layer at the specified index.

Product Availability

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

Parameters:

layerIndex - The layerIndex (in)

Returns:

The colorLock

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLayerColorLock

void setLayerColorLock(int layerIndex,
                       boolean colorLock)
                       throws IOException,
                              AutomationException

Indicates if a color lock is present for the layer at the specified index.

Product Availability

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

Parameters:

layerIndex - The layerIndex (in)

colorLock - The colorLock (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAllColorLocked

void setAllColorLocked(boolean allLocked)
                       throws IOException,
                              AutomationException

Indicates if the color is locked for all layers.

Description

SetAllColorLocked indicates whether all layers of a MultiLayerFillSymbol, MultiLayerMarkerSymbol or MultiLayerLineSymbol will be locked to their current color.

Remarks

Pass in TRUE to SetAllColorLocked method to prevent the color changes for all the layers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

allLocked - The allLocked (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.