com.esri.arcgis.carto
Interface IDocumentPreview

All Superinterfaces:

Serializable

All Known Implementing Classes:

GMxDocument, IDocumentPreviewProxy, MapDocument, MxDocument, SxDocument

public interface IDocumentPreview
extends Serializable

Provides access to members that control the Document Preview.

Product Availability

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

Method Summary

void	createPreview() Creates a thumbnail preview of the document.
void	deletePreview() Deletes the thumbnail preview of the 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.

Method Detail

createPreview

void createPreview()
                   throws IOException,
                          AutomationException

Creates a thumbnail preview of the document.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deletePreview

void deletePreview()
                   throws IOException,
                          AutomationException

Deletes the thumbnail preview of the document.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasPreviewSaved

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.

Returns:

The hasPreviewSaved

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasPreviewToSave

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.

Returns:

The hasPreviewToSave

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.