tvSortByValue: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Game version" to "|Game version=")
mNo edit summary
 
(37 intermediate revisions by 4 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 children of given item by [[tvValue]] from highest to lowest by default. 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>|DESCRIPTION=
____________________________________________________________________________________________


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


| p1= control: [[Control]] |PARAMETER1=
|p1= control: [[Control]]


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


| [[Nothing]] |RETURNVALUE=
|p3= ascending: [[Boolean]] - (Optional, default [[false]]) [[true]] to sort ascending, else descending


|s2 =[[tvSortByValue]] [idc, path, reversed] |SYNTAX=
|r1= [[Nothing]]


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


|r2= [[Nothing]] |RETURNVALUE=
|p21= idc: [[Number]] - control idc


|p22= path: [[Array]] - [[Tree View Path]] of the parent item to sort


|x1= <code>control [[tvSortByValue]] <nowiki>[</nowiki>[0], [[false]]];</code> |EXAMPLE1=
|p23= ascending: [[Boolean]] - (Optional) [[true]] to sort ascending, else descending. Default: [[false]]
|x2= <code>[[tvSortByValue]] [102, [0], [[false]]];</code> |EXAMPLE1=
____________________________________________________________________________________________


| [[lbSort]], [[lnbSort]], [[tvSort]], [[lbSortByValue]], [[lnbSortByValue]], [[tvAdd]], [[tvClear]], [[tvCollapse]], [[tvCount]], [[tvCurSel]], [[tvData]], [[tvDelete]], [[tvExpand]], [[tvPicture]], [[tvSetCurSel]], [[tvSetData]], [[tvSetPicture]], [[tvSetValue]], [[tvText]], [[tvValue]] |SEEALSO=
|r2= [[Nothing]]


| |MPBEHAVIOUR=  
|x1= <sqf>control tvSortByValue [[0], false];</sqf>
____________________________________________________________________________________________
}}


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


<!-- Note Section END -->
|seealso= [[lbSortBy]] [[lnbSortBy]] [[tvSortAll]] [[tvSort]] [[tvSortByValueAll]]
</dl>
}}
 
<h3 style='display:none'>Bottom Section</h3>
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]
 
<!-- CONTINUE Notes -->
 
<!-- DISCONTINUE Notes -->
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on August 2, 2019 - 17:38 (UTC)</dd>
<dt class="note">[[User:killzone_kid|killzone_kid]]</dt>
<dd class="note">Prior to Arma 3 v1.95.145935 Optional param ''reversed'' wasn't optional (Delete this note on or after v1.96)
</dd>
</dl>
<!-- DISCONTINUE Notes -->

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"