Difference between revisions of "lbSortBy"

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 [[lbSortBy]] [sortByType, reversedOrder, caseSensitive]
+
|s1= controlOrIDC [[lbSortBy]] [sortByType, reversedOrder, caseSensitive, useTextRight]
  
 
|p1=  controlOrIDC: [[Control]] or [[Number]] - the ListBox control or its IDC
 
|p1=  controlOrIDC: [[Control]] or [[Number]] - the ListBox control or its IDC
  
|p2= sortByType: [[String]] -  (Optional, default "TEXT") one of:
+
|p2= [sortByType, reversedOrder, caseSensitive, useTextRight]: [[Array]]
 +
 
 +
|p3= 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>
  
|p3= reversedOrder: [[Boolean]] - (Optional, default [[false]]) [[true]] for sorting in reversed order
+
|p4= reversedOrder: [[Boolean]] - (Optional, default [[false]]) [[true]] for sorting in reversed order
 +
 
 +
|p5= caseSensitive: [[Boolean]] - (Optional, default [[false]]) [[true]] for using case-sensitive comparison
  
|p4= caseSensitive: [[Boolean]] - (Optional, default [[false]]) [[true]] for using case-sensitive comparison
+
|p6= useTextRight: [[Boolean]] - (Optional, default [[false]]) [[true]] to sort by [[lbSetTextRight | text right]]
  
 
|r1= [[Nothing]]
 
|r1= [[Nothing]]

Revision as of 12:28, 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 ListBox by either lbText, lbValue or lbData in normal or reversed order, using case-sensitive or case-insensitive comparison. This command supports Unicode characters. When sorting by "VALUE", the rows with the same lbValue will additionally be sorted by lbText in the order specified by `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 - ListBox

Syntax

Syntax:
controlOrIDC lbSortBy [sortByType, reversedOrder, caseSensitive, useTextRight]
Parameters:
controlOrIDC: Control or Number - the ListBox control or its IDC
[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 _lb = findDisplay 46 createDisplay "RscDisplayEmpty" ctrlCreate ["RscListBox", -1]; _lb ctrlSetPosition [0,0,1,1]; _lb ctrlCommit 0; lbClear _lb; { _lb lbAdd (_x select 0); _lb lbSetValue [_forEachIndex, _x select 1]; } forEach [["В",1], ["Я",0], ["Б",1], ["Ю",0], ["А",1]]; _lb lbSortBy ["VALUE", false, false]; };

Additional Information

See also:
lnbSortBylnbSortlnbSortByValuelbSortlbSortByValuetvSorttvSortByValuesort

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