ArcObjects Library Reference (Carto)

IMap.CreateMapSurround Method

[Visual Basic .NET]
Public Function CreateMapSurround ( _
    ByVal clsid As UID, _
    ByVal optionalStyle As IMapSurround _
) As IMapSurround

[C#]
public IMapSurround CreateMapSurround (
    UID clsid,
    IMapSurround optionalStyle
);

[C++]
HRESULT CreateMapSurround(
  IUID* clsid,
  IMapSurround* optionalStyle,
  IMapSurround** MapSurround
);

[C++]
Parameters
clsid [in]
  clsid is a parameter of type IUID
optionalStyle [in]
  optionalStyle is a parameter of type IMapSurround
MapSurround [out, retval]
  MapSurround is a parameter of type IMapSurround

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

The CreateMapSurround method creates a new MapSurround object based on the required GUID parameter.  The optional style parameter specifies a partially initialized surround that comes from the style gallery.  For example, there are an entire collection of north arrows in the style gallery, use this parameter to specify the desired one.

CreateMapSurround automatically calls AddMapSurround to associate the new surround with the Map.

In the ArcMap application, the model for MapSurround objects is that each surround is contained by a separate MapSurroundFrame which has a relation to a MapFrame which holds the Map.  The CreateMapSurround method does not follow this model and is exposed for developers who want to create surrounds in a different window.  To keep with ArcMap's surround model, use IMapFrame::CreateSurroundFrame.  This method automatically creates a new MapSurroundFrame object with a MapSurround and associates them with the Map.