How to: Sort Data

• Nov 13, 2018

The following example demonstrates how to sort Snap document data using the following steps.

1. Load the document template using the RichEditDocumentServer.LoadDocumentTemplate method.
2. Call the ISnapFieldOwner.CreateSnList method to create a new Snap list or retrieve one of the existing lists by calling the ISnapFieldOwner.FindListByName method.
3. Convert the document fields to Snap Fields. To do that, call the ISnapFieldOwner.ParseField method. Note that without performing this step, you won’t be able to modify the document.
4. Enable modifying the list by calling the SnapEntity.BeginUpdate method.
5. Create a new sorting parameter represented by the SnapListGroupParam instance. Pass the target field name and the desired sort order to the SnapListGroupParam object’s constructor method.
6. Add the created object to the corresponding list collection. To do that, access the collection through the SnapList.Sorting property and call the Add method.
7. Call the SnapEntity.EndUpdate method to finalize the list modification. Then, update the list fields by calling the FieldCollection.Update method.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/snap-document-server-api-t429162

DataShapingActions.vb

server.LoadDocumentTemplate("Template.snx")
Dim list As SnapList = server.Document.FindListByName("Data Source 11")
server.Document.ParseField(list.Field)
list.BeginUpdate()
list.Sorting.Add(New SnapListGroupParam("UnitPrice", ColumnSortOrder.Descending))
list.EndUpdate()
list.Field.Update()

DataShapingActions.cs

server.LoadDocumentTemplate("Template.snx");            
SnapList list = server.Document.FindListByName("Data Source 11");
server.Document.ParseField(list.Field);
list.BeginUpdate();
list.Sorting.Add(new SnapListGroupParam("UnitPrice", ColumnSortOrder.Descending));
list.EndUpdate();
list.Field.Update();