Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • value1 = first field value to compare.
  • value2 = second field value to compare.
  • fieldName =name of the field that the grid is sorted by. (Available in Version 5, Fix Pack 6.0 and later)
  • isDescending =true if sorting in descending sequence, false otherwise. (Available in Version 5, Fix Pack 6.0 and later
  • fieldDateFormat = date format of the field that the grid is sorted by, if the field is not a date null will be passed instead. (Available in Version 5, Fix Pack 14.0 and later)
  • fieldInfo= formatting information of the field that the grid is sorted by; if the field does not contain any formatting information, a blank object will be passed instead. (Available in Version 6 and later) 
    • Some of the properties in the field info are:
      • dataType - the field data type
      • dataLength - data length (only present if the field is a character or a numeric field)
      • formatting - field formatting
  • multiFields= When a multiple-column sort runs, this is an array of information about each column included in the sort. The first preferred sort column is the first entry in the array; the second preferred column is second; etc. This argument is undefined when the sort is for a single column.
    • Properties of each object are the same as described above:
      • fieldName
      • fieldFormat
      • fieldDateFormat
      • value1
      • value2

Example:

Code Block
pui.gridSort = function(value1, value2, fieldName, isDescending, fieldDateFormat, fieldInfo) {
 if (value1 > value2) return -1;
 else return 1;
}

...