com.esri.arcgis.arcglobe
Class GMxDocument

java.lang.Object
  com.esri.arcgis.arcglobe.GMxDocument

All Implemented Interfaces:

IGMxDocument, IGMxDocumentInfo, IBasicDocument2, IBasicDocumentDefaultSymbols, IContentsViewEdit, IDocumentDefaultSymbols, IDocument3DDefaultSymbols, IDataGraphCollection, IDocumentInfo2, IDocumentPreview, IDocumentDatasets, IDocument, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersion, Serializable

public class GMxDocument
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDocument, IBasicDocument2, IGMxDocument, IGMxDocumentInfo, IDocumentDatasets, IDocumentDefaultSymbols, IDocument3DDefaultSymbols, IContentsViewEdit, IDocumentVersion, IDocumentInfo2, IDocumentPreview, IDataGraphCollection

Provides access to members that control the ArcGlobe document.

Remarks

The GMxDocument coclass provides a handle to the running ArcGlobe document and its properties.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

GMxDocument()
Constructs a GMxDocument using ArcGIS Engine.

GMxDocument(Object obj)
Construct a GMxDocument 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	addIGMxDocumentEventsDispListener(IGMxDocumentEventsDisp theListener) addIGMxDocumentEventsDispListener.
void	addIGMxDocumentEventsListener(IGMxDocumentEvents theListener) addIGMxDocumentEventsListener.
void	addLayer(ILayer pLayer) Adds a layer to the current focus map or scene.
void	clearContentsViews() Removes all current contents views.
void	createPreview() Creates a thumbnail preview of the document.
void	deletePreview() Deletes the thumbnail preview of the document.
boolean	equals(Object o) Compare this object with another
IAcceleratorTable	getAccelerators() The accelerator table for this document.
IActiveView	getActivatedView() The activated view.
IAreaPatch	getAreaPatch() Default Area Patch.
String	getAuthor() The author of the document.
IFormattedTextSymbol	getCallout() Default Callout.
String	getCategory() The category of the document.
static String	getClsid() getClsid.
ICommandBars	getCommandBars() The commandbars collection in this document.
String	getComments() The comments for the document.
IContentsView2	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.
String	getCredits() The credits of the document.
IContentsView2	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.
String	getDocumentTitle() The title of the document.
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.
ILinePatch	getLinePatch() Default Line Patch.
ILineSymbol	getLineSymbol() Default Line Symbol.
IMaps	getMaps() The collection of maps in the document.
IMarkerSymbol	getMarkerSymbol() Default Marker Symbol.
String	getName() The name of the document.
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.
IScene	getScene() The scene.
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.
IText3DElement	getText3DElement() Default 3D Text Element.
ITextSymbol	getTextSymbol() Default Text Symbol.
String	getTitle() The title of this document.
int	getType() The type of this document.
Object	getVBProject() The VBProject for this document.
int	hashCode() the hashcode for this object
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	isRelativePaths() Indicates if path names are stored relative to the document.
boolean	isSavePreview() Indicates if a preview image is saved in the document.
void	removeAllDataGraphs() Removes all graphs from the collection.
void	removeAllLayers() Removes all layers.
void	removeDataGraph(IDataGraphBase graph) Removes the graph from the collection.
void	removeIDataGraphCollectionEventsListener(IDataGraphCollectionEvents theListener) removeIDataGraphCollectionEventsListener.
void	removeIGMxDocumentEventsDispListener(IGMxDocumentEventsDisp theListener) removeIGMxDocumentEventsDispListener.
void	removeIGMxDocumentEventsListener(IGMxDocumentEvents theListener) removeIGMxDocumentEventsListener.
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	setComments(String comments) The comments for the document.
void	setContextItem(Object ppItem) The last item that was right-clicked.
void	setCredits(String credits) The credits of the document.
void	setCurrentContentsViewByRef(IContentsView2 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	setDelayUpdateContents(boolean rhs1) Indicates whether to ignore document update notifications.
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	setLinePatch(ILinePatch patch) Default Line Patch.
void	setLineSymbol(ILineSymbol lineSymbol) Default Line Symbol.
void	setMarkerSymbol(IMarkerSymbol markerSymbol) Default Marker Symbol.
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 image is saved in the document.
void	setScene(IScene pScene) The scene.
void	setSearchTolerancePixels(int tol) The global search tolerance in pixels for selection.
void	setSubject(String subject) The subject of the document.
void	setText3DElement(IText3DElement text3DElement) Default 3D Text Element.
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

GMxDocument

public GMxDocument()
            throws IOException,
                   UnknownHostException

Constructs a GMxDocument using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GMxDocument

public GMxDocument(Object obj)
            throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems GMxDocument theGMxDocument = (GMxDocument) 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

addIGMxDocumentEventsDispListener

public void addIGMxDocumentEventsDispListener(IGMxDocumentEventsDisp theListener)
                                       throws IOException

addIGMxDocumentEventsDispListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.arcglobe.IGMxDocumentEventsDisp interface.

Throws:

IOException - If there are communications problems.

removeIGMxDocumentEventsDispListener

public void removeIGMxDocumentEventsDispListener(IGMxDocumentEventsDisp theListener)
                                          throws IOException

removeIGMxDocumentEventsDispListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.arcglobe.IGMxDocumentEventsDisp interface.

Throws:

IOException - If there are communications problems.

addIGMxDocumentEventsListener

public void addIGMxDocumentEventsListener(IGMxDocumentEvents theListener)
                                   throws IOException

addIGMxDocumentEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.arcglobe.IGMxDocumentEvents interface.

Throws:

IOException - If there are communications problems.

removeIGMxDocumentEventsListener

public void removeIGMxDocumentEventsListener(IGMxDocumentEvents theListener)
                                      throws IOException

removeIGMxDocumentEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.arcglobe.IGMxDocumentEvents 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.

getSelectedLayer

public ILayer getSelectedLayer()
                        throws IOException,
                               AutomationException

The selected layer in the layer control.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getSelectedLayer in interface IGMxDocument

Specified by:

getSelectedLayer in interface IBasicDocument2

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.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getSelectedItem in interface IGMxDocument

Specified by:

getSelectedItem in interface IBasicDocument2

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.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getContextItem in interface IGMxDocument

Specified by:

getContextItem in interface IBasicDocument2

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 ppItem)
                    throws IOException,
                           AutomationException

The last item that was right-clicked.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setContextItem in interface IGMxDocument

Specified by:

setContextItem in interface IBasicDocument2

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addLayer

public void addLayer(ILayer pLayer)
              throws IOException,
                     AutomationException

Adds a layer to the current focus map or scene.

Product Availability

Available with ArcGIS Desktop.

Specified by:

addLayer in interface IGMxDocument

Specified by:

addLayer in interface IBasicDocument2

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateContents

public void updateContents()
                    throws IOException,
                           AutomationException

Notifies the document that the contents have been updated.

Product Availability

Available with ArcGIS Desktop.

Specified by:

updateContents in interface IGMxDocument

Specified by:

updateContents in interface IBasicDocument2

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.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getTableProperties in interface IBasicDocument2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPageLayoutByRef

public void setPageLayoutByRef(IPageLayout pageLayout)
                        throws IOException,
                               AutomationException

The page layout.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setPageLayoutByRef in interface IBasicDocument2

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.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getPageLayout in interface IBasicDocument2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActivatedView

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.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getActivatedView in interface IBasicDocument2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFocusMap

public IMap getFocusMap()
                 throws IOException,
                        AutomationException

The current focus map.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getFocusMap in interface IBasicDocument2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStyleGallery

public IStyleGallery getStyleGallery()
                              throws IOException,
                                     AutomationException

Reference to the document's Style Gallery.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getStyleGallery in interface IBasicDocument2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSearchTolerance

public double getSearchTolerance()
                          throws IOException,
                                 AutomationException

The global search tolerance in geographic units for selection.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getSearchTolerance in interface IBasicDocument2

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.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getSearchTolerancePixels in interface IGMxDocument

Specified by:

getSearchTolerancePixels in interface IBasicDocument2

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.

Specified by:

setSearchTolerancePixels in interface IGMxDocument

Specified by:

setSearchTolerancePixels in interface IBasicDocument2

Parameters:

tol - The tol (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.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getMaps in interface IBasicDocument2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOperationStack

public IOperationStack getOperationStack()
                                  throws IOException,
                                         AutomationException

The operation stack.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getOperationStack in interface IBasicDocument2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentLocation

public IPoint getCurrentLocation()
                          throws IOException,
                                 AutomationException

The current mouse location in map units.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getCurrentLocation in interface IBasicDocument2

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.

Specified by:

setCurrentLocation in interface IBasicDocument2

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.

removeAllLayers

public void removeAllLayers()
                     throws IOException,
                            AutomationException

Removes all layers.

Remarks

RemoveAllLayers deletes all the layers present in the Table Of Contents of the current ArcGlobe document and therefore, should be carefully used.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

removeAllLayers in interface IGMxDocument

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 whether to ignore document update notifications.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

setDelayUpdateContents in interface IGMxDocument

Parameters:

rhs1 - The rhs1 (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. Requires 3D Analyst Extension.

Specified by:

getDefaultColor in interface IGMxDocument

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. Requires 3D Analyst Extension.

Specified by:

setDefaultColor in interface IGMxDocument

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.

getScene

public IScene getScene()
                throws IOException,
                       AutomationException

The scene.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

getScene in interface IGMxDocument

Returns:

A reference to a com.esri.arcgis.analyst3d.IScene

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setScene

public void setScene(IScene pScene)
              throws IOException,
                     AutomationException

The scene.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

setScene in interface IGMxDocument

Parameters:

pScene - A reference to a com.esri.arcgis.analyst3d.IScene (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. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

isRelativePaths in interface IGMxDocument

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.

Remarks

RelativePaths can be set to True for storing a document with relative paths. Setting the property to False stores the document with full paths.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

setRelativePaths in interface IGMxDocument

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.

isSavePreview

public boolean isSavePreview()
                      throws IOException,
                             AutomationException

Indicates if a preview image is saved in the document.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

isSavePreview in interface IGMxDocument

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 image is saved in the document.

Remarks

The SavePreview property specifies whether or not a thumbnail image of the globe is displayed in ArcCatalog or not, when browsing globe documents. For saving a preview of the current ArcGlobe document, this proerty should be set to True.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

setSavePreview in interface IGMxDocument

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.

getCurrentContentsView

public IContentsView2 getCurrentContentsView()
                                      throws IOException,
                                             AutomationException

The current contents view of the document.

Description

A contents view is a tab in the table of contents. ArcGlobe has three contents views: Display (TOCGMxDisplayView), Source (TOCGMxCatalogView), and Type (TOCGMxTypeView). 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. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

getCurrentContentsView in interface IGMxDocument

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentContentsViewByRef

public void setCurrentContentsViewByRef(IContentsView2 view)
                                 throws IOException,
                                        AutomationException

The current contents view of the document.

Remarks

Use the CurrentContentsView to set the current contents view and to get a reference to the current contents view. Setting the current contents view automatically refreshes the table of contents (IContentsView::Refresh).

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

setCurrentContentsViewByRef in interface IGMxDocument

Parameters:

view - A reference to a com.esri.arcgis.arcmapui.IContentsView2 (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. ArcGlobe has three contents views: Display (TOCGMxDisplayView), Source (TOCGMxCatalogView), and Type (TOCGMxTypeView). 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.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

getContentsViewCount in interface IGMxDocument

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContentsView

public IContentsView2 getContentsView(int index)
                               throws IOException,
                                      AutomationException

The contents view at the specified index.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:

getContentsView in interface IGMxDocument

Parameters:

index - The index (in)

Returns:

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

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 Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

getDocumentTitle in interface IGMxDocumentInfo

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 Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

setDocumentTitle in interface IGMxDocumentInfo

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 Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

getSubject in interface IGMxDocumentInfo

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 Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

setSubject in interface IGMxDocumentInfo

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 Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

getAuthor in interface IGMxDocumentInfo

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 Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

setAuthor in interface IGMxDocumentInfo

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 Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

getCategory in interface IGMxDocumentInfo

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 Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

setCategory in interface IGMxDocumentInfo

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

The comments for the document.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

getComments in interface IGMxDocumentInfo

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

The comments for the document.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

setComments in interface IGMxDocumentInfo

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 Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

getKeywords in interface IGMxDocumentInfo

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 Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

setKeywords in interface IGMxDocumentInfo

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 Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

getHyperlinkBase in interface IGMxDocumentInfo

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.

Remarks

The HyperlinkBase property specifies the root Web address for hyperlink fields. For example, you can set a globe document’s HyperlinkBase property to http://arcgisdeveloperonline.esri.com/ and a Web-linked field on a feature to "ArcGISDeveloper". When you turn on field Hyperlinks for a layer and use the Hyperlink tool, the two are put together, and http://arcgisdeveloperonline.esri.com/ArcGISDeveloper becomes the hyperlink.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

setHyperlinkBase in interface IGMxDocumentInfo

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.

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.

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.

getText3DElement

public IText3DElement getText3DElement()
                                throws IOException,
                                       AutomationException

Default 3D Text Element.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

getText3DElement in interface IDocument3DDefaultSymbols

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setText3DElement

public void setText3DElement(IText3DElement text3DElement)
                      throws IOException,
                             AutomationException

Default 3D Text Element.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

setText3DElement in interface IDocument3DDefaultSymbols

Parameters:

text3DElement - A reference to a com.esri.arcgis.carto.IText3DElement (in)

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.

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 IDocumentVersion

Returns:

A com.esri.arcgis.system.esriArcGISVersion constant

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.

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.