com.esri.arcgis.arcmapui
Interface ITableWindow

All Superinterfaces:
IDataWindow, Serializable
All Known Implementing Classes:
TableWindow

public interface ITableWindow
extends IDataWindow, Serializable

Provides access to members that display table window in ArcMap. This interface intergrates ITableView with ArcMap's events and selections.

Superseded By

ITableWindow2

Product Availability

Available with ArcGIS Desktop.


Method Summary
 ITableWindow findViaFeatureLayer(IFeatureLayer pFeatureLayer, boolean showSelected)
          Is table (of a featurelayer) already being displayed.
 ITableWindow findViaTable(ITable pTable, boolean showSelected)
          Is table already being displayed.
 IFeatureLayer getFeatureLayer()
          Setup feature class to view/edit.
 ISelectionSet getSelectionSet()
          Current s1election set of the table.
 ITable getTable()
          Setup table to view/edit.
 ITableControl getTableControl()
          The table control.
 int getTableSelectionAction()
          Action to perform when table selections are made.
 boolean isShowSelected()
          Indicates whether to show only features that are selected.
 void setFeatureLayerByRef(IFeatureLayer ppFeatureLayer)
          Setup feature class to view/edit.
 void setShowAliasNamesInColumnHeadings(boolean rhs1)
          Show alias names or the real field name in column headings.
 void setShowSelected(boolean pShowSelected)
          Indicates whether to show only features that are selected.
 void setTableByRef(ITable ppTable)
          Setup table to view/edit.
 void setTableSelectionAction(int pAction)
          Action to perform when table selections are made.
 void updateSelection(ISelectionSet pSelection)
          Updates current table selection.
 
Methods inherited from interface com.esri.arcgis.arcmapui.IDataWindow
getHWnd, isDockable, isVisible, putPosition, queryPosition, refresh, setApplicationByRef, show
 

Method Detail

setTableByRef

void setTableByRef(ITable ppTable)
                   throws IOException,
                          AutomationException
Setup table to view/edit.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:
ppTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTable

ITable getTable()
                throws IOException,
                       AutomationException
Setup table to view/edit.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFeatureLayerByRef

void setFeatureLayerByRef(IFeatureLayer ppFeatureLayer)
                          throws IOException,
                                 AutomationException
Setup feature class to view/edit.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:
ppFeatureLayer - A reference to a com.esri.arcgis.carto.IFeatureLayer (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFeatureLayer

IFeatureLayer getFeatureLayer()
                              throws IOException,
                                     AutomationException
Setup feature class to view/edit.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:
A reference to a com.esri.arcgis.carto.IFeatureLayer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTableSelectionAction

void setTableSelectionAction(int pAction)
                             throws IOException,
                                    AutomationException
Action to perform when table selections are made.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:
pAction - A com.esri.arcgis.geodatabaseui.esriTableSelectionActions constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTableSelectionAction

int getTableSelectionAction()
                            throws IOException,
                                   AutomationException
Action to perform when table selections are made.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:
A com.esri.arcgis.geodatabaseui.esriTableSelectionActions constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowSelected

void setShowSelected(boolean pShowSelected)
                     throws IOException,
                            AutomationException
Indicates whether to show only features that are selected.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:
pShowSelected - The pShowSelected (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowSelected

boolean isShowSelected()
                       throws IOException,
                              AutomationException
Indicates whether to show only features that are selected.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:
The pShowSelected
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findViaFeatureLayer

ITableWindow findViaFeatureLayer(IFeatureLayer pFeatureLayer,
                                 boolean showSelected)
                                 throws IOException,
                                        AutomationException
Is table (of a featurelayer) already being displayed.

Remarks

This method returns a reference to the TableWindow of the FeatureLayer referenced by pFeatureLayer. Set ShowSelected = True if you wish to show only features that are selected.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:
pFeatureLayer - A reference to a com.esri.arcgis.carto.IFeatureLayer (in)
showSelected - The showSelected (in)
Returns:
A reference to a com.esri.arcgis.arcmapui.ITableWindow
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findViaTable

ITableWindow findViaTable(ITable pTable,
                          boolean showSelected)
                          throws IOException,
                                 AutomationException
Is table already being displayed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:
pTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
showSelected - The showSelected (in)
Returns:
A reference to a com.esri.arcgis.arcmapui.ITableWindow
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSelectionSet

ISelectionSet getSelectionSet()
                              throws IOException,
                                     AutomationException
Current s1election set of the table. Only valid for tables showing all rows.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:
A reference to a com.esri.arcgis.geodatabase.ISelectionSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateSelection

void updateSelection(ISelectionSet pSelection)
                     throws IOException,
                            AutomationException
Updates current table selection. Does not update Mx feature layer selection.

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.

setShowAliasNamesInColumnHeadings

void setShowAliasNamesInColumnHeadings(boolean rhs1)
                                       throws IOException,
                                              AutomationException
Show alias names or the real field name in column headings. Default False.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTableControl

ITableControl getTableControl()
                              throws IOException,
                                     AutomationException
The table control. Table needs to be showing before you can get a valid pointer.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:
A reference to a com.esri.arcgis.geodatabaseui.ITableControl
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.