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


IARControl Interface (ArcObjects .NET 10.8 SDK)
ArcObjects Help for .NET developers > ArcObjects Help for .NET developers > ArcObjects namespaces > PublisherControls > ESRI.ArcGIS.PublisherControls > Interfaces > IA > IARControl Interface
ArcGIS Developer Help

IARControl Interface

Provides access to members on the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Description

The IARControl interface is a starting point for any tasks related to the ArcReaderControl. The interface is used to manipulate the ArcReaderControl object in a number of ways:

Members

Name Description
Method AboutBox Displays a dialog of information about the control.
Read/write property Appearance The appearance of the control.
Read-only property ARCommandInfo The ARCommandInfo contained by the control.
Read/write property ARConfiguration The ARConfiguration used by the control.
Read-only property ARPageLayout The page layout contained within the currently loaded document.
Read-only property ARUnitConverter The ARUnitConverter contained by the control.
Read-only property ARWindowVisible Indicates if the specified control window is visible.
Read/write property BorderStyle The border style of the control.
Method CheckDocument Checks the document filename to determine if its a valid Published Map File (*.PMF), published with permission to load into the control.
Method CopyViewToClipboard Copies the current map or page layout view to the clipboard.
Read/write property CurrentARTool Current active tool for the control.
Read/write property CurrentView The current map or page layout view.
Read-only property CurrentViewType The type of current view.
Read/write property CustomProperty A property to associate data with a control.
Read-only property DocumentComment A comment about the currently loaded Published Map File (*.PMF).
Read/write property DocumentFilename The file name of the currently loaded Published Map File (*.PMF).
Read/write property Enabled Indicates whether the control can respond to user generated events.
Read/write property EnableFileDrop Indicates whether Published Map Files can be dropped onto the control.
Method ExportView Export the current map or page layout view to the file.
Read-only property HasCustomARConfiguration Is the current PMF using settings stored in the PMF.
Method HasDocumentPermission Indicates if the currently loaded Published Map File (*.PMF) was published with the specified permission.
Read-only property hWnd Handle to the window associated with the control.
Method LoadDocument Loads the Published Map File (*.PMF) into the control.
Read/write property MousePointer The mouse cursor displayed over the document.
Read-only property Object A property that returns the underlying control. This can be used when the control is inside a wrapper object that has been added by a development environment.
Method PrintView Send the current map or page layout view to the printer.
Method Refresh Refresh the control's window.
Method ReloadDocument Reloads the currently loaded Published Map File (*.PMF) back into the control.
Read-only property SelectedARLayer The selected ARLayer in the TOC.
Method ShowARWindow Shows or hides the specified control window.
Read/write property ShowMapTips Indicates if map tips are shown when the current view is a map or page layout.
Read/write property ShowScrollbars Indicates if the map and page layout scrollbars are visible.
Method SuppressResizeDrawing Suppress full redraw of control during resize operations.
Read/write property SwipeLayer The swipe layer used by the control.
Read/write property TOCVisible Indicates if the Table of Contents (TOC) is visible.
Read/write property TOCWidth The width of the Table of Contents (TOC) in pixels.
Method UnloadDocument Unloads the currently loaded Published Map File (*.PMF) from the control.
Read-only property ViewHeight The height of the Active View in pixels.
Read-only property ViewLeft The number of pixels between the top of the control and the top of the Active View.
Read-only property ViewTop The number of pixels between the left edge of the control and the left side of the Active View.
Read-only property ViewWidth The width of the Active View in pixels.
Read-only property ViewWindow Handle to the view window associated with the control.

Classes that implement IARControl

Classes Description
ArcReaderControl Esri ArcReaderControl
[Visual Basic .NET]

When querying interface to IARControl in Visual Basic .NET or Visual C# .NET the Object property or container specific code must be used. This is because .NET contains the real control inside a wrapper object known as an host.