com.esri.arcgis.arcmapui
Interface IBasicDocument2

All Superinterfaces:

Serializable

All Known Implementing Classes:

GMxDocument, IBasicDocument2Proxy, MxDocument, SxDocument

public interface IBasicDocument2
extends Serializable

Provides additional 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.
IActiveView	getActivatedView() The activated view.
Object	getContextItem() The last item that was right-clicked.
IPoint	getCurrentLocation() The current mouse location in map units.
IMap	getFocusMap() The current focus map.
IMaps	getMaps() The collection of maps in the document.
IOperationStack	getOperationStack() The operation stack.
IPageLayout	getPageLayout() The page layout.
double	getSearchTolerance() The global search tolerance in geographic units for selection.
int	getSearchTolerancePixels() The global search tolerance in pixels for selection.
Object	getSelectedItem() The selected item in the layer control.
ILayer	getSelectedLayer() The selected layer in the layer control.
IStyleGallery	getStyleGallery() Reference to the document's Style Gallery.
ITableProperties	getTableProperties() Table properties, for Layers and Tables.
void	setContextItem(Object ppItem) The last item that was right-clicked.
void	setCurrentLocation(IPoint mouseLoc) The current mouse location in map units.
void	setPageLayoutByRef(IPageLayout pageLayout) The page layout.
void	setSearchTolerancePixels(int tol) The global search tolerance in pixels for selection.
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.

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.

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.

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.

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.

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.

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.

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.

setPageLayoutByRef

void setPageLayoutByRef(IPageLayout pageLayout)
                        throws IOException,
                               AutomationException

The page layout.

Product Availability

Available with ArcGIS Desktop.

Parameters:

pageLayout - A reference to a com.esri.arcgis.carto.IPageLayout (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPageLayout

IPageLayout getPageLayout()
                          throws IOException,
                                 AutomationException

The page layout.

Product Availability

Available with ArcGIS Desktop.

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActivatedView

IActiveView getActivatedView()
                             throws IOException,
                                    AutomationException

The activated view. This is the same as the active view unless a data frame is activated within a layout.

Product Availability

Available with ArcGIS Desktop.

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.

getFocusMap

IMap getFocusMap()
                 throws IOException,
                        AutomationException

The current focus map.

Product Availability

Available with ArcGIS Desktop.

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStyleGallery

IStyleGallery getStyleGallery()
                              throws IOException,
                                     AutomationException

Reference to the document's Style Gallery.

Product Availability

Available with ArcGIS Desktop.

Returns:

A reference to a com.esri.arcgis.display.IStyleGallery

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSearchTolerance

double getSearchTolerance()
                          throws IOException,
                                 AutomationException

The global search tolerance in geographic units for selection.

Product Availability

Available with ArcGIS Desktop.

Returns:

The tol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSearchTolerancePixels

int getSearchTolerancePixels()
                             throws IOException,
                                    AutomationException

The global search tolerance in pixels for selection.

Product Availability

Available with ArcGIS Desktop.

Returns:

The tol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSearchTolerancePixels

void setSearchTolerancePixels(int tol)
                              throws IOException,
                                     AutomationException

The global search tolerance in pixels for selection.

Product Availability

Available with ArcGIS Desktop.

Parameters:

tol - The tol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaps

IMaps getMaps()
              throws IOException,
                     AutomationException

The collection of maps in the document.

Product Availability

Available with ArcGIS Desktop.

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOperationStack

IOperationStack getOperationStack()
                                  throws IOException,
                                         AutomationException

The operation stack.

Product Availability

Available with ArcGIS Desktop.

Returns:

A reference to a com.esri.arcgis.systemUI.IOperationStack

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentLocation

IPoint getCurrentLocation()
                          throws IOException,
                                 AutomationException

The current mouse location in map units.

Product Availability

Available with ArcGIS Desktop.

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentLocation

void setCurrentLocation(IPoint mouseLoc)
                        throws IOException,
                               AutomationException

The current mouse location in map units.

Product Availability

Available with ArcGIS Desktop.

Parameters:

mouseLoc - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.