This document is archived and information here might be outdated.  Recommended version.


ILayerColorLock.LayerColorLock Property (ArcObjects .NET 10.5 SDK)
ArcObjects Library Reference (Display)  

ILayerColorLock.LayerColorLock Property

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

[Visual Basic .NET]
Public Function get_LayerColorLock ( _
    ByVal layerIndex As Integer _
) As Boolean
[Visual Basic .NET]
Public Sub set_LayerColorLock ( _
    ByVal layerIndex As Integer, _
    ByVal colorLock As Boolean _
)
[C#]
public bool get_LayerColorLock (
    int layerIndex
);
[C#]
public void set_LayerColorLock (
    int layerIndex,
    bool colorLock
);
[C++]
HRESULT get_LayerColorLock(
  long layerIndex,
  VARIANT_BOOL* colorLock
);
[C++]
HRESULT put_LayerColorLock(
  long layerIndex,
  VARIANT_BOOL colorLock
);
[C++]

Parameters layerIndex [in] layerIndex is a parameter of type long colorLock [out, retval] colorLock is a parameter of type VARIANT_BOOL layerIndex [in] layerIndex is a parameter of type long colorLock [in] colorLock is a parameter of type VARIANT_BOOL

Product Availability

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

Description

LayerColorLock indicates whether a specefic layer of a MultiLayerFillSymbol, MultiLayerMarkerSymbol or MultiLayerLineSymbol will be limited to the current color. When LayerColorLock is True the color cannot be changed.

Remarks

Set the LayerColorLock to TRUE to lock the color of layer at the given layer index. ISymbol::Put_Color checks this flag to determine if the color changes will be applied.

See Also

ILayerColorLock Interface