ArcObjects Library Reference (PublisherControls)  

ArcReaderControl CoClass

ESRI ArcReaderControl

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Description

The ArcReaderControl displays the 'data' and 'layout' views of the ArcReader desktop application, together with its Table of Contents. It provides all of the functionality in the ArcReader desktop application except for a toolbar and status bar.

The ArcReaderControl CoClass provides properties, methods and events for managing the general appearance of the control, checking and loading Published Map Files and checking document permissions. The IARControl::ShowARWindow method can be used to display the built in Find, Printer and Magnifier windows and the IARControl::CurrentARTool property can be used to set the current tool to one of the built in navigation, identify or hyperlink tools.

One of the most important aspects of the ArcReaderControl is the notion of its views;the place where data is drawn. The ArcReaderControl has two views, an ARPageLayout view and an ARMap view. Only one of these views can be visible at a time, and is known as the CurrentView. To perform a spatial or attribute search on a ARMap or Layer use the ArcReaderSearchDef object in conjunction the SearchARFeatures or QueryARFeatures methods on the IARMap or IARLayer interfaces.

The ArcReaderConfiguration object can be used to customize the appearance and behavior of the ArcReaderControl and its built in windows.

Interfaces

Interfaces Description
IARControl Provides access to members on the control.
IARControlDefault Provides access to members on the control.

Event Interfaces

Interfaces Description
IARControlEvents (default) Provides access to events that occur with interaction to the control.

Remarks

The ArcReaderControl and ReaderControl are very similar and have the same self contained object model. The table below summarizes differences between the ArcReaderControl and the ReaderControl.

ArcReaderControl ReaderControl
Control name ArcReaderControl ReaderControl
Type library name esriArcReaderControl esriReaderControl
Required design time license ArcGIS Publisher Extension License ArcGIS Engine Designer License
Required runtime deployment Free ArcReader Application Licensed ArcGIS Engine Runtime
Supported API's COM (ActiveX Control), .NET (Windows Control) COM (ActiveX Control), .NET (Windows Control), Java (Visual Java Bean), C++ (Motif and GTK Widgets)
Supported platforms Windows Windows, UNIX
Contains a set of Reader Commands No Yes
CoCreatable objects ArcReaderSearchDef, ArcReaderConfiguration ARSearchDef, ARConfiguration
Extend with ESRI ArcObjects No Yes, for PMF's published with permission to load into a customized application, and published with unrestriced access to its contents
Develop applications in conjunction with the ToolbarControl and TOCControl No Yes, for PMF's published with permission to load into a customized application, and published with unrestriced access to its contents

There is no need to declare the ArcReaderControl's outbound interface as described below in most development environments, because the interface is automaticlly implemented.

Working with Events

[Visual Basic 6.0]

When working with ArcReaderControl's default outbound interface in Visual Basic 6 declare variables as follows:

Private WithEvents pArcReaderControl as ArcReaderControl