Syncfusion.XlsIO.Base
Example 


Column Index to sort the data.
To sort the data based on.
To order the sorted data.

Add Method (ISortFields)

Adds the SortField in the collection.
Syntax
'Declaration
 
Function Add( _
   ByVal key As Integer, _
   ByVal sortBasedOn As SortOn, _
   ByVal orderBy As OrderBy _
) As ISortField
'Usage
 
Dim instance As ISortFields
Dim key As Integer
Dim sortBasedOn As SortOn
Dim orderBy As OrderBy
Dim value As ISortField
 
value = instance.Add(key, sortBasedOn, orderBy)

Parameters

key
Column Index to sort the data.
sortBasedOn
To sort the data based on.
orderBy
To order the sorted data.

Return Value

Returns the Added ISortField.
Example
The Add method adds ISortField to the ISortFields collection and returns it. The following code illustrates how ISortField can be added to ISortFields collection using Add method.
using Syncfusion.XlsIO;
            
class Program
{
    static void Main()
    {
        using (ExcelEngine excelEngine = new ExcelEngine())
        {
            //Create worksheet
            IApplication application = excelEngine.Excel;
            application.DefaultVersion = ExcelVersion.Excel2013;
            IWorkbook workbook = application.Workbooks.Create(1);
            IWorksheet worksheet = workbook.Worksheets[0];
            
            //Load data
            worksheet["A1"].Text = "Products";
            worksheet["A2"].Text = "Alfreds Futterkiste";
            worksheet["A3"].Text = "Antonio Moreno Taqueria";
            worksheet["A4"].Text = "Around the Horn";
            worksheet["A5"].Text = "Bon app";
            worksheet["A6"].Text = "Eastern Connection";
            worksheet["A7"].Text = "Ernst Handel";
            worksheet["B1"].Text = "Qtr1";
            worksheet["B2"].Number = 744.6;
            worksheet["B3"].Number = 5079.6;
            worksheet["B4"].Number = 1267.5;
            worksheet["B5"].Number = 1418;
            worksheet["B6"].Number = 4728;
            worksheet["B7"].Number = 943.89;
            worksheet["C1"].Text = "Qtr2";
            worksheet["C2"].Number = 162.56;
            worksheet["C3"].Number = 1249.2;
            worksheet["C4"].Number = 1062.5;
            worksheet["C5"].Number = 756;
            worksheet["C6"].Number = 4547.92;
            worksheet["C7"].Number = 349.6;
            
            //Create style for table number format
            IStyle style1 = workbook.Styles.Add("CurrencyFormat");
            style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)";
            
            //Apply number format
            worksheet["B2:C8"].CellStyleName = "CurrencyFormat";
            
            //Create sorter
            IDataSort sorter = workbook.CreateDataSorter();
            
            //Set range
            sorter.SortRange = worksheet["A1:C7"];
            
            //Add sortfield
            ISortField sortField = sorter.SortFields.Add(0, SortOn.Values, OrderBy.Ascending);
            
            //Perform sort
            sorter.Sort();
            
            //Apply AutoFit
            worksheet.UsedRange.AutofitColumns();
            
            //Save and Dispose
            workbook.SaveAs("Datasort.xlsx");
            workbook.Close();
        }
    }
}
AssemblyVersion

Syncfusion.XlsIO.Base: 17.1460.0.47

See Also