com.esri.arcgis.arcmapui
Interface IContentsViewEdit

All Superinterfaces:

Serializable

All Known Implementing Classes:

GMxDocument, IContentsViewEditProxy, MxDocument

public interface IContentsViewEdit
extends Serializable

Provides access to members that control Contents View Edit.

Description

Used to add or remove tabs of the Table of Contents (TOC) in ArcMap, ArcScene, or ArcGlobe.

Remarks

When tabs are cleared, they are removed from the TOC and also they do not appear in the TOC options dialog (in ArcMap and ArcGlobe: Tools > Options > Table of Contents). To simply show/hide tabs, use IContentsView::Visible. When IContentsViewEdit is used, the tab state is saved in the document template (normal.mxt or normal.sxt). Deleting the document template returns the tab state to the default.

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	addContentsView(IContentsView contentsView) Adds a contents view object to the TOC.
void	clearContentsViews() Removes all current contents views.

Method Detail

clearContentsViews

void clearContentsViews()
                        throws IOException,
                               AutomationException

Removes all current contents views.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addContentsView

void addContentsView(IContentsView contentsView)
                     throws IOException,
                            AutomationException

Adds a contents view object to the TOC.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

contentsView - A reference to a com.esri.arcgis.arcmapui.IContentsView (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.