com.esri.arcgis.geodatabaseui
Interface ITableControl3

All Superinterfaces:

Serializable

All Known Implementing Classes:

TableView

public interface ITableControl3
extends Serializable

Provides access to members that control the table once it has been shown.

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	drawSelectedShapes(IDisplay pDisplay) Draws selected features on display.
void	editChanged() Call after start or stop editing, to update table grid.
void	executeOptionCommand(int option) Executes a command in the option menu.
int	getCurrentRow(boolean isOid) The current row the user is on.
void	insertNextRowAt(int placement, int oid) Determines where the next insert record is inserted when OnCreate is fired.
void	readToEndOfTable() Read all the OIDs/Rows in the table.
void	redraw() Redraws the grid.
void	removeAndReloadCache() Lose cache, so the table window is current with the underlying database.
void	rereadFIDs(ISelectionSet pSelection) Rereads rows.
void	setCellFont(int oid, String fieldName, IColor pCellColor, IFont pTextFont, IColor pTextColor) Overrides the font setting for table cells.
void	setCurrentRow(boolean isOid, int rowNumber) The current row the user is on.
void	setHideOptionsButton(boolean rhs1) Hides the options button.
void	setHideViewToggleButtons(boolean rhs1) Hides the view toggle buttons.
void	setSelectToggleAlwaysEnabled(boolean rhs1) Ensures that the Select button is always active of the view toggle buttons.
void	updateSelection(ISelectionSet pSelection) Updates the current selection, that the current selection is currently pointing to.

Method Detail

editChanged

void editChanged()
                 throws IOException,
                        AutomationException

Call after start or stop editing, to update table grid.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAndReloadCache

void removeAndReloadCache()
                          throws IOException,
                                 AutomationException

Lose cache, so the table window is current with the underlying database.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateSelection

void updateSelection(ISelectionSet pSelection)
                     throws IOException,
                            AutomationException

Updates the current selection, that the current selection is currently pointing to.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

pSelection - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

drawSelectedShapes

void drawSelectedShapes(IDisplay pDisplay)
                        throws IOException,
                               AutomationException

Draws selected features on display.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

rereadFIDs

void rereadFIDs(ISelectionSet pSelection)
                throws IOException,
                       AutomationException

Rereads rows. Called when viewing selected records and the selection changes.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

pSelection - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentRow

void setCurrentRow(boolean isOid,
                   int rowNumber)
                   throws IOException,
                          AutomationException

The current row the user is on. If isOid = TRUE, then rowNumber is an OID, else it is an offset.

Description

1. Offset is a number that is relative with respect to a displayed table view. The same offset number when specified could possibly return a different row in a table unlike the Object ID which will return the same row every time.
2. Zero is valid number for offset (but it really does not offset anything in the Table View). Specifying a value greater than 0 will offset a row. When zero is specified as offset for SetCurrentRow it does not set a current row in the table view at all.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

isOid - The isOid (in)

rowNumber - The rowNumber (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentRow

int getCurrentRow(boolean isOid)
                  throws IOException,
                         AutomationException

The current row the user is on. If isOid = TRUE, then rowNumber is an OID, else it is an offset.

Description

1. Offset is a number that is relative with respect to a displayed table view. The same offset number when specified could possibly return a different row in a table unlike the Object ID which will return the same row every time.
2. Zero is valid number for offset (but it really does not offset anything in the Table View). Specifying a value greater than 0 will offset a row. When zero is specified as offset for SetCurrentRow it does not set a current row in the table view at all.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

isOid - The isOid (in)

Returns:

The pRowNumber

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

redraw

void redraw()
            throws IOException,
                   AutomationException

Redraws the grid.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

readToEndOfTable

void readToEndOfTable()
                      throws IOException,
                             AutomationException

Read all the OIDs/Rows in the table.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCellFont

void setCellFont(int oid,
                 String fieldName,
                 IColor pCellColor,
                 IFont pTextFont,
                 IColor pTextColor)
                 throws IOException,
                        AutomationException

Overrides the font setting for table cells. At least the oid or fieldName must be specified. Enter null fonts to erase.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

oid - The oid (in)

fieldName - The fieldName (in)

pCellColor - A reference to a com.esri.arcgis.display.IColor (in)

pTextFont - A reference to a com.esri.arcgis.support.ms.stdole.IFont (in)

pTextColor - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insertNextRowAt

void insertNextRowAt(int placement,
                     int oid)
                     throws IOException,
                            AutomationException

Determines where the next insert record is inserted when OnCreate is fired. Adding records manually via the table window allways adds records to the end of the table.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

placement - A com.esri.arcgis.geodatabaseui.esriTVRowInsertPlacement constant (in)

oid - The oid (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

executeOptionCommand

void executeOptionCommand(int option)
                          throws IOException,
                                 AutomationException

Executes a command in the option menu.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

option - A com.esri.arcgis.geodatabaseui.esriTableViewOptions constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHideOptionsButton

void setHideOptionsButton(boolean rhs1)
                          throws IOException,
                                 AutomationException

Hides the options button. Default is False.

Product Availability

Available with ArcGIS Desktop.

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSelectToggleAlwaysEnabled

void setSelectToggleAlwaysEnabled(boolean rhs1)
                                  throws IOException,
                                         AutomationException

Ensures that the Select button is always active of the view toggle buttons. Default is False.

Product Availability

Available with ArcGIS Desktop.

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHideViewToggleButtons

void setHideViewToggleButtons(boolean rhs1)
                              throws IOException,
                                     AutomationException

Hides the view toggle buttons. Default is False.

Product Availability

Available with ArcGIS Desktop.

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.