com.esri.arcgis.framework
Interface IDocument

All Superinterfaces:

Serializable

All Known Implementing Classes:

GMxDocument, GxDocument, IDocumentProxy, MxDocument, SxDocument

public interface IDocument
extends Serializable

Provides access to other objects in the document.

Remarks

The document object is called MxDocument in ArcMap and GxDocument in ArcCatalog.

When To Use

Use the IDocument interface to get access to the document's title, type, accelerator table, commandbars collection, parent application, and Visual Basic project. Use IApplication::Document to get a reference to the document.

Product Availability

Available with ArcGIS Desktop.

See Also:

IApplication.getDocument()

Method Summary

IAcceleratorTable	getAccelerators() The accelerator table for this document.
ICommandBars	getCommandBars() The commandbars collection in this document.
IUID	getID() The unique id for this document.
IApplication	getParent() The application in which this document is open.
String	getTitle() The title of this document.
int	getType() The type of this document.
Object	getVBProject() The VBProject for this document.

Method Detail

getParent

IApplication getParent()
                       throws IOException,
                              AutomationException

The application in which this document is open.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

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

Returns:

The title

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCommandBars

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

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

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

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

IUID getID()
           throws IOException,
                  AutomationException

The unique id for this document.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

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

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

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

Returns:

A reference to another Automation Object (IDispatch)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.