com.esri.arcgis.catalogUI
Class IGxContentsViewColumnsProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.catalogUI.IGxContentsViewColumnsProxy

All Implemented Interfaces:

IGxContentsViewColumns, Externalizable, Serializable

public class IGxContentsViewColumnsProxy
extends com.esri.arcgis.interop.Dispatch
implements IGxContentsViewColumns, 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.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IGxContentsViewColumnsProxy()
	IGxContentsViewColumnsProxy(Object obj)
protected	IGxContentsViewColumnsProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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	removeListener(String iidStr, Object theListener)
void	updateColumns() Refresh columns in contents view after insert or remove columns.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IGxContentsViewColumnsProxy

public IGxContentsViewColumnsProxy()

IGxContentsViewColumnsProxy

public IGxContentsViewColumnsProxy(Object obj)
                            throws IOException

Throws:

IOException

IGxContentsViewColumnsProxy

protected IGxContentsViewColumnsProxy(Object obj,
                                      String iid)
                               throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

insertColumn

public 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

Specified by:

insertColumn in interface IGxContentsViewColumns

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

public void removeColumn(IGxContentsViewColumn pColumn)
                  throws IOException,
                         AutomationException

Removes a GxContentsViewColumn.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

removeColumn in interface IGxContentsViewColumns

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

public 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

Specified by:

removeAllColumns in interface IGxContentsViewColumns

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateColumns

public void updateColumns()
                   throws IOException,
                          AutomationException

Refresh columns in contents view after insert or remove columns.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

updateColumns in interface IGxContentsViewColumns

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColumnCount

public 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

Specified by:

getColumnCount in interface IGxContentsViewColumns

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColumnByIndex

public IGxContentsViewColumn getColumnByIndex(int index)
                                       throws IOException,
                                              AutomationException

A column by its index.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getColumnByIndex in interface IGxContentsViewColumns

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

public IGxContentsViewColumn getColumnByProperty(String property)
                                          throws IOException,
                                                 AutomationException

A column by its property.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getColumnByProperty in interface IGxContentsViewColumns

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.