com.esri.arcgis.controls
Interface ITOCBuddy

All Superinterfaces:

Serializable

All Known Subinterfaces:

ITOCBuddy2

All Known Implementing Classes:

GlobeBean, GlobeControl, ITOCBuddy2Proxy, ITOCBuddyProxy, MapBean, MapControl, PageLayoutBean, PageLayoutControl, SceneBean, SceneControl

public interface ITOCBuddy
extends Serializable

Provides access to members that control the TOC buddy.

Superseded By

ITOCBuddy2

Description

The ITOCBuddy interface is used to get properties related to the ITOCControl::Buddy.

Product Availability

Available with ArcGIS Engine.

Method Summary

IActiveView	getActiveView() Returns the underlying object implementing basic map and ActiveView.
double	getScale(IBasicMap pBasicMap) Returns the scale of the supplied BasicMap, this allows for objects that do not support IMap.

Method Detail

getActiveView

IActiveView getActiveView()
                          throws IOException,
                                 AutomationException

Returns the underlying object implementing basic map and ActiveView. This is used to populate the TOC.

Description

The GetActiveView method returns the IActiveView interface of the ITOCControl::Buddy. This will either be a Map, PageLayout, Scene or Globe.

Product Availability

Available with ArcGIS Engine.

Returns:

A reference to a com.esri.arcgis.carto.IActiveView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getScale

double getScale(IBasicMap pBasicMap)
                throws IOException,
                       AutomationException

Returns the scale of the supplied BasicMap, this allows for objects that do not support IMap.

Description

The GetScale method returns scale of the supplied Map or Scene. If the scale is unknown the GetScale method returns 0.0.

Product Availability

Available with ArcGIS Engine.

Parameters:

pBasicMap - A reference to a com.esri.arcgis.carto.IBasicMap (in)

Returns:

The dScale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.