com.esri.arcgis.arcscene
Interface ISxContentsView

All Superinterfaces:

Serializable

All Known Subinterfaces:

ISxContentsView2

All Known Implementing Classes:

ISxContentsView2Proxy, ISxContentsViewProxy, TOCSxCatalogView, TOCSxDisplayView, TOCSxLegendSelectionView

public interface ISxContentsView
extends Serializable

Provides access to members that control the table of contents views of Sx.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Method Summary

void	activate(int parentHWnd, ISxDocument document) Activates the contents view.
void	addToSelectedItems(Object item) Adds to the selected items.
void	deactivate() Deactivates the contents view.
Object	getContextItem() The context item (could be an enumerator).
int	getHWnd() The HWND of the contents view.
String	getName() The name of the contents view.
Object	getSelectedItem() The selected item (could be an enumerator).
boolean	isShowLines() Indicates whether to show lines in the TOC tree.
boolean	isVisible() Indicates if the view is visible.
void	refresh(Object item) Refreshes the contents view.
void	removeFromSelectedItems(Object item) Removes an item from the selected items.
void	setContextItem(Object item) The context item (could be an enumerator).
void	setProcessEvents(boolean rhs1) Indicates whether the view is currently responding to events.
void	setSelectedItem(Object item) The selected item (could be an enumerator).
void	setShowLines(boolean show) Indicates whether to show lines in the TOC tree.
void	setVisible(boolean vis) Indicates if the view is visible.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

The name of the contents view.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHWnd

int getHWnd()
            throws IOException,
                   AutomationException

The HWND of the contents view.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Returns:

The hWnd (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

activate

void activate(int parentHWnd,
              ISxDocument document)
              throws IOException,
                     AutomationException

Activates the contents view.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Parameters:

parentHWnd - The parentHWnd (A COM typedef) (in)

document - A reference to a com.esri.arcgis.arcscene.ISxDocument (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deactivate

void deactivate()
                throws IOException,
                       AutomationException

Deactivates the contents view.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

void refresh(Object item)
             throws IOException,
                    AutomationException

Refreshes the contents view. If a non-null item is specified, it refreshes only that item and its children.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Parameters:

item - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectedItem

Object getSelectedItem()
                       throws IOException,
                              AutomationException

The selected item (could be an enumerator).

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSelectedItem

void setSelectedItem(Object item)
                     throws IOException,
                            AutomationException

The selected item (could be an enumerator).

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Parameters:

item - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addToSelectedItems

void addToSelectedItems(Object item)
                        throws IOException,
                               AutomationException

Adds to the selected items.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Parameters:

item - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeFromSelectedItems

void removeFromSelectedItems(Object item)
                             throws IOException,
                                    AutomationException

Removes an item from the selected items.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Parameters:

item - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContextItem

Object getContextItem()
                      throws IOException,
                             AutomationException

The context item (could be an enumerator).

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setContextItem

void setContextItem(Object item)
                    throws IOException,
                           AutomationException

The context item (could be an enumerator).

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Parameters:

item - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowLines

boolean isShowLines()
                    throws IOException,
                           AutomationException

Indicates whether to show lines in the TOC tree.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Returns:

The show

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowLines

void setShowLines(boolean show)
                  throws IOException,
                         AutomationException

Indicates whether to show lines in the TOC tree.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Parameters:

show - The show (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if the view is visible.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Returns:

The vis

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisible

void setVisible(boolean vis)
                throws IOException,
                       AutomationException

Indicates if the view is visible.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Parameters:

vis - The vis (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProcessEvents

void setProcessEvents(boolean rhs1)
                      throws IOException,
                             AutomationException

Indicates whether the view is currently responding to events.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.