com.esri.arcgis.arcscene
Interface ISxDocumentInfo

All Superinterfaces:

Serializable

All Known Implementing Classes:

ISxDocumentInfoProxy, SxDocument

public interface ISxDocumentInfo
extends Serializable

Provides access to members that control the ArcScene document information.

Remarks

All scene documents have properties, which provide information about the document, such as title of the document, the author etc. The ISxDocumentInfo interface provides such properties for entering the scene document metadata.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Method Summary

String	getAuthor() The author of the document.
String	getCategory() The category of the document.
String	getComments() The 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.
void	setAuthor(String author) The author of the document.
void	setCategory(String category) The category of the document.
void	setComments(String comments) The 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	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 Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

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

Supported Platforms

Windows

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

Supported Platforms

Windows

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

Supported Platforms

Windows

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

Supported Platforms

Windows

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

Supported Platforms

Windows

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

Supported Platforms

Windows

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

Supported Platforms

Windows

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

The comments for the document.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

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

The comments for the document.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

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

Supported Platforms

Windows

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

Supported Platforms

Windows

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

Supported Platforms

Windows

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.

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

Parameters:

path - The path (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.