ArcObjects Library Reference (Carto)

IActiveView.FocusMap Property

The map that tools and controls act on.

[Visual Basic .NET]
Public Property FocusMap As IMap

[C#]
public IMap FocusMap {get; set;}

[C++]
HRESULT get_FocusMap(
  IMap** activeMap
);

[C++]
HRESULT putref_FocusMap(
  IMap* activeMap
);

[C++]
Parameters
activeMap [out, retval]
  activeMap is a parameter of type IMap
activeMap [in]
  activeMap is a parameter of type IMap

Product Availability

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

Remarks

A user's map may comprise one or more Map objects. Each Map object typically holds layers of data as well as several MapSurround objects such as a Legend. This property returns an IMap reference to the Map object that currently has focus. In ArcMap, the focus map is the one visible in data view and the one selected in layout view.

Changing the focus map fires the IActiveViewEvents::FocusMapChanged event. In ArcMap, the focus map is automatically set to any new Map added.

IMxDocument::FocusMap is a read-only short cut to this property.

.NET Snippets

.NET Samples

Add a custom menu created in .NET to ArcGIS Desktop (Code Files: AddShapefile) | Dynamic display animated zoom (Code Files: AnimatedZoomInTool AnimatedZoomOutTool) |