tvSortByValue: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (removed note as requested by Killzone_Kid)
(updated description)
Line 1: Line 1:
{{Command|Comments=
{{Command|Comments=
____________________________________________________________________________________________


| arma3 |Game name=
| arma3 |Game name=
Line 7: Line 6:


|gr1= GUI Control - Tree View |GROUP1=
|gr1= GUI Control - Tree View |GROUP1=
____________________________________________________________________________________________


| Sorts children of given item by [[tvValue]] from highest to lowest by default. IDC means id of parent Tree View.
| Sorts all children of given path. Value of [[CT_TREE|Tree View]] entries is used for sorting. |DESCRIPTION=
<br>|DESCRIPTION=
____________________________________________________________________________________________


| control [[tvSortByValue]] [path, reversed] |SYNTAX=
| control [[tvSortByValue]] [path, reversed] |SYNTAX=


| p1= control: [[Control]] |PARAMETER1=  
| p1= control: [[Control]] |PARAMETER1=  
| p2= [path, reversed]: [[Array]] |PARAMETER2=  
| p2= [path, reversed]: [[Array]] |PARAMETER2=  
| p3= path: [[Array]] - [[Tree View Path]] of the parent item to sort |PARAMETER3=  
| p3= path: [[Array]] - [[Tree View Path]] of the parent item to sort |PARAMETER3=  
| p4= reversed (Optional): [[Boolean]] - [[true]] to reverse sort it. Default: [[false]]  |PARAMETER4=  
| p4= reversed (Optional): [[Boolean]] - [[true]] to reverse sort it. Default: [[false]]  |PARAMETER4=  


Line 25: Line 24:


| p21= [idc, path, reversed]: [[Array]] |PARAMETER21=  
| p21= [idc, path, reversed]: [[Array]] |PARAMETER21=  
| p22= idc: [[Number]] - control idc |PARAMETER22=  
| p22= idc: [[Number]] - control idc |PARAMETER22=  
| p23= path: [[Array]] - [[Tree View Path]] of the parent item to sort |PARAMETER23=  
| p23= path: [[Array]] - [[Tree View Path]] of the parent item to sort |PARAMETER23=  
| p24= reversed (Optional): [[Boolean]] - [[true]] to reverse sort it. Default: [[false]]  |PARAMETER24=  
| p24= reversed (Optional): [[Boolean]] - [[true]] to reverse sort it. Default: [[false]]  |PARAMETER24=  


|r2= [[Nothing]] |RETURNVALUE2=
|r2= [[Nothing]] |RETURNVALUE2=


|x1= <code>control [[tvSortByValue]] [<nowiki/>[0], [[false]]];</code> |EXAMPLE1=


|x1= <code>control [[tvSortByValue]] [<nowiki/>[0], [[false]]];</code> |EXAMPLE1=
|x2= <code>[[tvSortByValue]] [102, [0], [[false]]];</code> |EXAMPLE2=
|x2= <code>[[tvSortByValue]] [102, [0], [[false]]];</code> |EXAMPLE2=
____________________________________________________________________________________________


| [[tvSortAll]] [[tvSort]] [[tvSortByValueAll]]|SEEALSO=
| [[tvSortAll]] [[tvSort]] [[tvSortByValueAll]]|SEEALSO=
|  |MPBEHAVIOUR=
____________________________________________________________________________________________
}}
}}



Revision as of 17:21, 3 December 2020

Hover & click on the images for description

Description

Description:
Sorts all children of given path. Value of Tree View entries is used for sorting.
Groups:
GUI Control - Tree View

Syntax

Syntax:
control tvSortByValue [path, reversed]
Parameters:
control: Control
[path, reversed]: Array
path: Array - Tree View Path of the parent item to sort
reversed (Optional): Boolean - true to reverse sort it. Default: false
Return Value:
Nothing

Alternative Syntax

Syntax:
tvSortByValue [idc, path, reversed]
Parameters:
[idc, path, reversed]: Array
idc: Number - control idc
path: Array - Tree View Path of the parent item to sort
reversed (Optional): Boolean - true to reverse sort it. Default: false
Return Value:
Nothing

Examples

Example 1:
control tvSortByValue [[0], false];
Example 2:
tvSortByValue [102, [0], false];

Additional Information

See also:
tvSortAll tvSort tvSortByValueAll

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

Notes

Bottom Section