Difference between revisions of "lnbSortBy"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
Line 13: Line 13:
 
{{Feature|Important|This command supports referencing control via IDC as well, but as with any use of IDC in UI [[Control]] commands, a [[dialog]] should be present, i.e. UI user interaction is created with [[createDialog]] rather than [[createDisplay]]}}
 
{{Feature|Important|This command supports referencing control via IDC as well, but as with any use of IDC in UI [[Control]] commands, a [[dialog]] should be present, i.e. UI user interaction is created with [[createDialog]] rather than [[createDisplay]]}}
  
|s1= [controlOrIDC, column] [[lnbSortBy]] [sortByType, reversedOrder, caseSensitive]
+
|s1= [controlOrIDC, column] [[lnbSortBy]] [sortByType, reversedOrder, caseSensitive, useTextRight]
  
|p1= controlOrIDC: [[Control]] or [[Number]] - the ListNBox control or its IDC
+
|p1= [controlOrIDC, column]: [[Array]]
  
|p2=  column: [[Number]] - column to sort (starts with 0)
+
|p2=  controlOrIDC: [[Control]] or [[Number]] - the ListNBox control or its IDC
  
|p3= sortByType: [[String]] - (Optional, default "TEXT") one of:
+
|p3=  column: [[Number]] - column to sort (starts with 0)
 +
 
 +
|p4= [sortByType, reversedOrder, caseSensitive, useTextRight]: [[Array]]
 +
 
 +
|p5= sortByType: [[String]] - (Optional, default "TEXT") one of:
 
* <tt>"TEXT"</tt>
 
* <tt>"TEXT"</tt>
 
* <tt>"VALUE"</tt>
 
* <tt>"VALUE"</tt>
 
* <tt>"DATA"</tt>
 
* <tt>"DATA"</tt>
  
|p4= reversedOrder: [[Boolean]] - (Optional, default [[false]]) [[true]] for sorting in reversed order
+
|p6= reversedOrder: [[Boolean]] - (Optional, default [[false]]) [[true]] for sorting in reversed order
 +
 
 +
|p7= caseSensitive: [[Boolean]] - (Optional, default [[false]]) [[true]] for using case-sensitive comparison
  
|p5= caseSensitive: [[Boolean]] - (Optional, default [[false]]) [[true]] for using case-sensitive comparison
+
|p8= useTextRight: [[Boolean]] - (Optional, default [[false]]) [[true]] to sort by [[lnbSetTextRight | text right]]
  
 
|r1= [[Nothing]]
 
|r1= [[Nothing]]

Revision as of 12:31, 11 June 2021

Hover & click on the images for description
Only available in Development branch(es) until its release with Arma 3 patch v2.06.

Description

Description:
Sorts given multi-column ListNBox in the given column by either lnbText, lnbValue or lnbData in normal or reversed order, using case-sensitive or case-insensitive comparison. Unlike the older lnbSortXXX commands, this command supports Unicode characters out of the box.
When sorting by "VALUE", the rows with the same lnbValue will additionally be sorted by lnbText in the order specified by the reversedOrder flag.
This command supports referencing control via IDC as well, but as with any use of IDC in UI Control commands, a dialog should be present, i.e. UI user interaction is created with createDialog rather than createDisplay
Groups:
GUI Control - ListNBox

Syntax

Syntax:
[controlOrIDC, column] lnbSortBy [sortByType, reversedOrder, caseSensitive, useTextRight]
Parameters:
[controlOrIDC, column]: Array
controlOrIDC: Control or Number - the ListNBox control or its IDC
column: Number - column to sort (starts with 0)
[sortByType, reversedOrder, caseSensitive, useTextRight]: Array
sortByType: String - (Optional, default "TEXT") one of:
  • "TEXT"
  • "VALUE"
  • "DATA"
reversedOrder: Boolean - (Optional, default false) true for sorting in reversed order
caseSensitive: Boolean - (Optional, default false) true for using case-sensitive comparison
useTextRight: Boolean - (Optional, default false) true to sort by text right
Return Value:
Nothing

Examples

Example 1:
with uiNamespace do { private _column = 1; private _lnb = findDisplay 46 createDisplay "RscDisplayEmpty" ctrlCreate ["RscListNBox", -1]; _lnb ctrlSetPosition [0,0,1,1]; _lnb ctrlCommit 0; lnbClear _lnb; { _lnb lnbAddRow [format ["Row %1", _forEachIndex], _x select 0]; _lnb lnbSetValue [[_forEachIndex, _column], _x select 1]; } forEach [["В",1], ["Я",0], ["Б",1], ["Ю",0], ["А",1]]; [_lnb, _column] lnbSortBy ["VALUE", true, false]; };

Additional Information

See also:
lbSortBylnbSortlnbSortByValuelbSortlbSortByValuetvSorttvSortByValuesort

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note