com.esri.arcgis.catalogUI
Interface IGxContentsViewColumn

All Superinterfaces:

Serializable

All Known Implementing Classes:

GxContentsViewColumn

public interface IGxContentsViewColumn
extends Serializable

Provides access to members that control the GxContentsViewColumn.

Description

The IGxContentsViewColumn interface provides access to the properties of the columns contained within the GxContentsView object. The column properties allow you to set the width, visibility, and caption of the column. Intrinsic properties (Intrinsic property set to True) are properties such as Name, Category, and Size. These are not really useful unless you add your own GxObject through a new workspace factory; if you do this, you have the ability to add object-specific special properties.

The PropertyName property is based on keywords within the metadata for the object. Make sure you have metadata with the specific keyword before using it as a PropertyName.

Remarks

The IGxContentsViewColumn interface provides access to the properties of the columns contained within the GxContentsView object. The column properties allow for setting of the width, visibility, and caption of the column.

Intrinsic properties (Intrinsic property set to True) are things such as Name, Category, Size, etc. These are not really useful unless a developer adds their own GxObject through a new workspace factory, then he or she has the ability to add object specific "special" properties.

Product Availability

Available with ArcGIS Desktop.

Method Summary

String	getCaption() The caption of the column.
String	getPropertyName() The property name.
int	getWidth() The width of the column.
boolean	isIntrinsic() Indicates if intrinsic.
boolean	isVisible() Indicates if visible.
void	setCaption(String pCaption) The caption of the column.
void	setIntrinsic(boolean pIntrinsic) Indicates if intrinsic.
void	setPropertyName(String pPropName) The property name.
void	setVisible(boolean pVisible) Indicates if visible.
void	setWidth(int pWidth) The width of the column.

Method Detail

getCaption

String getCaption()
                  throws IOException,
                         AutomationException

The caption of the column.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The pCaption

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCaption

void setCaption(String pCaption)
                throws IOException,
                       AutomationException

The caption of the column.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

pCaption - The pCaption (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPropertyName

String getPropertyName()
                       throws IOException,
                              AutomationException

The property name.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The pPropName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPropertyName

void setPropertyName(String pPropName)
                     throws IOException,
                            AutomationException

The property name.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

pPropName - The pPropName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWidth

int getWidth()
             throws IOException,
                    AutomationException

The width of the column.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The pWidth

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWidth

void setWidth(int pWidth)
              throws IOException,
                     AutomationException

The width of the column.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

pWidth - The pWidth (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if visible.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The pVisible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisible

void setVisible(boolean pVisible)
                throws IOException,
                       AutomationException

Indicates if visible.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

pVisible - The pVisible (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIntrinsic

boolean isIntrinsic()
                    throws IOException,
                           AutomationException

Indicates if intrinsic.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The pIntrinsic

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIntrinsic

void setIntrinsic(boolean pIntrinsic)
                  throws IOException,
                         AutomationException

Indicates if intrinsic.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

pIntrinsic - The pIntrinsic (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.