Add(String,Boolean) Method

Adds a column to the sorted column collection

Syntax

Visual Basic

'Declaration
 
Public Overloads Function Add( _
   ByVal key As String, _
   ByVal descending As Boolean _
) As Integer

C#

public int Add( 
   string key,
   bool descending
)

Parameters

key

A value that uniquely identifies an object in a collection.

descending

True to sort the column in descending order. False to sort ascending.

Return Value

The position into which the new element was inserted.

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 Basic

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#

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 );

}

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2