com.esri.arcgis.carto
Interface IMapDocument

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IMapDocumentProxy, MapDocument, MxDocument

public interface IMapDocument
extends java.io.Serializable

COM Interface 'IMapDocument'. Generated 3/19/2015 1:20:53 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that control the reading and writing of map document files.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

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

Method Summary

void	close() Close the map document.
void	esri_new(java.lang.String sDocument) Creates and opens a new map document in preparation for the contents to be retrieve or updated.
IActiveView	getActiveView() The ActiveView of the map document.
java.lang.String	getDocumentFilename() The map document filename that the MapDocument coclass is linked to.
int	getDocumentType() The type of map document currently loaded in the object.
int	getDocumentVersion() Indicates if the version of the map document is compatible with the current version of software.
ILayer	getLayer(int mapIndex, int layerIndex) The Layer object at the specified index for the specified map.
IMap	getMap(int mapIndex) The Map object at the specified index.
int	getMapCount() The number of Map objects contained within the map document.
IPageLayout	getPageLayout() The PageLayout object.
IPrinter	getPrinter() The printer object.
IPicture	getThumbnail() The thumbnail stored in the map document.
void	getVersionInfo(boolean[] versionInfoMissing, int[] lMajor, int[] lMinor, int[] lRevision, int[] lBuild) Retrieve the detailed version information of the map document.
boolean	isMapDocument(java.lang.String sDocument) Indicates if the map document is a valid map document.
boolean	isPasswordProtected(java.lang.String sDocument) Indicates if the map document is protected by a passsword.
boolean	isPresent(java.lang.String sDocument) Indicates if the map document is present.
boolean	isReadOnly(java.lang.String sDocument) Indicates if the map document is read only.
boolean	isRestricted(java.lang.String sDocument) Indicates if the use of the map document is restricted to certain applications.
boolean	isUsesRelativePaths() Indicates if the data in the map document is referenced using relative paths.
void	open(java.lang.String sDocument, java.lang.String bsPassword) Open the map document in preparation for the contents to be retrieve or updated.
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(java.lang.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.

Field Detail

IID5366451c_a001_4179_b8cb_e8f014628a44

static final int IID5366451c_a001_4179_b8cb_e8f014628a44

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

isMapDocument

boolean isMapDocument(java.lang.String sDocument)
                      throws java.io.IOException,
                             AutomationException

Indicates if the map document is a valid map document.

Parameters:

sDocument - The sDocument (in)

Returns:

The isMapDocument

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isPresent

boolean isPresent(java.lang.String sDocument)
                  throws java.io.IOException,
                         AutomationException

Indicates if the map document is present.

Parameters:

sDocument - The sDocument (in)

Returns:

The isPresent

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isReadOnly

boolean isReadOnly(java.lang.String sDocument)
                   throws java.io.IOException,
                          AutomationException

Indicates if the map document is read only.

Parameters:

sDocument - The sDocument (in)

Returns:

The isReadOnly

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRestricted

boolean isRestricted(java.lang.String sDocument)
                     throws java.io.IOException,
                            AutomationException

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

Parameters:

sDocument - The sDocument (in)

Returns:

The isRestricted

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isPasswordProtected

boolean isPasswordProtected(java.lang.String sDocument)
                            throws java.io.IOException,
                                   AutomationException

Indicates if the map document is protected by a passsword.

Parameters:

sDocument - The sDocument (in)

Returns:

The isPasswordProtected

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_new

void esri_new(java.lang.String sDocument)
              throws java.io.IOException,
                     AutomationException

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

Parameters:

sDocument - The sDocument (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

open

void open(java.lang.String sDocument,
          java.lang.String bsPassword)
          throws java.io.IOException,
                 AutomationException

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

Parameters:

sDocument - The sDocument (in)

bsPassword - The bsPassword (in, optional, pass if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDocumentFilename

java.lang.String getDocumentFilename()
                                     throws java.io.IOException,
                                            AutomationException

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

Returns:

The sDocument

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDocumentType

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

The type of map document currently loaded in the object.

Returns:

A com.esri.arcgis.carto.esriMapDocumentType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUsesRelativePaths

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

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

Returns:

The bUsesRelativePaths

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDocumentVersion

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

Indicates if the version of the map document is compatible with the current version of software.

Returns:

A com.esri.arcgis.carto.esriMapDocumentVersionInfo constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPageLayout

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

The PageLayout object.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getActiveView

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

The ActiveView of the map document.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMapCount

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

The number of Map objects contained within the map document.

Returns:

The mapCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMap

IMap getMap(int mapIndex)
            throws java.io.IOException,
                   AutomationException

The Map object at the specified index.

Parameters:

mapIndex - The mapIndex (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayer

ILayer getLayer(int mapIndex,
                int layerIndex)
                throws java.io.IOException,
                       AutomationException

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

Parameters:

mapIndex - The mapIndex (in)

layerIndex - The layerIndex (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPrinter

IPrinter getPrinter()
                    throws java.io.IOException,
                           AutomationException

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

Returns:

A reference to a com.esri.arcgis.output.IPrinter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getThumbnail

IPicture getThumbnail()
                      throws java.io.IOException,
                             AutomationException

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

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.IPicture

Throws:

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

AutomationException - If the ArcObject component throws an exception.

close

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

Close the map document.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVersionInfo

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

Retrieve the detailed version information of the map document.

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:

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

AutomationException - If the ArcObject component throws an exception.

replaceContents

void replaceContents(IMxdContents pObject)
                     throws java.io.IOException,
                            AutomationException

Replace the contents of the map document.

Parameters:

pObject - A reference to a com.esri.arcgis.carto.IMxdContents (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setActiveView

void setActiveView(IActiveView pActiveView)
                   throws java.io.IOException,
                          AutomationException

Set the ActiveView content of the map document.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

void save(boolean bUseRelativePaths,
          boolean bCreateThumnbail)
          throws java.io.IOException,
                 AutomationException

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

Parameters:

bUseRelativePaths - The bUseRelativePaths (in, optional, pass true if not required)

bCreateThumnbail - The bCreateThumnbail (in, optional, pass true if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

saveAs

void saveAs(java.lang.String sDocument,
            boolean bUseRelativePaths,
            boolean bCreateThumnbail)
            throws java.io.IOException,
                   AutomationException

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

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:

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

AutomationException - If the ArcObject component throws an exception.