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

IActiveView.ScreenCacheID Property (ArcObjects .NET 10.8 SDK)
ArcObjects Help for .NET developers > ArcObjects Help for .NET developers > ArcObjects namespaces > Carto > ESRI.ArcGIS.Carto > Interfaces > IA > IActiveView Interface > IActiveView.ScreenCacheID Property
ArcGIS Developer Help

IActiveView.ScreenCacheID Property

The screen cache ID that is used to draw the specified phase. .

[Visual Basic .NET]
Public Function get_ScreenCacheID ( _
    ByVal phase As esriViewDrawPhase, _
    ByVal Data As Object _
) As Short
public short get_ScreenCacheID (
    esriViewDrawPhase phase,
    object Data
HRESULT get_ScreenCacheID(
  esriViewDrawPhase phase,
  System.Int16* cacheID
phase [in]

phase is a parameter of type esriViewDrawPhase Data [in]
Data is a parameter of type IUnknown cacheID [out, retval]
cacheID is a parameter of type short*

Product Availability

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


This property is widely used during invalidation (refresh) operations.  For example, IScreenDisplay::Invalidate requires a cacheIndex.  Use this property to get the cacheIndex for the desired draw phase you wish to refresh.  The valid draw phases are held in the esriViewDrawPhase enumeration.

Use the data parameter to invalidate just a specific piece of data.  For example, if a layer is loaded and its cache property is set to TRUE, this layer alone can be invalidated.  A tracking layer is a good example of this.


In C++, use zero for the data parameter to invalidate all data.

See Also

IActiveView Interface | esriViewDrawPhase Constants | IActiveView.Refresh Method | esriViewDrawPhase Constants | IActiveView.ScreenCacheID Property | IActiveView.PartialRefresh Method | IScreenDisplay.Invalidate Method