DataSorter class

DataSorter class

Summary description for DataSorter.

The DataSorter type exposes the following members:

Properties

Property	Description
keys	Gets the key list of data sorter.
has_headers	Represents whether the range has headers.
key1	Represents first sorted column index(absolute position, column A is 0, B is 1, …).
order1	Represents sort order of the first key.
key2	Represents second sorted column index(absolute position, column A is 0, B is 1, …).
order2	Represents sort order of the second key.
key3	Represents third sorted column index(absolute position, column A is 0, B is 1, …).
order3	Represents sort order of the third key.
sort_left_to_right	True means that sorting orientation is from left to right. False means that sorting orientation is from top to bottom. The default value is false.
case_sensitive	Gets and sets whether case sensitive when comparing string.
sort_as_number	Indicates whether sorting anything that looks like a number.

Methods

Method	Description
add_key(self, key, order)	Adds sorted column index and sort order.
add_key(self, key, order, custom_list)	Adds sorted column index and sort order with custom sort list.
add_key(self, key, type, order, custom_list)	Adds sorted column index and sort order with custom sort list.
add_key(self, key, order, custom_list)	Adds sorted column index and sort order with custom sort list.
sort(self, cells, start_row, start_column, end_row, end_column)	Sorts the data of the area.
sort(self, cells, area)	Sort the data of the area.
sort(self)	Sort the data in the range.
clear(self)	Clear all settings.
add_color_key(self, key, type, order, color)	Adds color sort key.

Example

from aspose.cells import CellArea, SortOrder, Workbook

# Instantiate a new Workbook object.
workbook = Workbook("Book1.xls")
# Get the workbook datasorter object.
sorter = workbook.data_sorter
# Set the first order for datasorter object.
sorter.order1 = SortOrder.DESCENDING
# Define the first key.
sorter.key1 = 0
# Set the second order for datasorter object.
sorter.order2 = SortOrder.ASCENDING
# Define the second key.
sorter.key2 = 1
# Create a cells area (range).
ca = CellArea()
# Specify the start row index.
ca.start_row = 0
# Specify the start column index.
ca.start_column = 0
# Specify the last row index.
ca.end_row = 13
# Specify the last column index.
ca.end_column = 1
# Sort data in the specified data range (A1:B14)
sorter.sort(workbook.worksheets[0].cells, ca)
# Save the excel file.
workbook.save("outBook.xls")

See Also

• module aspose.cells