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


IEngineInkEnvironment.OnlyEraseActiveInkSketch Property (ArcObjects .NET 10.4 SDK)
ArcObjects namespaces > Controls > ESRI ArcGIS Controls > Interfaces > IE > IEngineInkEnvironment Interface > IEngineInkEnvironment.OnlyEraseActiveInkSketch Property (ArcObjects .NET 10.4 SDK)
ArcObjects Library Reference (Controls)  

IEngineInkEnvironment.OnlyEraseActiveInkSketch Property

Indicates if only the active ink sketch may be erased.

[Visual Basic .NET]
Public Property OnlyEraseActiveInkSketch As Boolean

[C#]
public bool OnlyEraseActiveInkSketch {get; set;}

[C++]
HRESULT get_OnlyEraseActiveInkSketch(
  VARIANT_BOOL* onlyActive
);

[C++]
HRESULT put_OnlyEraseActiveInkSketch(
  VARIANT_BOOL onlyActive
);

[C++]

Parameters
onlyActive [out, retval]
  onlyActive is a parameter of type VARIANT_BOOL
onlyActive [in]
  onlyActive is a parameter of type VARIANT_BOOL

Product Availability

Available with ArcGIS Engine.

Description

Indicates whether or not the ControlsInkEraserTool can delete just the active ink sketch or any ink from the map. When the OnlyEraseActiveInkSketch is set to true the ControlsInkEraserTool will only remove ink that has not yet been committed (i.e. active). When the OnlyEraseActiveInkSketch is set to false the ControlsInkEraserTool will delete any ink from the map.

By default only the active ink sketch can be erased.

See Also

IEngineInkEnvironment Interface