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

IDynamicLayer.DynamicLayerDirty Property (ArcObjects .NET 10.8 SDK)
ArcObjects Help for .NET developers > ArcObjects Help for .NET developers > ArcObjects namespaces > Carto > ESRI.ArcGIS.Carto > Interfaces > ID > IDynamicLayer Interface > IDynamicLayer.DynamicLayerDirty Property
ArcGIS Developer Help

IDynamicLayer.DynamicLayerDirty Property

Indicates if the dynamic layer has changed since last drawn for the specified draw phase.

[Visual Basic .NET]
Public Function get_DynamicLayerDirty ( _
    ByVal DynamicDrawPhase As esriDynamicDrawPhase _
) As Boolean
[Visual Basic .NET]
Public Sub set_DynamicLayerDirty ( _
    ByVal DynamicDrawPhase As esriDynamicDrawPhase, _
    ByVal Dirty As Boolean _
public bool get_DynamicLayerDirty (
    esriDynamicDrawPhase DynamicDrawPhase
public void set_DynamicLayerDirty (
    esriDynamicDrawPhase DynamicDrawPhase,
    bool Dirty
HRESULT get_DynamicLayerDirty(
  esriDynamicDrawPhase DynamicDrawPhase,
  Boolean* Dirty
HRESULT put_DynamicLayerDirty(
  esriDynamicDrawPhase DynamicDrawPhase,
DynamicDrawPhase [in]

DynamicDrawPhase is a parameter of type esriDynamicDrawPhase Dirty [out, retval]
Dirty is a parameter of type bool* DynamicDrawPhase [in]
DynamicDrawPhase is a parameter of type esriDynamicDrawPhase Dirty [in]
Dirty is a parameter of type bool

Product Availability

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


Before every dynamic cycle, the dynamic map checks the dirty state of each of the Dynamic Layers in both Immediate and Compiled phases. A dynamic layer needs to report its draw phase to be dirty (return true), in order to signal the Dynamic Map that the layer�s draw commands needs to be regenerated, and the layer need to be redrawn. That will cause the DrawDynamicLayer method with the corresponding draw phase, to be called by the Dynamic Map, and the layer will get redrawn with the new generated set of draw commands.

Note: A Dynamic Layer�s DrawDynamicLayer method in Compiled Phase will be called only if both the dirty of the Compiled phase is set to true, and the Dynamic Layer�s DynamicRecompileRate interval had elapsed as well.

See Also

IDynamicLayer Interface