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


IMap.MapSurround Property (ArcObjects .NET 10.5 SDK)
ArcObjects Help for .NET developers > ArcObjects namespaces > Carto > ESRI.ArcGIS.Carto > Interfaces > IM > IMap Interface > IMap.MapSurround Property (ArcObjects .NET 10.5 SDK)
ArcObjects Library Reference (Carto)  

IMap.MapSurround Property

The map surround at the given index.

[Visual Basic .NET]
Public Function get_MapSurround ( _
    ByVal Index As Integer _
) As IMapSurround

[C#]
public IMapSurround get_MapSurround (
    int Index
);

[C++]
HRESULT get_MapSurround(
  long Index,
  IMapSurround** MapSurround
);

[C++]

Parameters
Index [in]
  Index is a parameter of type long
MapSurround [out, retval]

  MapSurround is a parameter of type IMapSurround

Product Availability

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

Remarks

MapSurround objects include Legends, North Arrows, Scale Bars, and Scale Text.  Use this property in conjunction with the MapSurroundCount property to loop through all of the MapSurround objects associated with a Map.
The index is 0-based, ranging from 0 to MapSurroundCount - 1.
See AddMapSurround for information on adding new MapSurrounds to a Map.

See Also

IMap Interface | IMap.MapSurroundCount Property | IMap.MapSurround Property | MapFrame Class | MapSurroundFrame Class