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


IARPageLayout.ARMap Property (ArcObjects .NET 10.5 SDK)
ArcObjects Library Reference (PublisherControls)  

IARPageLayout.ARMap Property

The map at the specified index.

[Visual Basic .NET]
Public Function get_ARMap ( _
    ByVal index As Integer _
) As ARMap
[C#]
public ARMap get_ARMap (
    int index
);

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Description

Returns the ARMap at the specified index in the ARPageLayout's map collection. The ARPageLayout stores and manages the entire collection of maps within the PMF document. A document can contain any number of ARMap objects, but will always contain at least one ARMap. Only one ARMap can have focus at any one time and is the FocusARMap.

Errors Returned

2022 800A07E6: The specified map index is invalid 

Remarks

Use a zero-based index to access an ARMap. For example, to get the first ARMap in the map collection, pass an index of 0, and to get the last ARMap in the map collection, pass an index of (ARMapCount - 1).

[C#]

In C# use the get_ARMap method, as indexed property accessors are not supported.

See Also

IARPageLayout Interface