com.esri.arcgis.globecore
Class GlobeDocument

java.lang.Object
  com.esri.arcgis.globecore.GlobeDocument

All Implemented Interfaces:

IDocumentInfo, IDocumentInfo2, IDocumentPreview, IGlobeDocument, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersion, Serializable

public class GlobeDocument
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGlobeDocument, IDocumentVersion, IDocumentInfo, IDocumentInfo2, IDocumentPreview

The GlobeDocument coclass is used to read and write globe document files.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

GlobeDocument()
Constructs a GlobeDocument using ArcGIS Engine.

GlobeDocument(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GlobeDocument theGlobeDocument = (GlobeDocument) obj;

Method Summary

void	close() Close the globe document.
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
void	esri_new(String bsDocument) Creates and opens a new globe document in preparation for the contents to be retrieve or updated.
String	getAuthor() The author of the document.
String	getCategory() The category of the document.
static String	getClsid() getClsid.
String	getComments() Comments for the document.
String	getCredits() The credits of 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.
String	getDocumentFilename() The globe document filename that the GlobeDocument coclass is linked to.
String	getDocumentTitle() The title of the document.
int	getDocumentType() The type of globe document currently loaded in the object.
int	getDocumentVersion() Indicates if the version of the globe document is compatible with the current version of software.
String	getFolder() The folder of the document.
Object	getGlobeObject() The Globe object.
String	getHyperlinkBase() The hyperlink base of the document.
String	getKeywords() The keywords for the document.
ILayer	getLayer(int lLayerIndex) The Layer object at the specified index.
int	getLayerCount() The number of Layer objects contained within the globe document.
String	getName() The name of the document.
String	getPath() The path of the document.
String	getSubject() The subject of the document.
IPicture	getThumbnail() The thumbnail stored in the globe document.
void	getVersionInfo(boolean[] pbVersionInfoMissing, int[] plMajor, int[] plMinor, int[] plRevision, int[] plBuild) Retrieve the detailed version information of the globe document.
int	hashCode() the hashcode for this object
boolean	isGlobeDocument(String bsDocument) Indicates if the globe document is a valid globe document.
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	isPasswordProtected(String bsDocument) Indicates if the globe document is protected by a passsword.
boolean	isPresent(String bsDocument) Indicates if the globe document is present.
boolean	isReadOnly(String bsDocument) Indicates if the globe document is read only.
boolean	isRelativePaths() Indicates if relative path is used when the document is saved.
boolean	isRestricted(String bsDocument) Indicates if the use of the globe 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 globe document is referenced using relative paths.
void	open(String bsDocument, String bsPassword) Open the globe document in preparation for the contents to be retrieved or updated.
void	save(boolean bUseRelativePaths, boolean bCreateThumnbail) Save the contents of the globe document to the bound file.
void	saveAs(String bsDocument, boolean bUseRelativePaths, boolean bCreateThumnbail) Save the contents of the globe document to the specified file name.
void	setAuthor(String author) The author of the document.
void	setCategory(String category) The category of the document.
void	setComments(String comments) Comments for the document.
void	setCredits(String credits) The credits of the document.
void	setDocumentTitle(String title) The title of the document.
void	setDocumentVersion(int docVersion) The version of the document to save.
void	setGlobeObject(Object ppUnk) The Globe object.
void	setHyperlinkBase(String path) The hyperlink base of the document.
void	setKeywords(String keywords) The keywords for the document.
void	setRelativePaths(boolean useRelativePaths) Indicates if relative path is used when the document is saved.
void	setSavePreview(boolean savePreview) Indicates if a preview of the document is saved when the document is saved.
void	setSubject(String subject) The subject of the document.

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

GlobeDocument

public GlobeDocument()
              throws IOException,
                     UnknownHostException

Constructs a GlobeDocument using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GlobeDocument

public GlobeDocument(Object obj)
              throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GlobeDocument theGlobeDocument = (GlobeDocument) obj;

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

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

isGlobeDocument

public boolean isGlobeDocument(String bsDocument)
                        throws IOException,
                               AutomationException

Indicates if the globe document is a valid globe document.

Product Availability

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

Specified by:

isGlobeDocument in interface IGlobeDocument

Parameters:

bsDocument - The bsDocument (in)

Returns:

The pbIsGlobeDocument

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPresent

public boolean isPresent(String bsDocument)
                  throws IOException,
                         AutomationException

Indicates if the globe document is present.

Product Availability

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

Specified by:

isPresent in interface IGlobeDocument

Parameters:

bsDocument - The bsDocument (in)

Returns:

The pbIsPresent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReadOnly

public boolean isReadOnly(String bsDocument)
                   throws IOException,
                          AutomationException

Indicates if the globe document is read only.

Product Availability

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

Specified by:

isReadOnly in interface IGlobeDocument

Parameters:

bsDocument - The bsDocument (in)

Returns:

The pbIsReadOnly

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRestricted

public boolean isRestricted(String bsDocument)
                     throws IOException,
                            AutomationException

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

Product Availability

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

Specified by:

isRestricted in interface IGlobeDocument

Parameters:

bsDocument - The bsDocument (in)

Returns:

The pbIsRestricted

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPasswordProtected

public boolean isPasswordProtected(String bsDocument)
                            throws IOException,
                                   AutomationException

Indicates if the globe document is protected by a passsword.

Product Availability

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

Specified by:

isPasswordProtected in interface IGlobeDocument

Parameters:

bsDocument - The bsDocument (in)

Returns:

The pbIsPasswordProtected

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_new

public void esri_new(String bsDocument)
              throws IOException,
                     AutomationException

Creates and opens a new globe 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 IGlobeDocument

Parameters:

bsDocument - The bsDocument (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

open

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

Open the globe document in preparation for the contents to be retrieved or updated.

Product Availability

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

Specified by:

open in interface IGlobeDocument

Parameters:

bsDocument - The bsDocument (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 globe document filename that the GlobeDocument coclass is linked to.

Product Availability

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

Specified by:

getDocumentFilename in interface IGlobeDocument

Returns:

The pbsDocument

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 globe document currently loaded in the object.

Product Availability

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

Specified by:

getDocumentType in interface IGlobeDocument

Returns:

A com.esri.arcgis.carto.esriGlobeDocumentType 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 globe document is referenced using relative paths.

Product Availability

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

Specified by:

isUsesRelativePaths in interface IGlobeDocument

Returns:

The pbUsesRelativePaths

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDocumentVersion

public int getDocumentVersion()
                       throws IOException,
                              AutomationException

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

Product Availability

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

Specified by:

getDocumentVersion in interface IGlobeDocument

Specified by:

getDocumentVersion in interface IDocumentVersion

Returns:

A com.esri.arcgis.carto.esriGlobeDocumentVersionInfo constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGlobeObject

public void setGlobeObject(Object ppUnk)
                    throws IOException,
                           AutomationException

The Globe object.

Product Availability

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

Specified by:

setGlobeObject in interface IGlobeDocument

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGlobeObject

public Object getGlobeObject()
                      throws IOException,
                             AutomationException

The Globe object.

Product Availability

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

Specified by:

getGlobeObject in interface IGlobeDocument

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerCount

public int getLayerCount()
                  throws IOException,
                         AutomationException

The number of Layer objects contained within the globe document.

Product Availability

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

Specified by:

getLayerCount in interface IGlobeDocument

Returns:

The plLayerCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayer

public ILayer getLayer(int lLayerIndex)
                throws IOException,
                       AutomationException

The Layer object at the specified index.

Product Availability

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

Specified by:

getLayer in interface IGlobeDocument

Parameters:

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

getThumbnail

public IPicture getThumbnail()
                      throws IOException,
                             AutomationException

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

Product Availability

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

Specified by:

getThumbnail in interface IGlobeDocument

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 globe document.

Product Availability

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

Specified by:

close in interface IGlobeDocument

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVersionInfo

public void getVersionInfo(boolean[] pbVersionInfoMissing,
                           int[] plMajor,
                           int[] plMinor,
                           int[] plRevision,
                           int[] plBuild)
                    throws IOException,
                           AutomationException

Retrieve the detailed version information of the globe document.

Product Availability

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

Specified by:

getVersionInfo in interface IGlobeDocument

Parameters:

pbVersionInfoMissing - The pbVersionInfoMissing (in/out: use single element array)

plMajor - The plMajor (in/out: use single element array)

plMinor - The plMinor (in/out: use single element array)

plRevision - The plRevision (in/out: use single element array)

plBuild - The plBuild (in/out: use single element array)

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 globe document to the bound file.

Product Availability

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

Specified by:

save in interface IGlobeDocument

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 bsDocument,
                   boolean bUseRelativePaths,
                   boolean bCreateThumnbail)
            throws IOException,
                   AutomationException

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

Description

Saves the GlobeDocument that is Open and any changes that have been made to it to a new GlobeDocument with the specified filename. The filename that is supplied must be valid and include the *.3dd extension.

Product Availability

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

Specified by:

saveAs in interface IGlobeDocument

Parameters:

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

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.

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.

isRelativePaths

public boolean isRelativePaths()
                        throws IOException,
                               AutomationException

Indicates if relative path is used when the document is saved.

Product Availability

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

Specified by:

isRelativePaths in interface IDocumentInfo2

Returns:

The useRelativePaths

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRelativePaths

public void setRelativePaths(boolean useRelativePaths)
                      throws IOException,
                             AutomationException

Indicates if relative path is used when the document is saved.

Product Availability

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

Specified by:

setRelativePaths in interface IDocumentInfo2

Parameters:

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