Infragistics(R) NetAdvantage(R) Windows Forms
SortIndicator Property
See Also  Example E-mail your feedback on this topic.
Infragistics.Win.UltraWinGrid Namespace > UltraGridColumn Class : SortIndicator Property

Returns or sets a value that indicates the sorted order of the column.

Syntax

Visual Basic (Declaration) 
Public Property SortIndicator As SortIndicator
C# 
public SortIndicator SortIndicator {get; set;}

Example

Following code shows how to programmatically sort rows. SortIndicator property returns the current state of sorting on the column. If the column is sorted, then it returns either Ascending or Descending depending on how the column is sorted. It returns None if the column is not sorted. It can also return Disabled if the property was set to that value previously. You can also set the property to change it's sort status. For example, you can set the property to Ascending and Descending to sort row by the column. You can set it to None to clear sorting. You can set it to Disabled to prevent the user from sorting by that column.

Visual BasicCopy Code
Imports Infragistics.Shared
Imports Infragistics.Win
Imports Infragistics.Win.UltraWinGrid

  Private Sub Button22_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles button22.Click

      Dim band As UltraGridBand = Me.ultraGrid1.DisplayLayout.Bands(0)

      ' Sort the rows by Country and City fields. Notice the order in which these columns 
      ' are set. We want to sort by Country and then sort by City and in order to do that
      ' we have to set the SortIndicator property in the right order.
      band.Columns("Country").SortIndicator = SortIndicator.Ascending
      band.Columns("City").SortIndicator = SortIndicator.Ascending

	' To sort multi-column using SortedColumns property
	' This enables multi-column sorting
	this.ultraGrid1.DisplayLayout.Override.HeaderClickAction = Infragistics.Win.UltraWinGrid.HeaderClickAction.SortMulti
	
	' It is good practice to clear the sorted columns collection
      band.SortedColumns.Clear()

      ' You can sort (as well as group rows by) columns by using SortedColumns 
      ' property off the band
      band.SortedColumns.Add("ContactName", False, False)

  End Sub
C#Copy Code
using Infragistics.Shared;
using Infragistics.Win;
using Infragistics.Win.UltraWinGrid;
using System.Diagnostics;

private void button22_Click(object sender, System.EventArgs e)
{

	UltraGridBand band = this.ultraGrid1.DisplayLayout.Bands[0];

	// Sort the rows by Country and City fields. Notice the order in which these columns 
	// are set. We want to sort by Country and then sort by City and in order to do that
	// we have to set the SortIndicator property in the right order.
	band.Columns["Country"].SortIndicator = SortIndicator.Ascending;
	band.Columns["City"].SortIndicator    = SortIndicator.Ascending;

	// To sort multi-column using SortedColumns property
	// This enables multi-column sorting
	this.ultraGrid1.DisplayLayout.Override.HeaderClickAction = Infragistics.Win.UltraWinGrid.HeaderClickAction.SortMulti;
	
	// It is good practice to clear the sorted columns collection
      and.SortedColumns.Clear();

	// You can sort (as well as group rows by) columns by using SortedColumns 
	// property off the band
	band.SortedColumns.Add( "ContactName", false, false );

}

Remarks

The UltraGrid can automatically sort the contents of columns without the addition of any code. While the UltraGrid can sort the data in columns automatically, it also gives you tools to implement your own sorting behavior through code.

Column headers can display a sort indicator in a column's header. When clicked and the HeaderClickAction property is set to HeaderClickAction.SortSingle or HeaderClickAction.SortMulti, the SortIndicator property is set to specify the order in which the column should be sorted, and the column is added to a special Columns collection just for sorted columns. If automatic sorting is disabled, in addition to adding the column to the Columns collection accessed by SortedCols, the control fires the BeforeSortChange and AfterSortChange events so that you can examine the contents of the collection, check the value of the SortIndicator property of each column, and perform the sort.

See Also