SortFilter

<< Click to Display Table of Contents >>

Manual > Control Reference > Basics > Grid control > Methods >

SortFilter


 

Set the sort filter.

 


syntax

SortFilter(

         type,

         targetField

         [, sortType = "sort2state"]

         [, bAdd = FALSE]

         )

 


Parameters

 

type


Type:

character


Filter Types

"col" - for column filters

"row" - for row filters

 

targetField


Type:

Numeric Array


An array of field (row for col, column for row) indexes. If omitted, searches all matrix properties for which EnabledSearchFilter is TRUE.

 

sortType


Type:

character


Sort type. Array specification is possible. Specify an array if you want to specify a different sort type for each field.

"ASCENDING" - Ascending

"DESCENDING" - descending

"SORT2STATE" - Repeat ascending and descending order

"SORT3STATE" - Repeat ascending, descending, clearing

"NONE" - Cancel

 

bAdd


Type:

Boolean


TRUE - The currently configured sort filter remains active.

FALSE - Clears any currently set sort filters

 

Return Value



Type:

Boolean


FALSE - Failure. TRUE - Success.

 


hmtoggle_plus1Explanation

 


reference