MxDocument (ArcObjects Java API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.arcmapui
Class MxDocument

java.lang.Object
  com.esri.arcgis.arcmapui.MxDocument

All Implemented Interfaces:: IBasicDocument, IBasicDocument2, IBasicDocumentDefaultSymbols, IChangeLayout, IContentsViewEdit, IDocumentDefaultSymbols, IMxDocument, IReportUnitFormat, IReportUnitFormat2, IDataGraphCollection, IDocumentInfo, IDocumentInfo2, IDocumentPreview, IMapDocument, IDocumentDatasets, IConnectionPointContainer, IDocument, IDocumentDirty, IDocumentDirty2, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersion, IPersist, IPropertySupport, ISupportErrorInfo, Serializable

public class MxDocument
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDocument, IMxDocument, IDocumentDirty, IDocumentDirty2, IPropertySupport, IChangeLayout, IDocumentDefaultSymbols, IContentsViewEdit, IDataGraphCollection, IDocumentDatasets, IDocumentInfo, IDocumentInfo2, IDocumentPreview, IReportUnitFormat, IReportUnitFormat2, IDocumentVersion, IPersist, IBasicDocument, IBasicDocument2, IBasicDocumentDefaultSymbols, IMapDocument, ISupportErrorInfo, IConnectionPointContainer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDocument, IMxDocument, IDocumentDirty, IDocumentDirty2, IPropertySupport, IChangeLayout, IDocumentDefaultSymbols, IContentsViewEdit, IDataGraphCollection, IDocumentDatasets, IDocumentInfo, IDocumentInfo2, IDocumentPreview, IReportUnitFormat, IReportUnitFormat2, IDocumentVersion, IPersist, IBasicDocument, IBasicDocument2, IBasicDocumentDefaultSymbols, IMapDocument, ISupportErrorInfo, IConnectionPointContainer

ESRI Mx Document.

Description

The map document (MxDocument) is the ArcMap running application. The overall role of the map document is to control the representation of data . This object implements several interfaces including IMxApplication and IDocument. IMxDocument is a starting point for accessing most of the other ArcMap objects including the collection of maps, the page layout, and the style gallery. The IDocument interface provides access to the document's title, type, accelerator table, CommandBars collection, and VBA project.

There is one map document per session of ArcMap. Instantiating a new MxDocument starts a new ArcMap application. Actually, creating a new MxDocument really creates a new Application object which in turn co-creates a new MxDocument.

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.

Supported Platforms

Windows

See Also:: Serialized Form

Constructor Summary
`MxDocument()` Constructs a MxDocument using ArcGIS Engine.
`MxDocument(Object obj)` Construct a MxDocument using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary
`void`	`addContentsView(IContentsView contentsView)` Adds a contents view object to the TOC.
`void`	`addDataGraph(IDataGraphBase graph)` Adds the graph to the collection.
`void`	`addIDataGraphCollectionEventsListener(IDataGraphCollectionEvents theListener)` addIDataGraphCollectionEventsListener.
`void`	`addIDocumentEventsDispListener(IDocumentEventsDisp theListener)` addIDocumentEventsDispListener.
`void`	`addIDocumentEventsListener(IDocumentEvents theListener)` addIDocumentEventsListener.
`void`	`addLayer(ILayer layer)` Adds a layer to the current focus map.
`boolean`	`applies(Object pUnk)` Indicates if the receiver can apply the given object at any given time.
`Object`	`apply(Object newObject)` Applies the given property to the receiver and returns the old object.
`boolean`	`canApply(Object pUnk)` Indicates if the receiver can apply the given object at that particular moment.
`void`	`canInsertObject(boolean[] pEnabled)` Indicates if the document allows objects to be inserted.
`boolean`	`changeLayout()` Indicates if the wizard used to select a new layout is shown.
`void`	`clearContentsViews()` Removes all current contents views.
`void`	`close()` Close the map document.
`void`	`createPreview()` Creates a thumbnail preview of the document.
`void`	`deletePreview()` Deletes the thumbnail preview of the document.
`void`	`enumConnectionPoints(IEnumConnectionPoints[] ppEnum)` enumConnectionPoints
`boolean`	`equals(Object o)` Compare this object with another
`void`	`esri_new(String sDocument)` Creates and opens a new map document in preparation for the contents to be retrieve or updated.
`void`	`findConnectionPoint(GUID riid, IConnectionPoint[] ppCP)` findConnectionPoint
`IAcceleratorTable`	`getAccelerators()` The accelerator table for this document.
`IActiveView`	`getActivatedView()` The activated view.
`IActiveView`	`getActiveView()` The active view.
`ICommand`	`getActiveViewCommand()` The command associated with the active view.
`IAreaPatch`	`getAreaPatch()` Default Area Patch.
`String`	`getAuthor()` The author of the document.
`IFormattedTextSymbol`	`getCallout()` Default Callout.
`String`	`getCategory()` The category of the document.
`void`	`getClassID(GUID[] pClassID)` getClassID
`static String`	`getClsid()` getClsid.
`ICommandBars`	`getCommandBars()` The commandbars collection in this document.
`String`	`getComments()` Comments for the document.
`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.
`ILatLonFormat`	`getCoordinateReadoutLatLonFormat()` The format used for the coordinate readout on the status bar.
`int`	`getCoordinateReadoutUnits()` The units used for the coordinate readout on the status bar.
`String`	`getCredits()` The credits of the document.
`Object`	`getCurrent(Object pUnk)` The object currently being used.
`IContentsView`	`getCurrentContentsView()` The current contents view of the document.
`IPoint`	`getCurrentLocation()` The current mouse location in map units.
`Font`	`getCustomTOCFont()` Custom TOC Font.
`double`	`getCustomTOCFontSize()` Custom TOC Font Size in Points.
`IDataGraphBase`	`getDataGraph(int index)` Graph at the given index.
`int`	`getDataGraphCount()` Number of graphs in the collection.
`IEnumDataset`	`getDatasets()` The datasets in the document.
`Object`	`getDateExported()` Date the document was last exported.
`Object`	`getDatePrinted()` Date the document was last printed.
`Object`	`getDateSaved()` Date the document was last saved.
`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.
`String`	`getDocumentFilename()` The map document filename that the MapDocument coclass is linked to.
`String`	`getDocumentTitle()` The title of the document.
`int`	`getDocumentType()` The type of map document currently loaded in the object.
`int`	`getDocumentVersion()` The version of the document to save.
`IFillSymbol`	`getFillSymbol()` Default Fill Symbol.
`IMap`	`getFocusMap()` The current focus map.
`String`	`getFolder()` The folder of the document.
`String`	`getHyperlinkBase()` The hyperlink base of the document.
`IUID`	`getID()` The unique id for this document.
`String`	`getKeywords()` The keywords for the document.
`ILatLonFormat`	`getLatLonFormat()` The format object used for reporting lat-lon values.
`ILayer`	`getLayer(int mapIndex, int layerIndex)` The Layer object at the specified index for the specified map.
`ILinePatch`	`getLinePatch()` Default Line Patch.
`ILineSymbol`	`getLineSymbol()` Default Line Symbol.
`IMap`	`getMap(int mapIndex)` The Map object at the specified index.
`int`	`getMapCount()` The number of Map objects contained within the map document.
`IMaps`	`getMaps()` The collection of maps in the document.
`IMarkerSymbol`	`getMarkerSymbol()` Default Marker Symbol.
`String`	`getName()` The name of the document.
`INumberFormat`	`getNumericFormat()` The format object used for reporting numeric values.
`IOperationStack`	`getOperationStack()` The operation stack.
`IPageLayout`	`getPageLayout()` The page layout.
`IApplication`	`getParent()` The application in which this document is open.
`double`	`getPatchHeight()` Default Patch Height in Points.
`double`	`getPatchWidth()` Default Patch Width in Points.
`String`	`getPath()` The path of the document.
`IPrinter`	`getPrinter()` The printer object.
`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.
`String`	`getSubject()` The subject of the document.
`ITableProperties`	`getTableProperties()` Table properties, for Layers and Tables in ArcMap.
`ITextSymbol`	`getTextSymbol()` Default Text Symbol.
`IPicture`	`getThumbnail()` The thumbnail stored in the map document.
`String`	`getTitle()` The title of this document.
`int`	`getType()` The type of this document.
`Object`	`getVBProject()` The VBProject for this document.
`void`	`getVersionInfo(boolean[] versionInfoMissing, int[] lMajor, int[] lMinor, int[] lRevision, int[] lBuild)` Retrieve the detailed version information of the map document.
`int`	`hashCode()` the hashcode for this object
`void`	`insertObject()` Inserts an object into the document.
`void`	`interfaceSupportsErrorInfo(GUID riid)` interfaceSupportsErrorInfo
`boolean`	`isHasPreviewSaved()` Indicates the presence of a thumbnail preview in the document.
`boolean`	`isHasPreviewToSave()` Indicates the presence of a thumbnail preview to be saved with the document.
`boolean`	`isMapDocument(String sDocument)` Indicates if the map document is a valid map document.
`boolean`	`isPasswordProtected(String sDocument)` Indicates if the map document is protected by a passsword.
`boolean`	`isPresent(String sDocument)` Indicates if the map document is present.
`boolean`	`isReadOnly(String sDocument)` Indicates if the map document is read only.
`boolean`	`isRelativePaths()` Indicates if path names are stored relative to the document.
`boolean`	`isRestricted(String sDocument)` Indicates if the use of the map document is restricted to certain applications.
`boolean`	`isSavePreview()` Indicates if a preview of the document is saved when the document is saved.
`boolean`	`isUsesRelativePaths()` Indicates if the data in the map document is referenced using relative paths.
`void`	`open(String sDocument, String bsPassword)` Open the map document in preparation for the contents to be retrieve or updated.
`void`	`removeAllDataGraphs()` Removes all graphs from the collection.
`void`	`removeDataGraph(IDataGraphBase graph)` Removes the graph from the collection.
`void`	`removeIDataGraphCollectionEventsListener(IDataGraphCollectionEvents theListener)` removeIDataGraphCollectionEventsListener.
`void`	`removeIDocumentEventsDispListener(IDocumentEventsDisp theListener)` removeIDocumentEventsDispListener.
`void`	`removeIDocumentEventsListener(IDocumentEvents theListener)` removeIDocumentEventsListener.
`void`	`replaceContents(IMxdContents pObject)` Replace the contents of the map document.
`void`	`save(boolean bUseRelativePaths, boolean bCreateThumnbail)` Save the contents of the map document to the bound file.
`void`	`saveAs(String sDocument, boolean bUseRelativePaths, boolean bCreateThumnbail)` Save the contents of the map document to the specified file name.
`void`	`setActiveView(IActiveView pActiveView)` Set the ActiveView content of the map document.
`void`	`setActiveViewByRef(IActiveView activeView)` The active view.
`void`	`setAreaPatch(IAreaPatch patch)` Default Area Patch.
`void`	`setAuthor(String author)` The author of the document.
`void`	`setCallout(IFormattedTextSymbol callout)` Default Callout.
`void`	`setCategory(String category)` The category of the document.
`void`	`setClean()` Resets the dirty flag on the document.
`void`	`setComments(String comments)` Comments for the document.
`void`	`setContextItem(Object item)` The last item that was right-clicked.
`void`	`setCoordinateReadoutLatLonFormatByRef(ILatLonFormat format)` The format used for the coordinate readout on the status bar.
`void`	`setCoordinateReadoutUnits(int units)` The units used for the coordinate readout on the status bar.
`void`	`setCredits(String credits)` The credits of the document.
`void`	`setCurrentContentsViewByRef(IContentsView view)` The current contents view of the document.
`void`	`setCurrentLocation(IPoint mouseLoc)` The current mouse location in map units.
`void`	`setCustomTOCFont(Font font)` Custom TOC Font.
`void`	`setCustomTOCFontSize(double fontSizePts)` Custom TOC Font Size in Points.
`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`	`setDirty()` Sets the dirty flag on the document.
`void`	`setDocumentTitle(String title)` The title of the document.
`void`	`setDocumentVersion(int docVersion)` The version of the document to save.
`void`	`setFillSymbol(IFillSymbol lSymbol)` Default Fill Symbol.
`void`	`setHyperlinkBase(String path)` The hyperlink base of the document.
`void`	`setKeywords(String keywords)` The keywords for the document.
`void`	`setLatLonFormatByRef(ILatLonFormat format)` The format object used for reporting lat-lon values.
`void`	`setLinePatch(ILinePatch patch)` Default Line Patch.
`void`	`setLineSymbol(ILineSymbol lineSymbol)` Default Line Symbol.
`void`	`setMarkerSymbol(IMarkerSymbol markerSymbol)` Default Marker Symbol.
`void`	`setNumericFormatByRef(INumberFormat format)` The format object used for reporting numeric values.
`void`	`setPageLayoutByRef(IPageLayout pageLayout)` The page layout.
`void`	`setPatchHeight(double heightPts)` Default Patch Height in Points.
`void`	`setPatchWidth(double widthPts)` Default Patch Width in Points.
`void`	`setRelativePaths(boolean relPaths)` Indicates if path names are stored relative to the document.
`void`	`setSavePreview(boolean savePreview)` Indicates if a preview of the document is saved when the document is saved.
`void`	`setSearchTolerancePixels(int tol)` The global search tolerance in pixels for selection.
`void`	`setSubject(String subject)` The subject of the document.
`void`	`setTextSymbol(ITextSymbol textSymbol)` Default Text Symbol.
`void`	`updateContents()` Notifies the document that the contents have been updated.

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
`getJintegraDispatch, release`

Constructor Detail

MxDocument

public MxDocument()
           throws IOException,
                  UnknownHostException

Constructs a MxDocument using ArcGIS Engine.

Throws:: IOException - if there are interop problems; UnknownHostException - if there are interop problems

MxDocument

public MxDocument(Object obj)
           throws IOException

Construct a MxDocument using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to MxDocument.

Parameters:: obj - an object returned from ArcGIS Engine or Server
Throws:: IOException - if there are interop problems MxDocument theMxDocument = (MxDocument) obj;

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:: equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:: hashCode in class Object

addIDocumentEventsDispListener

public void addIDocumentEventsDispListener(IDocumentEventsDisp theListener)
                                    throws IOException

addIDocumentEventsDispListener. Listen to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.arcmapui.IDocumentEventsDisp interface.
Throws:: IOException - If there are communications problems.

removeIDocumentEventsDispListener

public void removeIDocumentEventsDispListener(IDocumentEventsDisp theListener)
                                       throws IOException

removeIDocumentEventsDispListener. Stop listening to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.arcmapui.IDocumentEventsDisp interface.
Throws:: IOException - If there are communications problems.

addIDocumentEventsListener

public void addIDocumentEventsListener(IDocumentEvents theListener)
                                throws IOException

addIDocumentEventsListener. Listen to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.arcmapui.IDocumentEvents interface.
Throws:: IOException - If there are communications problems.

removeIDocumentEventsListener

public void removeIDocumentEventsListener(IDocumentEvents theListener)
                                   throws IOException

removeIDocumentEventsListener. Stop listening to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.arcmapui.IDocumentEvents interface.
Throws:: IOException - If there are communications problems.

addIDataGraphCollectionEventsListener

public void addIDataGraphCollectionEventsListener(IDataGraphCollectionEvents theListener)
                                           throws IOException

addIDataGraphCollectionEventsListener. Listen to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.carto.IDataGraphCollectionEvents interface.
Throws:: IOException - If there are communications problems.

removeIDataGraphCollectionEventsListener

public void removeIDataGraphCollectionEventsListener(IDataGraphCollectionEvents theListener)
                                              throws IOException

removeIDataGraphCollectionEventsListener. Stop listening to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.carto.IDataGraphCollectionEvents interface.
Throws:: IOException - If there are communications problems.

getParent

public IApplication getParent()
                       throws IOException,
                              AutomationException

The application in which this document is open.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: getParent in interface IDocument

Returns:: A reference to a com.esri.arcgis.framework.IApplication
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IApplication

getTitle

public String getTitle()
                throws IOException,
                       AutomationException

The title of this document.

Remarks

Title returns the name of the currently loaded document or template. It returns "Untitled" if the document has never been saved. If the document object is the Normal template, Title returns Normal.mxt.

Note that file extension is included with the name (e.g. MyDocument.mxd) if the Windows Explorer Folder Option "Hide extensions for known file types" is unchecked when the document is opened. Otherwise, Title returns the name without the file extension.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: getTitle in interface IDocument

Returns:: The title
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getCommandBars

public ICommandBars getCommandBars()
                            throws IOException,
                                   AutomationException

The commandbars collection in this document.

Description

CommandBars is a collection of all the toolbars available to a document. The ICommandBars interface allows you to set properties for all the commandbars and to create, find, or hide commandbars.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: getCommandBars in interface IDocument

Returns:: A reference to a com.esri.arcgis.framework.ICommandBars
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: ICommandBars

getAccelerators

public IAcceleratorTable getAccelerators()
                                  throws IOException,
                                         AutomationException

The accelerator table for this document.

Description

An AcceleratorTable is an object that contains a list of accelerator keys and the command identifiers associated with them.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: getAccelerators in interface IDocument

Returns:: A reference to a com.esri.arcgis.framework.IAcceleratorTable
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IAcceleratorTable

getID

public IUID getID()
           throws IOException,
                  AutomationException

The unique id for this document.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: getID in interface IDocument

Returns:: A reference to a com.esri.arcgis.system.IUID
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws IOException,
                   AutomationException

The type of this document.

Remarks

Use the Type property to determine whether the document object is the document, a base template, or the Normal template. Type returns an esriDocumentType enumeration.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: getType in interface IDocument

Returns:: A com.esri.arcgis.framework.esriDocumentType constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: esriDocumentType

getVBProject

public Object getVBProject()
                    throws IOException,
                           AutomationException

The VBProject for this document.

Description

The VBProject property returns a reference to the VBA VBProject object associated with the document. Use the VBProject object to set properties for the project, to access the VBComponents collection (all the modules, class modules, forms, etc. in the project), and to access the References collection.

Remarks

In the Visual Basic Editor in ArcMap, there can be up to three VBA projects. The document, the base template, and the Normal template all have a VBA project. In the following snapshot of the Project Explorer, the VBA project for the Normal template is called Normal (Normal.mxt). The VBA project for the current document is called Project (MyMap.mxd). This document is based on a template so there is also a VBA project for the template called TemplateProject (MyBase.mxt).

In the Visual Basic Editor in ArcCatalog, there is only one VBA project - Normal (Normal.gxt).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: getVBProject in interface IDocument

Returns:: A reference to another Automation Object (IDispatch)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

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 IBasicDocument2
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 IBasicDocument2
Specified by:: getPageLayout in interface IMxDocument
Specified by:: getPageLayout in interface IMapDocument

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
Specified by:: getActiveView in interface IMapDocument

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 IBasicDocument2
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 IBasicDocument2
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 IBasicDocument
Specified by:: getSelectedLayer in interface IBasicDocument2
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 IBasicDocument
Specified by:: getSelectedItem in interface IBasicDocument2
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 IBasicDocument
Specified by:: getContextItem in interface IBasicDocument2
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 IBasicDocument
Specified by:: setContextItem in interface IBasicDocument2
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 IBasicDocument2
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 IBasicDocument
Specified by:: addLayer in interface IBasicDocument2
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 IBasicDocument
Specified by:: updateContents in interface IBasicDocument2
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 IBasicDocument2
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 IBasicDocument2
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 IBasicDocument2
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 IBasicDocument2
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 IBasicDocument2
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 IBasicDocument2
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 IBasicDocument2
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
Specified by:: isRelativePaths in interface IDocumentInfo2

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
Specified by:: setRelativePaths in interface IDocumentInfo2

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 IBasicDocument
Specified by:: getTableProperties in interface IBasicDocument2
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.

setDirty

public void setDirty()
              throws IOException,
                     AutomationException

Sets the dirty flag on the document.

Remarks

If the document's dirty flag is set to True, then you will be prompted to save the document when the document is closed or the ArcMap application is shut down. Use the SetDirty method to set the document's dirty flag to True.

The SetClean method on IDocumentDirty2 does the opposite of this.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: setDirty in interface IDocumentDirty

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setClean

public void setClean()
              throws IOException,
                     AutomationException

Resets the dirty flag on the document.

Remarks

If the document's dirty flag is set to True, then you will be prompted to save the document when the document is closed or when the ArcMap application is shut down. If you don't want to be prompted to save the document when you close the document or when the ArcMap application is shutdown, then you can use the SetClean method to set the document's dirty flag to False.

The SetDirty method on IDocumentDirty does the opposite of this.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: setClean in interface IDocumentDirty2

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

applies

public boolean applies(Object pUnk)
                throws IOException,
                       AutomationException

Indicates if the receiver can apply the given object at any given time.

Remarks

Applies indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: applies in interface IPropertySupport

Parameters:: pUnk - A reference to another Object (IUnknown) (in)
Returns:: The applies
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

canApply

public boolean canApply(Object pUnk)
                 throws IOException,
                        AutomationException

Indicates if the receiver can apply the given object at that particular moment.

Remarks

CanApply indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: canApply in interface IPropertySupport

Parameters:: pUnk - A reference to another Object (IUnknown) (in)
Returns:: The canApply
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getCurrent

public Object getCurrent(Object pUnk)
                  throws IOException,
                         AutomationException

The object currently being used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: getCurrent in interface IPropertySupport

Parameters:: pUnk - A reference to another Object (IUnknown) (in)
Returns:: A reference to another Object (IUnknown)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

apply

public Object apply(Object newObject)
             throws IOException,
                    AutomationException

Applies the given property to the receiver and returns the old object.

Remarks

Apply will apply the specified object to the current object. For instance, I might apply a Color object to my RectangleElement. When I execute Apply, the object I replace (the old object) is returned.

Use the Applies and CanApply methods to determine if an Apply can be used on an object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: apply in interface IPropertySupport

Parameters:: newObject - A reference to another Object (IUnknown) (in)
Returns:: A reference to another Object (IUnknown)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

changeLayout

public boolean changeLayout()
                     throws IOException,
                            AutomationException

Indicates if the wizard used to select a new layout is shown.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: changeLayout in interface IChangeLayout

Returns:: The changed
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setFillSymbol

public void setFillSymbol(IFillSymbol lSymbol)
                   throws IOException,
                          AutomationException

Default Fill Symbol.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: setFillSymbol in interface IBasicDocumentDefaultSymbols
Specified by:: setFillSymbol in interface IDocumentDefaultSymbols

Parameters:: lSymbol - A reference to a com.esri.arcgis.display.IFillSymbol (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getFillSymbol

public IFillSymbol getFillSymbol()
                          throws IOException,
                                 AutomationException

Default Fill Symbol.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: getFillSymbol in interface IBasicDocumentDefaultSymbols
Specified by:: getFillSymbol in interface IDocumentDefaultSymbols

Returns:: A reference to a com.esri.arcgis.display.IFillSymbol
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setLineSymbol

public void setLineSymbol(ILineSymbol lineSymbol)
                   throws IOException,
                          AutomationException

Default Line Symbol.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: setLineSymbol in interface IBasicDocumentDefaultSymbols
Specified by:: setLineSymbol in interface IDocumentDefaultSymbols

Parameters:: lineSymbol - A reference to a com.esri.arcgis.display.ILineSymbol (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLineSymbol

public ILineSymbol getLineSymbol()
                          throws IOException,
                                 AutomationException

Default Line Symbol.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: getLineSymbol in interface IBasicDocumentDefaultSymbols
Specified by:: getLineSymbol in interface IDocumentDefaultSymbols

Returns:: A reference to a com.esri.arcgis.display.ILineSymbol
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setMarkerSymbol

public void setMarkerSymbol(IMarkerSymbol markerSymbol)
                     throws IOException,
                            AutomationException

Default Marker Symbol.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: setMarkerSymbol in interface IBasicDocumentDefaultSymbols
Specified by:: setMarkerSymbol in interface IDocumentDefaultSymbols

Parameters:: markerSymbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getMarkerSymbol

public IMarkerSymbol getMarkerSymbol()
                              throws IOException,
                                     AutomationException

Default Marker Symbol.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: getMarkerSymbol in interface IBasicDocumentDefaultSymbols
Specified by:: getMarkerSymbol in interface IDocumentDefaultSymbols

Returns:: A reference to a com.esri.arcgis.display.IMarkerSymbol
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTextSymbol

public void setTextSymbol(ITextSymbol textSymbol)
                   throws IOException,
                          AutomationException

Default Text Symbol.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: setTextSymbol in interface IDocumentDefaultSymbols

Parameters:: textSymbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTextSymbol

public ITextSymbol getTextSymbol()
                          throws IOException,
                                 AutomationException

Default Text Symbol.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: getTextSymbol in interface IDocumentDefaultSymbols

Returns:: A reference to a com.esri.arcgis.display.ITextSymbol
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setCallout

public void setCallout(IFormattedTextSymbol callout)
                throws IOException,
                       AutomationException

Default Callout.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: setCallout in interface IDocumentDefaultSymbols

Parameters:: callout - A reference to a com.esri.arcgis.display.IFormattedTextSymbol (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getCallout

public IFormattedTextSymbol getCallout()
                                throws IOException,
                                       AutomationException

Default Callout.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: getCallout in interface IDocumentDefaultSymbols

Returns:: A reference to a com.esri.arcgis.display.IFormattedTextSymbol
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setAreaPatch

public void setAreaPatch(IAreaPatch patch)
                  throws IOException,
                         AutomationException

Default Area Patch.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: setAreaPatch in interface IBasicDocumentDefaultSymbols
Specified by:: setAreaPatch in interface IDocumentDefaultSymbols

Parameters:: patch - A reference to a com.esri.arcgis.carto.IAreaPatch (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getAreaPatch

public IAreaPatch getAreaPatch()
                        throws IOException,
                               AutomationException

Default Area Patch.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: getAreaPatch in interface IBasicDocumentDefaultSymbols
Specified by:: getAreaPatch in interface IDocumentDefaultSymbols

Returns:: A reference to a com.esri.arcgis.carto.IAreaPatch
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setLinePatch

public void setLinePatch(ILinePatch patch)
                  throws IOException,
                         AutomationException

Default Line Patch.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: setLinePatch in interface IBasicDocumentDefaultSymbols
Specified by:: setLinePatch in interface IDocumentDefaultSymbols

Parameters:: patch - A reference to a com.esri.arcgis.carto.ILinePatch (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLinePatch

public ILinePatch getLinePatch()
                        throws IOException,
                               AutomationException

Default Line Patch.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: getLinePatch in interface IBasicDocumentDefaultSymbols
Specified by:: getLinePatch in interface IDocumentDefaultSymbols

Returns:: A reference to a com.esri.arcgis.carto.ILinePatch
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setPatchWidth

public void setPatchWidth(double widthPts)
                   throws IOException,
                          AutomationException

Default Patch Width in Points.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: setPatchWidth in interface IBasicDocumentDefaultSymbols
Specified by:: setPatchWidth in interface IDocumentDefaultSymbols

Parameters:: widthPts - The widthPts (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getPatchWidth

public double getPatchWidth()
                     throws IOException,
                            AutomationException

Default Patch Width in Points.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: getPatchWidth in interface IBasicDocumentDefaultSymbols
Specified by:: getPatchWidth in interface IDocumentDefaultSymbols

Returns:: The widthPts
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setPatchHeight

public void setPatchHeight(double heightPts)
                    throws IOException,
                           AutomationException

Default Patch Height in Points.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: setPatchHeight in interface IBasicDocumentDefaultSymbols
Specified by:: setPatchHeight in interface IDocumentDefaultSymbols

Parameters:: heightPts - The heightPts (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getPatchHeight

public double getPatchHeight()
                      throws IOException,
                             AutomationException

Default Patch Height in Points.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: getPatchHeight in interface IBasicDocumentDefaultSymbols
Specified by:: getPatchHeight in interface IDocumentDefaultSymbols

Returns:: The heightPts
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setCustomTOCFont

public void setCustomTOCFont(Font font)
                      throws IOException,
                             AutomationException

Custom TOC Font.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: setCustomTOCFont in interface IBasicDocumentDefaultSymbols
Specified by:: setCustomTOCFont in interface IDocumentDefaultSymbols

Parameters:: font - 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.

getCustomTOCFont

public Font getCustomTOCFont()
                      throws IOException,
                             AutomationException

Custom TOC Font.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: getCustomTOCFont in interface IBasicDocumentDefaultSymbols
Specified by:: getCustomTOCFont in interface IDocumentDefaultSymbols

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.

setCustomTOCFontSize

public void setCustomTOCFontSize(double fontSizePts)
                          throws IOException,
                                 AutomationException

Custom TOC Font Size in Points.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: setCustomTOCFontSize in interface IBasicDocumentDefaultSymbols
Specified by:: setCustomTOCFontSize in interface IDocumentDefaultSymbols

Parameters:: fontSizePts - The fontSizePts (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getCustomTOCFontSize

public double getCustomTOCFontSize()
                            throws IOException,
                                   AutomationException

Custom TOC Font Size in Points.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: getCustomTOCFontSize in interface IBasicDocumentDefaultSymbols
Specified by:: getCustomTOCFontSize in interface IDocumentDefaultSymbols

Returns:: The fontSizePts
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

clearContentsViews

public void clearContentsViews()
                        throws IOException,
                               AutomationException

Removes all current contents views.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: clearContentsViews in interface IContentsViewEdit

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addContentsView

public void addContentsView(IContentsView contentsView)
                     throws IOException,
                            AutomationException

Adds a contents view object to the TOC.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: addContentsView in interface IContentsViewEdit

Parameters:: contentsView - 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.

getDataGraphCount

public int getDataGraphCount()
                      throws IOException,
                             AutomationException

Number of graphs in the collection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: getDataGraphCount in interface IDataGraphCollection

Returns:: The pCount
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDataGraph

public IDataGraphBase getDataGraph(int index)
                            throws IOException,
                                   AutomationException

Graph at the given index.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: getDataGraph in interface IDataGraphCollection

Parameters:: index - The index (in)
Returns:: A reference to a com.esri.arcgis.carto.IDataGraphBase
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

removeDataGraph

public void removeDataGraph(IDataGraphBase graph)
                     throws IOException,
                            AutomationException

Removes the graph from the collection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: removeDataGraph in interface IDataGraphCollection

Parameters:: graph - A reference to a com.esri.arcgis.carto.IDataGraphBase (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addDataGraph

public void addDataGraph(IDataGraphBase graph)
                  throws IOException,
                         AutomationException

Adds the graph to the collection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: addDataGraph in interface IDataGraphCollection

Parameters:: graph - A reference to a com.esri.arcgis.carto.IDataGraphBase (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

removeAllDataGraphs

public void removeAllDataGraphs()
                         throws IOException,
                                AutomationException

Removes all graphs from the collection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: removeAllDataGraphs in interface IDataGraphCollection

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDatasets

public IEnumDataset getDatasets()
                         throws IOException,
                                AutomationException

The datasets in the document.

Product Availability

Available with ArcGIS Desktop.

Specified by:: getDatasets in interface IDocumentDatasets

Returns:: A reference to a com.esri.arcgis.geodatabase.IEnumDataset
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDocumentTitle

public String getDocumentTitle()
                        throws IOException,
                               AutomationException

The title of the document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: getDocumentTitle in interface IDocumentInfo
Specified by:: getDocumentTitle in interface IDocumentInfo2

Returns:: The title
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDocumentTitle

public void setDocumentTitle(String title)
                      throws IOException,
                             AutomationException

The title of the document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: setDocumentTitle in interface IDocumentInfo
Specified by:: setDocumentTitle in interface IDocumentInfo2

Parameters:: title - The title (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSubject

public String getSubject()
                  throws IOException,
                         AutomationException

The subject of the document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: getSubject in interface IDocumentInfo
Specified by:: getSubject in interface IDocumentInfo2

Returns:: The subject
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSubject

public void setSubject(String subject)
                throws IOException,
                       AutomationException

The subject of the document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: setSubject in interface IDocumentInfo
Specified by:: setSubject in interface IDocumentInfo2

Parameters:: subject - The subject (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getAuthor

public String getAuthor()
                 throws IOException,
                        AutomationException

The author of the document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: getAuthor in interface IDocumentInfo
Specified by:: getAuthor in interface IDocumentInfo2

Returns:: The author
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setAuthor

public void setAuthor(String author)
               throws IOException,
                      AutomationException

The author of the document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: setAuthor in interface IDocumentInfo
Specified by:: setAuthor in interface IDocumentInfo2

Parameters:: author - The author (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getCategory

public String getCategory()
                   throws IOException,
                          AutomationException

The category of the document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: getCategory in interface IDocumentInfo
Specified by:: getCategory in interface IDocumentInfo2

Returns:: The category
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setCategory

public void setCategory(String category)
                 throws IOException,
                        AutomationException

The category of the document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: setCategory in interface IDocumentInfo
Specified by:: setCategory in interface IDocumentInfo2

Parameters:: category - The category (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getComments

public String getComments()
                   throws IOException,
                          AutomationException

Comments for the document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: getComments in interface IDocumentInfo
Specified by:: getComments in interface IDocumentInfo2

Returns:: The comments
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setComments

public void setComments(String comments)
                 throws IOException,
                        AutomationException

Comments for the document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: setComments in interface IDocumentInfo
Specified by:: setComments in interface IDocumentInfo2

Parameters:: comments - The comments (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getKeywords

public String getKeywords()
                   throws IOException,
                          AutomationException

The keywords for the document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: getKeywords in interface IDocumentInfo
Specified by:: getKeywords in interface IDocumentInfo2

Returns:: The keywords
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setKeywords

public void setKeywords(String keywords)
                 throws IOException,
                        AutomationException

The keywords for the document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: setKeywords in interface IDocumentInfo
Specified by:: setKeywords in interface IDocumentInfo2

Parameters:: keywords - The keywords (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getHyperlinkBase

public String getHyperlinkBase()
                        throws IOException,
                               AutomationException

The hyperlink base of the document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: getHyperlinkBase in interface IDocumentInfo
Specified by:: getHyperlinkBase in interface IDocumentInfo2

Returns:: The path
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHyperlinkBase

public void setHyperlinkBase(String path)
                      throws IOException,
                             AutomationException

The hyperlink base of the document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: setHyperlinkBase in interface IDocumentInfo
Specified by:: setHyperlinkBase in interface IDocumentInfo2

Parameters:: path - The path (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSavePreview

public boolean isSavePreview()
                      throws IOException,
                             AutomationException

Indicates if a preview of the document is saved when the document is saved.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: isSavePreview in interface IDocumentInfo
Specified by:: isSavePreview in interface IDocumentInfo2

Returns:: The savePreview
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSavePreview

public void setSavePreview(boolean savePreview)
                    throws IOException,
                           AutomationException

Indicates if a preview of the document is saved when the document is saved.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: setSavePreview in interface IDocumentInfo
Specified by:: setSavePreview in interface IDocumentInfo2

Parameters:: savePreview - The savePreview (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getCredits

public String getCredits()
                  throws IOException,
                         AutomationException

The credits of the document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: getCredits in interface IDocumentInfo2

Returns:: The credits
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setCredits

public void setCredits(String credits)
                throws IOException,
                       AutomationException

The credits of the document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: setCredits in interface IDocumentInfo2

Parameters:: credits - The credits (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: getName in interface IDocumentInfo2

Returns:: The name
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getPath

public String getPath()
               throws IOException,
                      AutomationException

The path of the document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: getPath in interface IDocumentInfo2

Returns:: The path
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getFolder

public String getFolder()
                 throws IOException,
                        AutomationException

The folder of the document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: getFolder in interface IDocumentInfo2

Returns:: The folder
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDateSaved

public Object getDateSaved()
                    throws IOException,
                           AutomationException

Date the document was last saved.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: getDateSaved in interface IDocumentInfo2

Returns:: A Variant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDatePrinted

public Object getDatePrinted()
                      throws IOException,
                             AutomationException

Date the document was last printed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: getDatePrinted in interface IDocumentInfo2

Returns:: A Variant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDateExported

public Object getDateExported()
                       throws IOException,
                              AutomationException

Date the document was last exported.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: getDateExported in interface IDocumentInfo2

Returns:: A Variant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

createPreview

public void createPreview()
                   throws IOException,
                          AutomationException

Creates a thumbnail preview of the document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: createPreview in interface IDocumentPreview

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

deletePreview

public void deletePreview()
                   throws IOException,
                          AutomationException

Deletes the thumbnail preview of the document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: deletePreview in interface IDocumentPreview

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isHasPreviewSaved

public boolean isHasPreviewSaved()
                          throws IOException,
                                 AutomationException

Indicates the presence of a thumbnail preview in the document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: isHasPreviewSaved in interface IDocumentPreview

Returns:: The hasPreviewSaved
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isHasPreviewToSave

public boolean isHasPreviewToSave()
                           throws IOException,
                                  AutomationException

Indicates the presence of a thumbnail preview to be saved with the document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: isHasPreviewToSave in interface IDocumentPreview

Returns:: The hasPreviewToSave
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLatLonFormat

public ILatLonFormat getLatLonFormat()
                              throws IOException,
                                     AutomationException

The format object used for reporting lat-lon values.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: getLatLonFormat in interface IReportUnitFormat
Specified by:: getLatLonFormat in interface IReportUnitFormat2

Returns:: A reference to a com.esri.arcgis.system.ILatLonFormat
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setLatLonFormatByRef

public void setLatLonFormatByRef(ILatLonFormat format)
                          throws IOException,
                                 AutomationException

The format object used for reporting lat-lon values.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: setLatLonFormatByRef in interface IReportUnitFormat
Specified by:: setLatLonFormatByRef in interface IReportUnitFormat2

Parameters:: format - A reference to a com.esri.arcgis.system.ILatLonFormat (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getNumericFormat

public INumberFormat getNumericFormat()
                               throws IOException,
                                      AutomationException

The format object used for reporting numeric values.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: getNumericFormat in interface IReportUnitFormat
Specified by:: getNumericFormat in interface IReportUnitFormat2

Returns:: A reference to a com.esri.arcgis.system.INumberFormat
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setNumericFormatByRef

public void setNumericFormatByRef(INumberFormat format)
                           throws IOException,
                                  AutomationException

The format object used for reporting numeric values.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:: setNumericFormatByRef in interface IReportUnitFormat
Specified by:: setNumericFormatByRef in interface IReportUnitFormat2

Parameters:: format - A reference to a com.esri.arcgis.system.INumberFormat (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getCoordinateReadoutLatLonFormat

public ILatLonFormat getCoordinateReadoutLatLonFormat()
                                               throws IOException,
                                                      AutomationException

The format used for the coordinate readout on the status bar.

Product Availability

Available with ArcGIS Desktop.

Specified by:: getCoordinateReadoutLatLonFormat in interface IReportUnitFormat2

Returns:: A reference to a com.esri.arcgis.system.ILatLonFormat
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setCoordinateReadoutLatLonFormatByRef

public void setCoordinateReadoutLatLonFormatByRef(ILatLonFormat format)
                                           throws IOException,
                                                  AutomationException

The format used for the coordinate readout on the status bar.

Product Availability

Available with ArcGIS Desktop.

Specified by:: setCoordinateReadoutLatLonFormatByRef in interface IReportUnitFormat2

Parameters:: format - A reference to a com.esri.arcgis.system.ILatLonFormat (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getCoordinateReadoutUnits

public int getCoordinateReadoutUnits()
                              throws IOException,
                                     AutomationException

The units used for the coordinate readout on the status bar. If set to esriUnknown, map display units are used.

Product Availability

Available with ArcGIS Desktop.

Specified by:: getCoordinateReadoutUnits in interface IReportUnitFormat2

Returns:: A com.esri.arcgis.system.esriUnits constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setCoordinateReadoutUnits

public void setCoordinateReadoutUnits(int units)
                               throws IOException,
                                      AutomationException

The units used for the coordinate readout on the status bar. If set to esriUnknown, map display units are used.

Product Availability

Available with ArcGIS Desktop.

Specified by:: setCoordinateReadoutUnits in interface IReportUnitFormat2

Parameters:: units - A com.esri.arcgis.system.esriUnits constant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDocumentVersion

public void setDocumentVersion(int docVersion)
                        throws IOException,
                               AutomationException

The version of the document to save.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: setDocumentVersion in interface IDocumentVersion

Parameters:: docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDocumentVersion

public int getDocumentVersion()
                       throws IOException,
                              AutomationException

The version of the document to save.

Remarks

Determines which version an object is persisted. This can be useful when saving an object ObjectStream or MemoryBlobStream and you want the version of that object to be compatible with previous releases of ArcGIS. Not all persistable objects implement IDocumentVersion; you should ensure the object supports this interface before accessing this property.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: getDocumentVersion in interface IMapDocument
Specified by:: getDocumentVersion in interface IDocumentVersion

Returns:: A com.esri.arcgis.system.esriArcGISVersion constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getClassID in interface IPersist

Parameters:: pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isMapDocument

public boolean isMapDocument(String sDocument)
                      throws IOException,
                             AutomationException

Indicates if the map document is a valid map document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: isMapDocument in interface IMapDocument

Parameters:: sDocument - The sDocument (in)
Returns:: The isMapDocument
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isPresent

public boolean isPresent(String sDocument)
                  throws IOException,
                         AutomationException

Indicates if the map document is present.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: isPresent in interface IMapDocument

Parameters:: sDocument - The sDocument (in)
Returns:: The isPresent
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isReadOnly

public boolean isReadOnly(String sDocument)
                   throws IOException,
                          AutomationException

Indicates if the map document is read only.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: isReadOnly in interface IMapDocument

Parameters:: sDocument - The sDocument (in)
Returns:: The isReadOnly
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isRestricted

public boolean isRestricted(String sDocument)
                     throws IOException,
                            AutomationException

Indicates if the use of the map document is restricted to certain applications.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: isRestricted in interface IMapDocument

Parameters:: sDocument - The sDocument (in)
Returns:: The isRestricted
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isPasswordProtected

public boolean isPasswordProtected(String sDocument)
                            throws IOException,
                                   AutomationException

Indicates if the map document is protected by a passsword.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: isPasswordProtected in interface IMapDocument

Parameters:: sDocument - The sDocument (in)
Returns:: The isPasswordProtected
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

esri_new

public void esri_new(String sDocument)
              throws IOException,
                     AutomationException

Creates and opens a new map document in preparation for the contents to be retrieve or updated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: esri_new in interface IMapDocument

Parameters:: sDocument - The sDocument (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

open

public void open(String sDocument,
                 String bsPassword)
          throws IOException,
                 AutomationException

Open the map document in preparation for the contents to be retrieve or updated.

Description

Opens the specified MapDocument in preparation for reading it. The MapDocument can be an an ArcMap document (*.mxd), ArcMap template (*.mxt), Published Map File (*.pmf) or Layer File (*.lyr). The MapDocument will be cached so no other users will be able to access the MapDocument until it has been closed.

Before using the Open methods check whether the specified document IsPresent, IsRestricted, IsMapDocument and IsPasswordProtected. If the MapDocument is password protected, specify the password in the Open method.

If a Layer File (*.lyr) is opened a portriat PageLayout containing one Map with the layer added to it is created.

Remarks

When opening or creating a map document with the IMapDocument Open() or New() methods, you should always make subsequent calls to IActiveView::Activate() in order to properly initialize the display of the PageLayout and Map objects. Call Activate() once for the PageLayout and once for each Map you will be working with. If your application has a user interface, you should call Activate() with the hWnd of the application's client area. If your application runs in the background and has no windows, you can always get a valid hWnd from the GDI GetDesktopWindow() function, part of the Win32 API.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: open in interface IMapDocument

Parameters:: sDocument - The sDocument (in); bsPassword - The bsPassword (in, optional, pass if not required)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDocumentFilename

public String getDocumentFilename()
                           throws IOException,
                                  AutomationException

The map document filename that the MapDocument coclass is linked to.

Description

Returns the DocumentFilename of the last map document that was successfully opened with the Open method. An empty string will be returned if no document has been opened.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDocumentFilename in interface IMapDocument

Returns:: The sDocument
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDocumentType

public int getDocumentType()
                    throws IOException,
                           AutomationException

The type of map document currently loaded in the object.

Description

Returns the type of MapDocument that is open.

Remarks

If a map template (*.mxt) is open esriMapDocumentTypeMxd will be returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDocumentType in interface IMapDocument

Returns:: A com.esri.arcgis.carto.esriMapDocumentType constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isUsesRelativePaths

public boolean isUsesRelativePaths()
                            throws IOException,
                                   AutomationException

Indicates if the data in the map document is referenced using relative paths.

Description

Determines whether the MapDocument that is open stores paths to data sources as relative path names (relative to the MapDocument) or absolute path names.

Remarks

If a Published Map File (*.pmf) is Open that was published with ArcGIS 8.x or a Layer File (*.lyr) is Open the UsesRelativePaths will always return false.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: isUsesRelativePaths in interface IMapDocument

Returns:: The bUsesRelativePaths
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getMapCount

public int getMapCount()
                throws IOException,
                       AutomationException

The number of Map objects contained within the map document.

Description

Returns the number of map's within the PageLayout.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getMapCount in interface IMapDocument

Returns:: The mapCount
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getMap

public IMap getMap(int mapIndex)
            throws IOException,
                   AutomationException

The Map object at the specified index.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: getMap in interface IMapDocument

Parameters:: mapIndex - The mapIndex (in)
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.

getLayer

public ILayer getLayer(int mapIndex,
                       int layerIndex)
                throws IOException,
                       AutomationException

The Layer object at the specified index for the specified map.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: getLayer in interface IMapDocument

Parameters:: mapIndex - The mapIndex (in); layerIndex - The layerIndex (in)
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.

getPrinter

public IPrinter getPrinter()
                    throws IOException,
                           AutomationException

The printer object. If no printer object is stored in the map document this returns NULL.

Description

The Printer stored in the MapDocument. If a map document (*.mxd) or map template (*.mxt) is Open the Printer returned will be the printer stored in the document when it was last saved. If no printer is saved in the document the Printer will be nothing. If a Published Map File (*.pmf) or layer file (*.lyr) is Open the Printer will be nothing. Creating a New MapDocument will set the Printer to nothing.

Remarks

If the Printer cannot be found on the system, a message box will display indicating that the printer is not installed. The MessageLogger can be used to switch this message off.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getPrinter in interface IMapDocument

Returns:: A reference to a com.esri.arcgis.output.IPrinter
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getThumbnail

public IPicture getThumbnail()
                      throws IOException,
                             AutomationException

The thumbnail stored in the map document. If this is empty E_FAIL is returned.

Description

Returns the Thumbnail stored in the MapDocument that is open. Not every MapDocument has a thumbnail. The Thumnail is a small bitmap picture representation of the contents of the MapDocument.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getThumbnail in interface IMapDocument

Returns:: A reference to a com.esri.arcgis.support.ms.stdole.IPicture
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

close

public void close()
           throws IOException,
                  AutomationException

Close the map document.

Description

Closes the MapDocument. This sets the DocumentFilename property to an empty string and resets the ActiveView, PageLayout, Map, MapCount, Printer and Thumbnail properties.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: close in interface IMapDocument

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getVersionInfo

public void getVersionInfo(boolean[] versionInfoMissing,
                           int[] lMajor,
                           int[] lMinor,
                           int[] lRevision,
                           int[] lBuild)
                    throws IOException,
                           AutomationException

Retrieve the detailed version information of the map document.

Description

Returns the major, minor, revision and build numbers of the MapDocument if the map document version information is present.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getVersionInfo in interface IMapDocument

Parameters:: versionInfoMissing - The versionInfoMissing (in/out: use single element array); lMajor - The lMajor (in/out: use single element array); lMinor - The lMinor (in/out: use single element array); lRevision - The lRevision (in/out: use single element array); lBuild - The lBuild (in/out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

replaceContents

public void replaceContents(IMxdContents pObject)
                     throws IOException,
                            AutomationException

Replace the contents of the map document.

Description

Replaces the contents of the MapDocument with the contents of the specified Map, PageLayout, MapControl or PageLayoutControl. Before using the ReplaceContents method a New MapDocument must be created or an existing MapDocument must be Open.

If a MapControl is passed to the ReplaceContents method the MapDocument will be replaced with the IMapControl2::Map. Likewise, if a PageLayoutControl is passed to the ReplaceContents method the MapDocument will be replaced with the IPageLayoutControl::PageLayout.

If the MapDocument contents is replaced with the contents of a Map or MapControl a portriat PageLayout containing the map will be created.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: replaceContents in interface IMapDocument

Parameters:: pObject - A reference to a com.esri.arcgis.carto.IMxdContents (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setActiveView

public void setActiveView(IActiveView pActiveView)
                   throws IOException,
                          AutomationException

Set the ActiveView content of the map document.

Description

Use this method to set the ActiveView of the MapDocument. Use the PageLayout and Map properties to specify the ActiveView.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setActiveView in interface IMapDocument

Parameters:: pActiveView - 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.

save

public void save(boolean bUseRelativePaths,
                 boolean bCreateThumnbail)
          throws IOException,
                 AutomationException

Save the contents of the map document to the bound file.

Description

Saves the MapDocument that is Open and any changes that have been made to it. Before using the Save method check whether the document IsReadOnly. If a MapDocument is read only use the SaveAs method to create a new MapDocument. By default MapDocuments are saved without relative paths and thumbnails.

Specifying thumbnails as True can delay saving complex map documents as the view of the document is generated for the thumbnail. However, thumbnails are guides for users browsing map documents using ArcCatalog and Windows Explorer.

Remarks

If a Published Map File (*.pmf) or Layer File (*.lyr) is Open use the SaveAs method to create a new Map Document (*.mxd), as attempting to use the Save method will return an error.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: save in interface IMapDocument

Parameters:: bUseRelativePaths - The bUseRelativePaths (in, optional, pass true if not required); bCreateThumnbail - The bCreateThumnbail (in, optional, pass true if not required)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

saveAs

public void saveAs(String sDocument,
                   boolean bUseRelativePaths,
                   boolean bCreateThumnbail)
            throws IOException,
                   AutomationException

Save the contents of the map document to the specified file name.

Description

Saves the MapDocument that is Open and any changes that have been made to it to a new MapDocument with the specified filename. The filename that is supplied must be valid and inlcude the *.mxd extension. By default MapDocuments are saved without relative paths and thumbnails.

Remarks

The SaveAs method cannot be used to save the MapDocument as an earlier ArcGIS 8.3 map document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: saveAs in interface IMapDocument

Parameters:: sDocument - The sDocument (in); bUseRelativePaths - The bUseRelativePaths (in, optional, pass true if not required); bCreateThumnbail - The bCreateThumnbail (in, optional, pass true if not required)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:: riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws IOException,
                                 AutomationException

enumConnectionPoints

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: enumConnectionPoints in interface IConnectionPointContainer

Parameters:: ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws IOException,
                                AutomationException

findConnectionPoint

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: findConnectionPoint in interface IConnectionPointContainer

Parameters:: riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in); ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.arcmapui Class MxDocument

Description

Product Availability

Supported Platforms

MxDocument

MxDocument

getClsid

equals

hashCode

addIDocumentEventsDispListener

removeIDocumentEventsDispListener

addIDocumentEventsListener

removeIDocumentEventsListener

addIDataGraphCollectionEventsListener

removeIDataGraphCollectionEventsListener

getParent

Product Availability

Supported Platforms

getTitle

Remarks

Product Availability

Supported Platforms

getCommandBars

Description

Product Availability

Supported Platforms

getAccelerators

Description

Product Availability

Supported Platforms

getID

Product Availability

Supported Platforms

getType

Remarks

Product Availability

Supported Platforms

getVBProject

Description

Remarks

Product Availability

Supported Platforms

setPageLayoutByRef

Product Availability

Supported Platforms

getPageLayout

Remarks

Product Availability

Supported Platforms

getActiveView

Remarks

Product Availability

Supported Platforms

setActiveViewByRef

Product Availability

Supported Platforms

getActivatedView

Remarks

Product Availability

Supported Platforms

getActiveViewCommand

Remarks

Product Availability

Supported Platforms

getFocusMap

Remarks

Product Availability

Supported Platforms

getSelectedLayer

Remarks

Product Availability

Supported Platforms

getSelectedItem

Remarks

Product Availability

Supported Platforms

getContextItem

Remarks

Product Availability

Supported Platforms

com.esri.arcgis.arcmapui
Class MxDocument