com.esri.arcgis.catalogUI
Interface IGxPreview

All Superinterfaces:

Serializable

All Known Implementing Classes:

GxPreview, GxRasterCatalogContentView, IGxPreviewProxy

public interface IGxPreview
extends Serializable

Provides access to members that control the GxPreview.

Remarks

The IGxPreview interface is implemented only by the GxPreview object and provides access to the supported views for the selected object. Use this interface when you want to find out what the supported views are, or to retrieve or set the current view.

Product Availability

Available with ArcGIS Desktop.

Method Summary

ISet	getSupportedViewClassIDs() A list of the class IDs for the views that are supported given the current selection.
IGxView	getView() The current view.
IUID	getViewClassID() The class ID of the current view.
void	setViewClassID(IUID viewClassID) The class ID of the current view.

Method Detail

getView

IGxView getView()
                throws IOException,
                       AutomationException

The current view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.catalogUI.IGxView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getViewClassID

IUID getViewClassID()
                    throws IOException,
                           AutomationException

The class ID of the current view.

Remarks

TheViewClassID property is used to set and retrieve the current view through its UID. Setting the UID is the only method for changing the current view within the GxPreview object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setViewClassID

void setViewClassID(IUID viewClassID)
                    throws IOException,
                           AutomationException

The class ID of the current view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

viewClassID - A reference to a com.esri.arcgis.system.IUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSupportedViewClassIDs

ISet getSupportedViewClassIDs()
                              throws IOException,
                                     AutomationException

A list of the class IDs for the views that are supported given the current selection.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.system.ISet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.