com.esri.arcgis.arcmapui
Interface IBasicDocument

All Superinterfaces:

Serializable

All Known Implementing Classes:

IBasicDocumentProxy, MxDocument

public interface IBasicDocument
extends Serializable

Provides access to members that control the Basic Document.

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	addLayer(ILayer pLayer) Adds a layer to the current focus map or scene.
Object	getContextItem() The last item that was right-clicked.
Object	getSelectedItem() The selected item in the layer control.
ILayer	getSelectedLayer() The selected layer in the layer control.
ITableProperties	getTableProperties() Table properties, for Layers and Tables.
void	setContextItem(Object ppItem) The last item that was right-clicked.
void	updateContents() Notifies the document that the contents have been updated.

Method Detail

getSelectedLayer

ILayer getSelectedLayer()
                        throws IOException,
                               AutomationException

The selected layer in the layer control.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectedItem

Object getSelectedItem()
                       throws IOException,
                              AutomationException

The selected item in the layer control.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContextItem

Object getContextItem()
                      throws IOException,
                             AutomationException

The last item that was right-clicked.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setContextItem

void setContextItem(Object ppItem)
                    throws IOException,
                           AutomationException

The last item that was right-clicked.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

ppItem - A reference to another Object (IUnknown) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addLayer

void addLayer(ILayer pLayer)
              throws IOException,
                     AutomationException

Adds a layer to the current focus map or scene.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateContents

void updateContents()
                    throws IOException,
                           AutomationException

Notifies the document that the contents have been updated.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTableProperties

ITableProperties getTableProperties()
                                    throws IOException,
                                           AutomationException

Table properties, for Layers and Tables.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.arcmapui.ITableProperties

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.