com.esri.arcgis.carto
Interface IDocumentInfo2

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
IDocumentInfo3
All Known Implementing Classes:
DocumentInfo, GlobeDocument, GMxDocument, IDocumentInfo2Proxy, IDocumentInfo3Proxy, MapDocument, MxDocument, SxDocument

public interface IDocumentInfo2
extends java.io.Serializable

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

Description: 'Provides access to members that control the Document Info.' 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 IIDd3e5c54f_2a84_11d4_9ff2_00c04f6bc78e
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 java.lang.String getAuthor()
          The author of the document.
 java.lang.String getCategory()
          The category of the document.
 java.lang.String getComments()
          Comments for the document.
 java.lang.String getCredits()
          The credits of the document.
 java.lang.Object getDateExported()
          Date the document was last exported.
 java.lang.Object getDatePrinted()
          Date the document was last printed.
 java.lang.Object getDateSaved()
          Date the document was last saved.
 java.lang.String getDocumentTitle()
          The title of the document.
 java.lang.String getFolder()
          The folder of the document.
 java.lang.String getHyperlinkBase()
          The hyperlink base of the document.
 java.lang.String getKeywords()
          The keywords for the document.
 java.lang.String getName()
          The name of the document.
 java.lang.String getPath()
          The path of the document.
 java.lang.String getSubject()
          The subject of the document.
 boolean isRelativePaths()
          Indicates if relative path is used when the document is saved.
 boolean isSavePreview()
          Indicates if a preview of the document is saved when the document is saved.
 void setAuthor(java.lang.String author)
          The author of the document.
 void setCategory(java.lang.String category)
          The category of the document.
 void setComments(java.lang.String comments)
          Comments for the document.
 void setCredits(java.lang.String credits)
          The credits of the document.
 void setDocumentTitle(java.lang.String title)
          The title of the document.
 void setHyperlinkBase(java.lang.String path)
          The hyperlink base of the document.
 void setKeywords(java.lang.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(java.lang.String subject)
          The subject of the document.
 

Field Detail

IIDd3e5c54f_2a84_11d4_9ff2_00c04f6bc78e

static final int IIDd3e5c54f_2a84_11d4_9ff2_00c04f6bc78e
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

getDocumentTitle

java.lang.String getDocumentTitle()
                                  throws java.io.IOException,
                                         AutomationException
The title of the document.

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

setDocumentTitle

void setDocumentTitle(java.lang.String title)
                      throws java.io.IOException,
                             AutomationException
The title of the document.

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

getSubject

java.lang.String getSubject()
                            throws java.io.IOException,
                                   AutomationException
The subject of the document.

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

setSubject

void setSubject(java.lang.String subject)
                throws java.io.IOException,
                       AutomationException
The subject of the document.

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

getAuthor

java.lang.String getAuthor()
                           throws java.io.IOException,
                                  AutomationException
The author of the document.

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

setAuthor

void setAuthor(java.lang.String author)
               throws java.io.IOException,
                      AutomationException
The author of the document.

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

getCategory

java.lang.String getCategory()
                             throws java.io.IOException,
                                    AutomationException
The category of the document.

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

setCategory

void setCategory(java.lang.String category)
                 throws java.io.IOException,
                        AutomationException
The category of the document.

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

getComments

java.lang.String getComments()
                             throws java.io.IOException,
                                    AutomationException
Comments for the document.

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

setComments

void setComments(java.lang.String comments)
                 throws java.io.IOException,
                        AutomationException
Comments for the document.

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

getKeywords

java.lang.String getKeywords()
                             throws java.io.IOException,
                                    AutomationException
The keywords for the document.

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

setKeywords

void setKeywords(java.lang.String keywords)
                 throws java.io.IOException,
                        AutomationException
The keywords for the document.

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

getHyperlinkBase

java.lang.String getHyperlinkBase()
                                  throws java.io.IOException,
                                         AutomationException
The hyperlink base of the document.

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

setHyperlinkBase

void setHyperlinkBase(java.lang.String path)
                      throws java.io.IOException,
                             AutomationException
The hyperlink base of the document.

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

isSavePreview

boolean isSavePreview()
                      throws java.io.IOException,
                             AutomationException
Indicates if a preview of the document is saved when the document is saved.

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

setSavePreview

void setSavePreview(boolean savePreview)
                    throws java.io.IOException,
                           AutomationException
Indicates if a preview of the document is saved when the document is saved.

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

getCredits

java.lang.String getCredits()
                            throws java.io.IOException,
                                   AutomationException
The credits of the document.

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

setCredits

void setCredits(java.lang.String credits)
                throws java.io.IOException,
                       AutomationException
The credits of the document.

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

isRelativePaths

boolean isRelativePaths()
                        throws java.io.IOException,
                               AutomationException
Indicates if relative path is used when the document is saved.

Returns:
The useRelativePaths
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRelativePaths

void setRelativePaths(boolean useRelativePaths)
                      throws java.io.IOException,
                             AutomationException
Indicates if relative path is used when the document is saved.

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

getName

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
The name of the document.

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

getPath

java.lang.String getPath()
                         throws java.io.IOException,
                                AutomationException
The path of the document.

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

getFolder

java.lang.String getFolder()
                           throws java.io.IOException,
                                  AutomationException
The folder of the document.

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

getDateSaved

java.lang.Object getDateSaved()
                              throws java.io.IOException,
                                     AutomationException
Date the document was last saved.

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

getDatePrinted

java.lang.Object getDatePrinted()
                                throws java.io.IOException,
                                       AutomationException
Date the document was last printed.

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

getDateExported

java.lang.Object getDateExported()
                                 throws java.io.IOException,
                                        AutomationException
Date the document was last exported.

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