ArcGIS Pro 3.1 API Reference Guide
ArcGIS.Desktop.Mapping Namespace / TableView Class
Properties Methods


In This Topic
    TableView Class Members
    In This Topic

    The following tables list the members exposed by TableView.

    Public Properties
     NameDescription
    Public Propertystatic (Shared in Visual Basic)Active Gets the active table view.  
    Public PropertyActiveFieldIndex Gets the zero based index of the active field in the table. Can be -1 if there are no fields.  
    Public PropertyActiveObjectId Gets the ObjectID of the active row in the table. The value of the row can be null, when the table does not have object ids, the active row is the new row, or the data for the row has not been loaded.  
    Public PropertyActiveRowIndex Gets the zero based index of the active row in the table. Can be -1 if there is no active row.  
    Public PropertyCanAddField Determines if the Add Field GP tool can be displayed.  
    Public PropertyCanClearHighlighted Determines if the table view can clear its highlight. The table view must be showing the Selected Records view.  
    Public PropertyCanClearSelection Determines if the table view can clear its selection.  
    Public PropertyCanCustomSort Determines if the table view can display the custom sort dialog.  
    Public PropertyCanDeleteField Determines if the active field of the table view can be deleted.  
    Public PropertyCanDeleteHighlighted Determines if the table can delete the highlighted rows. The table view must be showing the Selected Records view.  
    Public PropertyCanDeleteSelected Determines if the table view can delete the selected rows.  
    Public PropertyCanExport Determines if the table view can export its attributes.  
    Public PropertyCanFind Determines if the table view can display the Find control.  
    Public PropertyCanFindAndReplace Determines if the table view can display the Find and replace control.  
    Public PropertyCanGetHighlightedObjectIds Gets if the objectIds of the highlighted rows can be retrieved. The table view must be showing the Selected Records view.  
    Public PropertyCanGoTo Determines if the table view can display the Go to row number control.  
    Public PropertyCanHideSelectedFields Determines if the table view's selected fields can be hidden.  
    Public PropertyCanHighlight Gets if rows can be highlighted in the table view. The table view must be showing the Selected Records view.  
    Public PropertyCanPanToHighlighted Determines if the table can pan to the highlighted rows. The table view must be showing the Selected Records view.  
    Public PropertyCanPanToSelected Determines if the table view can pan to the selected rows.  
    Public PropertyCanRefresh Determines if the table view can refresh its content.  
    Public PropertyCanResetFieldOrder Resets the field order in the table view.  
    Public PropertyCanSelect Determines if the table view can select rows.  
    Public PropertyCanSelectAll Determines if the table view can select all of its rows.  
    Public PropertyCanShowAllFields Determines if the table view can show all fields.  
    Public PropertyCanSortAscending Determines if the table view can sort the active field.  
    Public PropertyCanSortDescending Determines if the table view can sort the active field.  
    Public PropertyCanSwitchHighlight Determines if the table view can switch its highglight. The table view must be showing the Selected Records view.  
    Public PropertyCanSwitchSelection Determines if the table view can switch its selection.  
    Public PropertyCanToggleFieldAlias Determines if the table view can toggle the field name and alias.  
    Public PropertyCanToggleRowHighlight Determines if the table view can toggle the highlight of the active row. The table view must be showing the Selected Records view.  
    Public PropertyCanToggleRowSelection Determines if the table view can toggle the selection of the active row.  
    Public PropertyCanToggleSubtypeDomainDescriptions Determines if the table view can toggle between the subtype and domain descriptions and codes  
    Public PropertyCanZoomToHighlighted Determines if the table can zoom to the highlighted rows. The table view must be showing the Selected Records view.  
    Public PropertyCanZoomToSelected Determines if the table view can zoom to the selected rows.  
    Public PropertyIsReadyGets a value that indicates whether the TableView can be accessed. This property is false while the table view processes major operations like initializing.  
    Public PropertyIsRowCountKnown Gets the IsRowCountKnown property indicating the table view knows the count of rows in the data source.  
    Public PropertyItemGets the item source of the table view. Use ArcGIS.Desktop.Core.ItemFactory.CanGetDataset and ArcGIS.Desktop.Core.ItemFactory.GetDataset to retrieve the data.  
    Public PropertyMapMember Gets the Layer or StandaloneTable source of the table view.  
    Public PropertyRowCount Gets the number of rows in the data source. If the IsRowCountKnown is true, then this is a total count.  
    Public PropertyRowsPerPage Gets the number of rows the table view is requesting, from the data source, for each page.  
    Public PropertyShowFieldAlias Gets and sets the current state of displaying the field alias.  
    Public PropertyShowSubtypeDomainDescriptions Gets and sets the current state of displaying subtype and domain descriptions.  
    Public PropertyViewMode Gets the view mode of the table view.  
    Public PropertyZoomLevel Gets the zoom level for the table view.  
    Top
    Public Methods
     NameDescription
    Public MethodAddField Displays the Add Field GP tool.  
    Public MethodBringIntoView Scroll the table grid to the desired row and field and set the active cell.  
    Public MethodClearAllFrozenFieldsAsync Clears all the frozen fields.  
    Public MethodClearHighlighted Clears the current highlight of the table view.  
    Public MethodClearSelection Clears the current selection of the table view.  
    Public MethodCustomSort Shows the custom field sort dialog.  
    Public MethodDeleteField Deletes the active field of the table view.  
    Public MethodDeleteHighlighted Deletes the highlighted rows.  
    Public MethodDeleteSelected Deletes the selected rows in the table view.  
    Public MethodExport Shows the Export Talbe GP tool for exporting the attributes of the table view.  
    Public MethodFind Shows the Find control.  
    Public MethodFindAndReplace Shows the Find and Replace control.  
    Public MethodGetActivePageObjectIds Get the object ids of all active pages. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodGetAllObjectIds Gets all the sorted object ids from the data source. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodGetField Gets the field at the given index.  
    Public MethodGetFieldIndex Gets the index of the field with the given name.  
    Public MethodGetFieldsGets a read-only list of FieldDescription representing the columns in the table.  
    Public MethodGetFrozenFields Gets the set of frozen fields in the table view.  
    Public MethodGetHiddenFields Gets the set of hidden fields in the table view.  
    Public MethodGetHighlightedObjectIds Gets all the highlighted object ids from the data source.  
    Public MethodGetObjectIdAsyncGets the object id for a row in the current ViewMode of the table.  
    Public MethodGetRowCountAsync Loads the row count from the data source.  
    Public MethodGetRowIndexGets the index of a row in the current ViewMode of the table. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodGetRowIndexAsyncGets the index of a row in the current ViewMode of the table.  
    Public MethodGetSelectedFields Gets the set of selected fields in the table view.  
    Public MethodGetSelectedObjectIds Gets all the selected object ids from the data source. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodGetSelectedRowIndexes Gets the indexes of all the selected rows. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodGoTo Shows the Go to row number control.  
    Public MethodHideSelectedFields Hides the selected fields of the table view.  
    Public MethodHighlight Highlights rows in the table view.  
    Public MethodPanToHighlighted Pans to the highlighted rows.  
    Public MethodPanToSelected Pans to the selected rows in the table view.  
    Public MethodRefresh Refreshes the content of the table view.  
    Public MethodResetFieldOrder Resets the field order in the table view.  
    Public MethodSelect Selects rows in the table view. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSelectAll Selects all the rows in the table view.  
    Public MethodSetActiveFieldOverloaded.   
    Public MethodSetFieldOrderAsync Sets the field order in the table view according to the specified set of field names.  
    Public MethodSetFrozenFieldsAsync Sets the specified fields to be frozen in the table view. Frozen fields are promoted to be the first visible fields in the table view and stay visible as the table view is scrolled horizontally. A divider bar is placed between the frozen fields and the remaining fields in the table. The specified list of fields are added to any existing fields that are already frozen.  
    Public MethodSetHiddenFieldsSets the specified fields to be hidden in the table view UI. The specified list of fields are added to any existing fields that are already hidden. To display all fields use ShowAllFields.  
    Public MethodSetSelectedFields Sets the specified fields to be selected in the table view.  
    Public MethodSetViewMode Sets the view mode of the table view.  
    Public MethodSetZoomLevel Set the zoom level for the table view. The allowed values are 50 to 400.  
    Public MethodShowAllFields Shows all fields on the table view.  
    Public MethodSortAscending Sorts the values of the active field from lowest to highest.  
    Public MethodSortAsync Sorts the attributes in the table view.  
    Public MethodSortDescending Sorts the values of the active field from highest to lowest.  
    Public MethodSwitchHighlight Switch the current highlight of the table view.  
    Public MethodSwitchSelection Switch the current selection of the table view.  
    Public MethodToggleFieldAlias Toggles between the field name and alias on the column headers of the table view.  
    Public MethodToggleRowHighlight Toggles the highlight of the active row of the table view.  
    Public MethodToggleRowSelection Toggles the selection of the active row of the table view.  
    Public MethodToggleSubtypeDomainDescriptionsAsync Toggles between the subtype and domain descriptions and codes in the colums of the table view.  
    Public MethodZoomToHighlighted Zooms to the highlighted rows.  
    Public MethodZoomToSelected Zooms to the selected rows in the table view.  
    Top
    See Also

    Reference

    TableView Class
    ArcGIS.Desktop.Mapping Namespace

     

     

    ©2023 Esri Inc., All Rights Reserved. Generated on Friday, February 17, 2023

    Send feedback