com.esri.arcgis.arcmapui
Class IMxDocumentProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.arcmapui.IMxDocumentProxy

All Implemented Interfaces:

IMxDocument, Externalizable, Serializable

public class IMxDocumentProxy
extends com.esri.arcgis.interop.Dispatch
implements IMxDocument, Serializable

Provides access to members that control the Mx Document.

Remarks

This interface is a starting point for much of the other objects in ArcMap. For example, this interface provides access to the current active view, the currently selected map, all of the maps, and the style gallery. This interface also has many properties reflected in the running application including: the text font, the text size, and the search tolerance. Almost every ArcMap customization uses IMxDocument one way or another.

Obtain a reference to this interface via IApplication::Document.

To edit the contents of a map document saved to a file (*.mxd) outside of an ArcMap session or without instantiating a new Application (ArcMap process), see IMapDocument. IMapDocument provides the ability to edit and save the contents of a map document.







Product Availability

Available with ArcGIS Desktop.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IMxDocumentProxy()
	IMxDocumentProxy(Object obj)
protected	IMxDocumentProxy(Object obj, String iid)

Method Summary

void	addLayer(ILayer layer) Adds a layer to the current focus map.
void	addListener(String iidStr, Object theListener, Object theSource)
void	canInsertObject(boolean[] pEnabled) Indicates if the document allows objects to be inserted.
IActiveView	getActivatedView() The activated view.
IActiveView	getActiveView() The active view.
ICommand	getActiveViewCommand() The command associated with the active view.
IContentsView	getContentsView(int index) The contents view at the specified index.
int	getContentsViewCount() The number of contents views in the document.
Object	getContextItem() The last item that was right-clicked.
IContentsView	getCurrentContentsView() The current contents view of the document.
IPoint	getCurrentLocation() The current mouse location in map units.
IColor	getDefaultColor(int type) The default color for the given type.
Font	getDefaultTextFont() The default font for text.
IFontSize	getDefaultTextFontSize() The default font size for text.
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 in ArcMap.
void	insertObject() Inserts an object into the document.
boolean	isRelativePaths() Indicates if path names are stored relative to the document.
void	removeListener(String iidStr, Object theListener)
void	setActiveViewByRef(IActiveView activeView) The active view.
void	setContextItem(Object item) The last item that was right-clicked.
void	setCurrentContentsViewByRef(IContentsView view) The current contents view of the document.
void	setCurrentLocation(IPoint mouseLoc) The current mouse location in map units.
void	setDefaultColor(int type, IColor color) The default color for the given type.
void	setDefaultTextFont(Font fontDisp) The default font for text.
void	setDefaultTextFontSize(IFontSize fontSize) The default font size for text.
void	setDelayUpdateContents(boolean rhs1) Indicates document update notifications should be ignored.
void	setPageLayoutByRef(IPageLayout pageLayout) The page layout.
void	setRelativePaths(boolean relPaths) Indicates if path names are stored relative to the document.
void	setSearchTolerancePixels(int tol) The global search tolerance in pixels for selection.
void	updateContents() Notifies the document that the contents have been updated.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IMxDocumentProxy

public IMxDocumentProxy()

IMxDocumentProxy

public IMxDocumentProxy(Object obj)
                 throws IOException

Throws:

IOException

IMxDocumentProxy

protected IMxDocumentProxy(Object obj,
                           String iid)
                    throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

setPageLayoutByRef

public void setPageLayoutByRef(IPageLayout pageLayout)
                        throws IOException,
                               AutomationException

The page layout.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setPageLayoutByRef in interface IMxDocument

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

public IPageLayout getPageLayout()
                          throws IOException,
                                 AutomationException

The page layout.

Remarks

This method returns an IPageLayout reference to the PageLayout object. The page layout is the visual representation of a map. A typical page layout is composed of a page and many elements including data, graphics, and text.

From an object point of view, the PageLayout object has a Page object and a collection of Element objects. The page is used to manage page size and printing. Element objects include MapFrames, GraphicElements, and TextElements. Anything that can be placed on a map is a type of element.

Athough, you can programmatically create your own page layout and assign it to the map document, the general practice is to modify the existing one.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getPageLayout in interface IMxDocument

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.

See Also:

IPageLayout

getActiveView

public IActiveView getActiveView()
                          throws IOException,
                                 AutomationException

The active view.

Remarks

This method provides access to the active view. ArcMap currently supports two types of views, layout view and data view; the view with focus is the active view. If ArcMap is in layout view, this property returns an IActiveView reference to the PageLayout object. Alternatively, if ArcMap is in data view, the returned IActiveView reference is to a Map object. Both the PageLayout and Map objects implement the IActiveView interface.

Note, an ArcMap document may have multiple maps (data frames) in it. Multiple maps means multiple Map objects. Any Map in this collection may be set as the active view. There is typically only one PageLayout object per session of ArcMap.

To determine if the returned reference is to a PageLayout object or a Map, attempt a query interface (QI) to either IPageLayout or IMap. If you know you want a reference to the focus map, use IMxDocument::FocusMap instead. Similarly, if you know you want a reference to the page layout, use IMxDocument::PageLayout instead. This is often the case when you need to refresh the display. For example, if someone has panned the map and you now need to refresh it, explicitly use IMxDocument::FocusMap which returns a reference to the Map with focus, and then QI for IActiveView.

Use this property to also set the active view programmatically.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getActiveView in interface IMxDocument

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.

See Also:

IActiveView

setActiveViewByRef

public void setActiveViewByRef(IActiveView activeView)
                        throws IOException,
                               AutomationException

The active view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setActiveViewByRef in interface IMxDocument

Parameters:

activeView - A reference to a com.esri.arcgis.carto.IActiveView (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActivatedView

public 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.

Remarks

This property is primarily used when adding graphics as it conveniently gives a reference to the object set as the target graphics container.

In ArcMap's layout view, graphics can either be added to the PageLayout's graphics container or the focus Map's graphics container if the Map has been activated by double-clicking on it. In this case, IMxDocument::ActiveView differs from IMxDocument::ActivatedView in that the ActiveView property may pass a reference to the PageLayout object while the ActivatedView property may pass a reference to the focus Map object if that Map has been activated. In data view, both ActiveView and ActivatedView return a reference to the focus Map.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getActivatedView in interface IMxDocument

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.

See Also:

com.esri.arcgis.arcmapUI.IActiveView

getActiveViewCommand

public ICommand getActiveViewCommand()
                              throws IOException,
                                     AutomationException

The command associated with the active view.

Remarks

The command associated with the current active view.

In ArcMap the active view can be either a Map (corresponding to Data view in ArcMap) or a PageLayout (corresponding to Layout view in ArcMap). To switch between these different views, ArcMap has two active view commands: GeographicViewCommand and LayoutViewCommand. These commands are the tiny globe and page buttons on the scroll bar and also appear in the View menu. GeographicViewCommand sets the focus Map as the ActiveView and LayoutViewCommand sets the PageLayout as the ActiveView.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getActiveViewCommand in interface IMxDocument

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFocusMap

public IMap getFocusMap()
                 throws IOException,
                        AutomationException

The current focus map.

Remarks

This property is a short-cut to IActiveView::FocusMap and is read-only. To programmatically change the FocusMap use IActiveView::FocusMap.

A user's map may comprise one or more Map objects. Each Map object typically holds layers of data as well as several MapSurround objects such as a Legend. This property returns an IMap reference to the Map object that currently has focus. In ArcMap, the focus map is the one visible in data view and the one selected in layout view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getFocusMap in interface IMxDocument

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.

See Also:

com.esri.arcgis.arcmapUI.IActiveView

getSelectedLayer

public ILayer getSelectedLayer()
                        throws IOException,
                               AutomationException

The selected layer in the layer control.

Remarks

Returns the currently selected layer in the table of contents.

To select a layer in the table of contents, obtain an IContentsView reference via IMxDocument::ContentsView, then use either IContentsView::AddToSelectedItems or IContentsView::SelectedItem. To learn more, read the help for IContentsView.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getSelectedLayer in interface IMxDocument

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

public Object getSelectedItem()
                       throws IOException,
                              AutomationException

The selected item in the layer control.

Remarks

This property returns a reference to the currently selected item in the table of contents. The return is an IUnknown because there are several possbile objects the selected item can be.

When working in the Display tab, the reference could be to a Map object if you have a data frame selected, one of the Layer objects (FeatureLayer, FDOGraphicsLayer, etc) if you have a layer selected, or a LegendGroup if you have a unique value or heading selected.

In the Source tab, the reference can be to any of the above objects plus a Table, FeatureDataset, or Workspace.

In the case where more than one item is selected, the reference is to a Set object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getSelectedItem in interface IMxDocument

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContextItem

public Object getContextItem()
                      throws IOException,
                             AutomationException

The last item that was right-clicked.

Remarks

This property returns the item that was last right-clicked in the table of contents. Use this property when creating a custom context menu. For example, after right-clicking on a layer in the table of contents, a context menu appears which has several commands including Copy and Remove.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getContextItem in interface IMxDocument

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setContextItem

public void setContextItem(Object item)
                    throws IOException,
                           AutomationException

The last item that was right-clicked.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setContextItem in interface IMxDocument

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStyleGallery

public IStyleGallery getStyleGallery()
                              throws IOException,
                                     AutomationException

Reference to the document's Style Gallery.

Remarks

The StyleGallery is an object that manages styles. Styles are a collection of predefined colors, symbols, properties of symbols, and map elements that are used to create maps. Styles help organizations follow a mapping standard and help promote consistency in mapping products.

The StyleGallery is the object underlying the Style Manager window in ArcMap. There is one StyleGallery object per application and it is global. Instantiating a new StyleGallery object really finds the one created by the application.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getStyleGallery in interface IMxDocument

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.

addLayer

public void addLayer(ILayer layer)
              throws IOException,
                     AutomationException

Adds a layer to the current focus map.

Remarks

This method is a shortcut to the AddLayer method on the focus map (IMap::Addlayer).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

addLayer in interface IMxDocument

Parameters:

layer - 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.

See Also:

com.esri.arcgis.arcmapUI.IMap

updateContents

public void updateContents()
                    throws IOException,
                           AutomationException

Notifies the document that the contents have been updated.

Remarks

Refreshes the current view in the table of contents. UpdateContents is a shortcut - it calls Refresh on the current contents view (IContentsView::Refresh). Access to the current view is provided through IMxDocument::CurrentContentsView.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

updateContents in interface IMxDocument

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSearchTolerance

public double getSearchTolerance()
                          throws IOException,
                                 AutomationException

The global search tolerance in geographic units for selection.

Remarks

The application's search tolerance is measured and set using pixel units. This property automatically converts the size of the pixels to map units. The example shows how this conversion is done.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getSearchTolerance in interface IMxDocument

Returns:

The tol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSearchTolerancePixels

public int getSearchTolerancePixels()
                             throws IOException,
                                    AutomationException

The global search tolerance in pixels for selection.

Description

This property controls the application's search tolerance. The search tolerance is measured in pixel units. Use IMxDocument::SearchTolerance to check the search tolerance in map units.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getSearchTolerancePixels in interface IMxDocument

Returns:

The tol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSearchTolerancePixels

public void setSearchTolerancePixels(int tol)
                              throws IOException,
                                     AutomationException

The global search tolerance in pixels for selection.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setSearchTolerancePixels in interface IMxDocument

Parameters:

tol - The tol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insertObject

public void insertObject()
                  throws IOException,
                         AutomationException

Inserts an object into the document. Displays the insert object dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

insertObject in interface IMxDocument

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canInsertObject

public void canInsertObject(boolean[] pEnabled)
                     throws IOException,
                            AutomationException

Indicates if the document allows objects to be inserted.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

canInsertObject in interface IMxDocument

Parameters:

pEnabled - The pEnabled (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaps

public IMaps getMaps()
              throws IOException,
                     AutomationException

The collection of maps in the document.

Remarks

The map document has a collection of Map objects which are accessible through this property. The reference IMaps is typically used to add and delete maps from the collection.

See the FocusMap property on this interface for accessing just the one map with focus.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getMaps in interface IMxDocument

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.

See Also:

IMaps

getOperationStack

public IOperationStack getOperationStack()
                                  throws IOException,
                                         AutomationException

The operation stack.

Remarks

The map document manages an operation stack which provides undo/redo functionality. Modifications, including those to elements and features, are typically wrapped inside an operation. Operations are added to the operation stack so the modification can be rolled out and then rolled back if desired. For example, when a graphic element is moved, the operation can be undone moving the graphic back to its original location.

Depending on your scenario, there are different methodologies for creating an operation and adding it to the OperationStack.

• If your tool edits features and rows, you can use IEditor::StartOperation, and IEditor::StopOperation and the actions in between will be automatically added to the OperationStack as a single operation. Stopping an edit session clears the OperationStack.
• If you are outside an editsession and updating a geodatabase directly, calls to IWorkspaceEdit::StartEditOperation and StopEditOperation will not automatically add anything to ArcMap’s OperationStack since these interfaces are independent of ArcMap, and these changes will be made directly to the geodatabase.
• For other actions, for example on graphic elements, you need to create a custom operation object that implements IOperation. The operation is executed and loaded onto the stack with a call to IOperationStack::Do.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getOperationStack in interface IMxDocument

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.

See Also:

IOperationStack

getDefaultTextFont

public Font getDefaultTextFont()
                        throws IOException,
                               AutomationException

The default font for text.

Remarks

This property conveniently stores a default font for any tool requiring one. For example, the New Text tool adds text graphics to an active view and initially uses the font stored in this property.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getDefaultTextFont in interface IMxDocument

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultTextFontSize

public void setDefaultTextFontSize(IFontSize fontSize)
                            throws IOException,
                                   AutomationException

The default font size for text.

Remarks

This property conveniently stores a default font size for any tool requiring one. For example, the New Text tool adds text graphics to an active view and initially uses the font size stored in this property.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setDefaultTextFontSize in interface IMxDocument

Parameters:

fontSize - A reference to a com.esri.arcgis.display.IFontSize (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultTextFontSize

public IFontSize getDefaultTextFontSize()
                                 throws IOException,
                                        AutomationException

The default font size for text.

Remarks

This property conveniently stores a default font size for any tool requiring one. For example, the New Text tool on ArcMap's Draw toolbar, adds text graphics to an active view and initially uses the font size stored in this property.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getDefaultTextFontSize in interface IMxDocument

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultTextFont

public void setDefaultTextFont(Font fontDisp)
                        throws IOException,
                               AutomationException

The default font for text.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setDefaultTextFont in interface IMxDocument

Parameters:

fontDisp - A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultColor

public IColor getDefaultColor(int type)
                       throws IOException,
                              AutomationException

The default color for the given type.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getDefaultColor in interface IMxDocument

Parameters:

type - A com.esri.arcgis.arcmapui.esriMxDefaultColorTypes constant (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultColor

public void setDefaultColor(int type,
                            IColor color)
                     throws IOException,
                            AutomationException

The default color for the given type.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setDefaultColor in interface IMxDocument

Parameters:

type - A com.esri.arcgis.arcmapui.esriMxDefaultColorTypes constant (in)

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentLocation

public IPoint getCurrentLocation()
                          throws IOException,
                                 AutomationException

The current mouse location in map units.

Remarks

A lot of tools require the current mouse location in order to perform an operation. This property provides a short-cut alternative to having to manually calculate the current mouse location in map units. For example, a typical pan tool needs the current mouse location in three different places: when the mouse if first clicked, while the mouse drags, and when the button is released. Although ITool provides the mouse location for each of these events, the location is given in x,y device units. Rather than writing a function that uses something like IDisplayTransformation::ToMapPoint to calculate the location in map units, the Location property does this automatically behind the scenes.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getCurrentLocation in interface IMxDocument

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

public void setCurrentLocation(IPoint mouseLoc)
                        throws IOException,
                               AutomationException

The current mouse location in map units.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setCurrentLocation in interface IMxDocument

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.

setDelayUpdateContents

public void setDelayUpdateContents(boolean rhs1)
                            throws IOException,
                                   AutomationException

Indicates document update notifications should be ignored.

Remarks

Delays calling refresh of the current contents view. For example, after loading a layer you should call UpdateContents to refresh the contents view (table on contents). When loading several layers, there is no need to refresh the contents view after each layer is loaded; instead, delay refreshing the contents view until all the layers have been loaded.

All calls to UpdateContents are ignored when DelayUpdateContents is set to TRUE. To ensure the contents view is ultimately refreshed, UpdateContents is automatically called when DelayUpdateContents is set back to FALSE.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setDelayUpdateContents in interface IMxDocument

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRelativePaths

public boolean isRelativePaths()
                        throws IOException,
                               AutomationException

Indicates if path names are stored relative to the document.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isRelativePaths in interface IMxDocument

Returns:

The relPaths

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRelativePaths

public void setRelativePaths(boolean relPaths)
                      throws IOException,
                             AutomationException

Indicates if path names are stored relative to the document.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setRelativePaths in interface IMxDocument

Parameters:

relPaths - The relPaths (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentContentsView

public IContentsView getCurrentContentsView()
                                     throws IOException,
                                            AutomationException

The current contents view of the document.

Remarks

A contents view is a tab in the table of contents. ArcMap ships with two contents views, Display and Source. The object behind Display is TOCDisplayView and TOCCatalogView is behind the Source view. Custom contents views can be created by implementing the IContentsView interface. Only one contents view can be active at a time. Use this property to set the current contents view and to get a reference to the current contents view. Setting the current contents view automatically calls IContentsView::Refresh.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getCurrentContentsView in interface IMxDocument

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentContentsViewByRef

public void setCurrentContentsViewByRef(IContentsView view)
                                 throws IOException,
                                        AutomationException

The current contents view of the document.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setCurrentContentsViewByRef in interface IMxDocument

Parameters:

view - A reference to a com.esri.arcgis.arcmapui.IContentsView (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContentsViewCount

public int getContentsViewCount()
                         throws IOException,
                                AutomationException

The number of contents views in the document.

Remarks

A contents view is a tab in the table of contents. ArcMap ships with two contents views: Display (TOCDisplayView) and Source (TOCCatalogView). Create custom contents views by implementing the IContentsView interface. Only one contents view can be active at a time. This property returns the number of contents views registered in the ESRI Contents Views component category. The Display contents view is not listed here as it is the default.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getContentsViewCount in interface IMxDocument

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContentsView

public IContentsView getContentsView(int index)
                              throws IOException,
                                     AutomationException

The contents view at the specified index.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getContentsView in interface IMxDocument

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTableProperties

public ITableProperties getTableProperties()
                                    throws IOException,
                                           AutomationException

Table properties, for Layers and Tables in ArcMap.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getTableProperties in interface IMxDocument

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.