SortAsync Method (TableView)

In This Topic

Sorts the attributes in the table view.

Syntax

C#
Visual Basic (Declaration)

public Task<bool> SortAsync( 
   IReadOnlyDictionary<string,FieldSortInfo> sortFields
)

Public Function SortAsync( _
   ByVal sortFields As IReadOnlyDictionary(Of String,FieldSortInfo) _
) As Task(Of Boolean)

Parameters

sortFields: The field sort information. When null the sort of the table will revert to database order. If any of the field's sort information is set to FieldSortInfo.AscCase or FieldSortInfo.DescCase, the sort will be case sensitive.

Return Value

Returns True the sort succeeded.

Example

Sort

var tv = TableView.Active;
if (tv == null)
  return;

// sort the active field descending
if (tv.CanSortDescending)
  tv.SortDescending();


// sort the active field ascending
if (tv.CanSortAscending)
  tv.SortAscending();


// peform a custom sort programmatically
if (tv.CanCustomSort)
{
  // sort fields
  var dict = new Dictionary<string, FieldSortInfo>();
  dict.Add("STATE_NAME", FieldSortInfo.Asc);
  dict.Add("CITY_NAME", FieldSortInfo.Desc);
  await tv.SortAsync(dict);
}


// perform a custom sort via the UI
if (tv.CanCustomSort)
  tv.CustomSort();

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3.1 or higher.

Reference

TableView Class
TableView Members

Send feedback