com.esri.arcgis.arcmapui
Interface IMxDocument

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IMxDocumentProxy, MxDocument

public interface IMxDocument
extends java.io.Serializable

COM Interface 'IMxDocument'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriArcMapUI.olb'

Description: 'Provides access to members that control the Mx Document.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID0522a5f1_487c_11d0_98bd_00805f7ced21
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addLayer(ILayer layer) Adds a layer to the current focus map.
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.
java.lang.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.
java.lang.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	setActiveViewByRef(IActiveView activeView) The active view.
void	setContextItem(java.lang.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.

Field Detail

IID0522a5f1_487c_11d0_98bd_00805f7ced21

static final int IID0522a5f1_487c_11d0_98bd_00805f7ced21

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

setPageLayoutByRef

void setPageLayoutByRef(IPageLayout pageLayout)
                        throws java.io.IOException,
                               AutomationException

The page layout.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPageLayout

IPageLayout getPageLayout()
                          throws java.io.IOException,
                                 AutomationException

The page layout.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActiveView

IActiveView getActiveView()
                          throws java.io.IOException,
                                 AutomationException

The active view.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setActiveViewByRef

void setActiveViewByRef(IActiveView activeView)
                        throws java.io.IOException,
                               AutomationException

The active view.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActivatedView

IActiveView getActivatedView()
                             throws java.io.IOException,
                                    AutomationException

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActiveViewCommand

ICommand getActiveViewCommand()
                              throws java.io.IOException,
                                     AutomationException

The command associated with the active view.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFocusMap

IMap getFocusMap()
                 throws java.io.IOException,
                        AutomationException

The current focus map.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectedLayer

ILayer getSelectedLayer()
                        throws java.io.IOException,
                               AutomationException

The selected layer in the layer control.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectedItem

java.lang.Object getSelectedItem()
                                 throws java.io.IOException,
                                        AutomationException

The selected item in the layer control.

Returns:

A reference to another Object (IUnknown)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContextItem

java.lang.Object getContextItem()
                                throws java.io.IOException,
                                       AutomationException

The last item that was right-clicked.

Returns:

A reference to another Object (IUnknown)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setContextItem

void setContextItem(java.lang.Object item)
                    throws java.io.IOException,
                           AutomationException

The last item that was right-clicked.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStyleGallery

IStyleGallery getStyleGallery()
                              throws java.io.IOException,
                                     AutomationException

Reference to the document's Style Gallery.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addLayer

void addLayer(ILayer layer)
              throws java.io.IOException,
                     AutomationException

Adds a layer to the current focus map.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateContents

void updateContents()
                    throws java.io.IOException,
                           AutomationException

Notifies the document that the contents have been updated.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSearchTolerance

double getSearchTolerance()
                          throws java.io.IOException,
                                 AutomationException

The global search tolerance in geographic units for selection.

Returns:

The tol

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSearchTolerancePixels

int getSearchTolerancePixels()
                             throws java.io.IOException,
                                    AutomationException

The global search tolerance in pixels for selection.

Returns:

The tol

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSearchTolerancePixels

void setSearchTolerancePixels(int tol)
                              throws java.io.IOException,
                                     AutomationException

The global search tolerance in pixels for selection.

Parameters:

tol - The tol (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insertObject

void insertObject()
                  throws java.io.IOException,
                         AutomationException

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canInsertObject

void canInsertObject(boolean[] pEnabled)
                     throws java.io.IOException,
                            AutomationException

Indicates if the document allows objects to be inserted.

Parameters:

pEnabled - The pEnabled (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaps

IMaps getMaps()
              throws java.io.IOException,
                     AutomationException

The collection of maps in the document.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOperationStack

IOperationStack getOperationStack()
                                  throws java.io.IOException,
                                         AutomationException

The operation stack.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultTextFont

Font getDefaultTextFont()
                        throws java.io.IOException,
                               AutomationException

The default font for text.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultTextFontSize

void setDefaultTextFontSize(IFontSize fontSize)
                            throws java.io.IOException,
                                   AutomationException

The default font size for text.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultTextFontSize

IFontSize getDefaultTextFontSize()
                                 throws java.io.IOException,
                                        AutomationException

The default font size for text.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultTextFont

void setDefaultTextFont(Font fontDisp)
                        throws java.io.IOException,
                               AutomationException

The default font for text.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultColor

IColor getDefaultColor(int type)
                       throws java.io.IOException,
                              AutomationException

The default color for the given type.

Parameters:

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultColor

void setDefaultColor(int type,
                     IColor color)
                     throws java.io.IOException,
                            AutomationException

The default color for the given type.

Parameters:

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

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentLocation

IPoint getCurrentLocation()
                          throws java.io.IOException,
                                 AutomationException

The current mouse location in map units.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentLocation

void setCurrentLocation(IPoint mouseLoc)
                        throws java.io.IOException,
                               AutomationException

The current mouse location in map units.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDelayUpdateContents

void setDelayUpdateContents(boolean rhs1)
                            throws java.io.IOException,
                                   AutomationException

Indicates document update notifications should be ignored.

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRelativePaths

boolean isRelativePaths()
                        throws java.io.IOException,
                               AutomationException

Indicates if path names are stored relative to the document.

Returns:

The relPaths

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRelativePaths

void setRelativePaths(boolean relPaths)
                      throws java.io.IOException,
                             AutomationException

Indicates if path names are stored relative to the document.

Parameters:

relPaths - The relPaths (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentContentsView

IContentsView getCurrentContentsView()
                                     throws java.io.IOException,
                                            AutomationException

The current contents view of the document.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentContentsViewByRef

void setCurrentContentsViewByRef(IContentsView view)
                                 throws java.io.IOException,
                                        AutomationException

The current contents view of the document.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContentsViewCount

int getContentsViewCount()
                         throws java.io.IOException,
                                AutomationException

The number of contents views in the document.

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContentsView

IContentsView getContentsView(int index)
                              throws java.io.IOException,
                                     AutomationException

The contents view at the specified index.

Parameters:

index - The index (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTableProperties

ITableProperties getTableProperties()
                                    throws java.io.IOException,
                                           AutomationException

Table properties, for Layers and Tables in ArcMap.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.