tvSortByValue: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (formatted notes)
mNo edit summary
 
(46 intermediate revisions by 5 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


|arg= local |= Arguments in MP
|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.


|eff= local |= Effects in MP
|s1= control [[tvSortByValue]] [path, ascending]
____________________________________________________________________________________________


| Sorts children of given item by value from highest to lowest. IDC means id of parent Tree View.
|p1= control: [[Control]]
<br>|= Description
____________________________________________________________________________________________


| _ctrl [[tvSortByValue]] [ [path], reversed] |= Syntax
|p2= path: [[Array]] - [[Tree View Path]] of the parent item to sort


|p1= _ctrl: [[Control]] |= PARAMETER1
|p3= ascending: [[Boolean]] - (Optional, default [[false]]) [[true]] to sort ascending, else descending


|p2= [ [path], reversed]: [[Array]] |= PARAMETER2
|r1= [[Nothing]]


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


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


|x1= <code>_ctrl [[tvSortByValue]] [ [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 -->


<dd class="notedate">Posted on Sep 11 2014</dd>
|x2= <sqf>tvSortByValue [102, [0], false];</sqf>
<dt class="note">[[User:ffur2007slx2_5|ffur2007slx2_5]]</dt>
<dd class="note">(A3 1.28)tv command family overview
<code>
//tv command family available for CT_TREE (type 12)
[[private]] ["_count","_current","_data","_text","_value","_pic"];
_CT_TREE [[tvAdd]] [ [],"Parent_A"];
_CT_TREE [[tvAdd]] [ [0],"Child_A"];
_CT_TREE [[tvAdd]] [ [0,0],"Grandchild_A"];
_CT_TREE [[tvAdd]] [ [],"Parent_B"];
_CT_TREE [[tvAdd]] [ [1],"Child_B"];
[[file:WuChaoRen_CTTree001.png]]
_count = _CT_TREE [[tvCount]] []; //return 2
_CT_TREE [[tvSetCurSel]] [0,0,0]; //select grandchild_A
[[file:WuChaoRen_CTTree003.png]]
_current = [[tvCurSel]] _CT_TREE; //return [0,0,0]
_CT_TREE [[tvSetData]] [_current,"I'm grandchild_A"];
_data = _CT_TREE [[tvData]] _current; // "I'm grandchild_A"
_text = _CT_TREE [[tvText]] _current; //"Grandchild_A"
_CT_TREE [[tvSetValue]] [_current,14];
_value = _CT_TREE [[tvValue]] _current; // 14
_CT_TREE [[tvSetPicture]] [_current,[[getText]] ([[configFile]] >> "CfgWeapons" >> "optic_NVS" >> "picture")];
_pic = _CT_TREE [[tvPicture]] _current;
[[file:WuChaoRen_CTTree004.png]]
_CT_TREE [[tvExpand]] [1];
[[file:WuChaoRen_CTTree005.png]]
_CT_TREE [[tvSort]] [[],[[false]] ];
_CT_TREE [[tvSortByValue]] [[],[[false]] ];
[[file:WuChaoRen_CTTree006.png]]
_CT_TREE [[tvDelete]] [0,0]; //remove child_b
[[tvClear]] 12;
_CT_TREE [[tvCollapse]] [];
[[file:WuChaoRen_CTTree002.png]]
</code>


<!-- 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 -->
<dl class="command_description">
<dd class="notedate">Posted on May 24, 2015 - 22:02 (UTC)</dd>
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
<dd class="note">
Seems to only affect sorting of parent tree (path [])
</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"