tvSortByValue: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (<code> and Desc. tidy)
mNo edit summary
 
(54 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 0.74


|0.74|= Game version
|gr1= GUI Control - Tree View
____________________________________________________________________________________________


| Sorts childrens of given item by value. IDC means id of parent Tree View.
|descr= Sorts all children of given path. Value of [[CT_TREE|Tree View]] entries is used for sorting. [[tvSetValue]] can be used to set the value for a given path.
<br>
Param ''reversed'' is optional. |= Description
____________________________________________________________________________________________


| '''tvSortByValue''' [idc, [path], reversed] |= Syntax
|s1= control [[tvSortByValue]] [path, ascending]


|p1= [idc, [path], reversed]: [[Array]] |= PARAMETER1
|p1= control: [[Control]]


|p2= idc: [[Number]] |= PARAMETER2
|p2= path: [[Array]] - [[Tree View Path]] of the parent item to sort


|p3= [path]: [[Array]] - Array containing numbers. |= PARAMETER3
|p3= ascending: [[Boolean]] - (Optional, default [[false]]) [[true]] to sort ascending, else descending


|p4= reversed: [[Boolean]] - optional |= PARAMETER4
|r1= [[Nothing]]


| [[Nothing]] |= RETURNVALUE
|s2= [[tvSortByValue]] [idc, path, ascending]


|p21= idc: [[Number]] - control idc


|x1= <code>[[tvSortByValue]] [101, [0], [[false]]<nowiki>]</nowiki>;</code> |= Example 1
|p22= path: [[Array]] - [[Tree View Path]] of the parent item to sort
____________________________________________________________________________________________


| [[tvAdd]], [[tvClear]], [[tvCollapse]], [[tvCount]], [[tvCurSel]], [[tvData]], [[tvDelete]], [[tvExpand]], [[tvPicture]], [[tvSetCurSel]], [[tvSetData]], [[tvSetPicture]], [[tvSetValue]], [[tvSort]], [[tvText]], [[tvValue]] |= See Also
|p23= ascending: [[Boolean]] - (Optional) [[true]] to sort ascending, else descending. Default: [[false]]


| |= MPBEHAVIOUR
|r2= [[Nothing]]
____________________________________________________________________________________________
}}


<h3 style='display:none'>Notes</h3>
|x1= <sqf>control tvSortByValue [[0], false];</sqf>
<dl class='command_description'>
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x2= <sqf>tvSortByValue [102, [0], false];</sqf>
</dl>


<h3 style='display:none'>Bottom Section</h3>
|seealso= [[lbSortBy]] [[lnbSortBy]] [[tvSortAll]] [[tvSort]] [[tvSortByValueAll]]
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
}}
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 20:55, 28 September 2023

Arma 3 logo black.png0.74
Hover & click on the images for description

Description

Description:
Sorts all children of given path. Value of Tree View entries is used for sorting. tvSetValue can be used to set the value for a given path.
Groups:
GUI Control - Tree View

Syntax

Syntax:
control tvSortByValue [path, ascending]
Parameters:
control: Control
path: Array - Tree View Path of the parent item to sort
ascending: Boolean - (Optional, default false) true to sort ascending, else descending
Return Value:
Nothing

Alternative Syntax

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

Examples

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

Additional Information

See also:
lbSortBy lnbSortBy 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
Retrieved from "https://community.bistudio.com/wiki?title=tvSortByValue&oldid=347588"