com.esri.arcgis.catalogUI
Interface IGxContentsViewColumns

All Superinterfaces:

Serializable

All Known Implementing Classes:

GxContentsView, IGxContentsViewColumnsProxy

public interface IGxContentsViewColumns
extends Serializable

Provides access to members that control the columns of GxContentsView.

Description

The IGxContentsViewColumns interface serves as a container for the GxContentsViewColumn objects contained within the GxContentsView object. The objects in the collection represent the columns in the tabbed display area of the view (when Contents is the active tab).

After using the InsertColumn method to add your new column, execute the UpdateColumn method to refresh the column list. RemoveAllColumns will not remove the Name and Type columns. These columns cannot be removed. Keep in mind that removal of columns is not just for that session, it is permanent.

Remarks

The IGxContentsViewColumns interface serves as a containter for the GxContentsViewColumn objects contained within the GxContentsView object. The objects in the collection represent the columns in the tabbed display area of the view (when "Contents" is the active tab).

Product Availability

Available with ArcGIS Desktop.

Method Summary

IGxContentsViewColumn	getColumnByIndex(int index) A column by its index.
IGxContentsViewColumn	getColumnByProperty(String property) A column by its property.
int	getColumnCount() The total number of columns (include both visible and invisible columns).
void	insertColumn(int index, IGxContentsViewColumn pColumn) Inserts a GxContentsViewColumn before the specified index.
void	removeAllColumns() Removes all columns except Name and Type column (they are always shown).
void	removeColumn(IGxContentsViewColumn pColumn) Removes a GxContentsViewColumn.
void	updateColumns() Refresh columns in contents view after insert or remove columns.

Method Detail

insertColumn

void insertColumn(int index,
                  IGxContentsViewColumn pColumn)
                  throws IOException,
                         AutomationException

Inserts a GxContentsViewColumn before the specified index. If index is -1, the column is inserted at the end.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

index - The index (in)

pColumn - A reference to a com.esri.arcgis.catalogUI.IGxContentsViewColumn (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeColumn

void removeColumn(IGxContentsViewColumn pColumn)
                  throws IOException,
                         AutomationException

Removes a GxContentsViewColumn.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

pColumn - A reference to a com.esri.arcgis.catalogUI.IGxContentsViewColumn (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAllColumns

void removeAllColumns()
                      throws IOException,
                             AutomationException

Removes all columns except Name and Type column (they are always shown).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateColumns

void updateColumns()
                   throws IOException,
                          AutomationException

Refresh columns in contents view after insert or remove columns.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColumnCount

int getColumnCount()
                   throws IOException,
                          AutomationException

The total number of columns (include both visible and invisible columns).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColumnByIndex

IGxContentsViewColumn getColumnByIndex(int index)
                                       throws IOException,
                                              AutomationException

A column by its index.

Product Availability

Available with ArcGIS Desktop.

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColumnByProperty

IGxContentsViewColumn getColumnByProperty(String property)
                                          throws IOException,
                                                 AutomationException

A column by its property.

Product Availability

Available with ArcGIS Desktop.

Parameters:

property - The property (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.