com.esri.arcgis.carto
Interface IDocumentInfo

All Superinterfaces:

Serializable

All Known Implementing Classes:

DocumentInfo, IDocumentInfoProxy, MapDocument, MxDocument

public interface IDocumentInfo
extends Serializable

Provides access to members that control the Document Info.

Product Availability

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

Method Summary

String	getAuthor() The author of the document.
String	getCategory() The category of the document.
String	getComments() Comments for the document.
String	getDocumentTitle() The title of the document.
String	getHyperlinkBase() The hyperlink base of the document.
String	getKeywords() The keywords for the document.
String	getSubject() The subject of the document.
boolean	isSavePreview() Indicates if a preview of the document is saved when the document is saved.
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	setDocumentTitle(String title) The title of the document.
void	setHyperlinkBase(String path) The hyperlink base of the document.
void	setKeywords(String keywords) The keywords for the document.
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.

Method Detail

getDocumentTitle

String getDocumentTitle()
                        throws IOException,
                               AutomationException

The title of the document.

Product Availability

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

Returns:

The title

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDocumentTitle

void setDocumentTitle(String title)
                      throws IOException,
                             AutomationException

The title of the document.

Product Availability

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

Parameters:

title - The title (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubject

String getSubject()
                  throws IOException,
                         AutomationException

The subject of the document.

Product Availability

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

Returns:

The subject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSubject

void setSubject(String subject)
                throws IOException,
                       AutomationException

The subject of the document.

Product Availability

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

Parameters:

subject - The subject (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAuthor

String getAuthor()
                 throws IOException,
                        AutomationException

The author of the document.

Product Availability

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

Returns:

The author

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAuthor

void setAuthor(String author)
               throws IOException,
                      AutomationException

The author of the document.

Product Availability

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

Parameters:

author - The author (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCategory

String getCategory()
                   throws IOException,
                          AutomationException

The category of the document.

Product Availability

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

Returns:

The category

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCategory

void setCategory(String category)
                 throws IOException,
                        AutomationException

The category of the document.

Product Availability

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

Parameters:

category - The category (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getComments

String getComments()
                   throws IOException,
                          AutomationException

Comments for the document.

Product Availability

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

Returns:

The comments

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setComments

void setComments(String comments)
                 throws IOException,
                        AutomationException

Comments for the document.

Product Availability

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

Parameters:

comments - The comments (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getKeywords

String getKeywords()
                   throws IOException,
                          AutomationException

The keywords for the document.

Product Availability

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

Returns:

The keywords

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setKeywords

void setKeywords(String keywords)
                 throws IOException,
                        AutomationException

The keywords for the document.

Product Availability

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

Parameters:

keywords - The keywords (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHyperlinkBase

String getHyperlinkBase()
                        throws IOException,
                               AutomationException

The hyperlink base of the document.

Product Availability

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

Returns:

The path

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHyperlinkBase

void setHyperlinkBase(String path)
                      throws IOException,
                             AutomationException

The hyperlink base of the document.

Product Availability

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

Parameters:

path - The path (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSavePreview

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.

Returns:

The savePreview

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSavePreview

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.

Parameters:

savePreview - The savePreview (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.