ctrlSetChecked: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|Game version=" to "|Game version= |gr1= GUI Control |GROUP1= ")
m (Some wiki formatting)
 
(31 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 0.50


|0.50|Game version=
|gr1= GUI Control


|gr1= GUI Control |GROUP1=
|descr= Sets checked state of a [[CT_CHECKBOXES]] control.


|s1= control [[ctrlSetChecked]] checked


|p1= control: [[Control]] - [[CT_CHECKBOXES]] control. If control contain multiple checkboxes, only checkbox with index 0 is queried.


|gr1= GUI Control |=GROUP1
|p2= checked: [[Boolean]] - [[true]] to check, [[false]] to uncheck the checkbox
____________________________________________________________________________________________


| Sets checked state of a checkbox in checkboxes control (CT_CHECKBOXES type 7 of [[Arma: GUI Configuration]]). Since Arma 3 v1.71.141591 it is possible to check checkbox with given index in multiple checkboxes set-up. For more information see [[DialogControls-CheckBoxes]].|DESCRIPTION=
|r1= [[Nothing]]
____________________________________________________________________________________________


| control '''ctrlSetChecked''' checked |SYNTAX=
|s2= control [[ctrlSetChecked]] [index, checked]


|p1= control: [[Control]] - CT_CHECKBOXES control. If control contain multiple checkboxes, only checkbox with index 0 is queried. |PARAMETER1=
|s2since= arma3 1.72


|p2= checked: [[Boolean]] - [[true]] to check, [[false]] to uncheck the checkbox  |PARAMETER2=
|p21= control: [[Control]] - [[CT_CHECKBOXES]] control


| [[Nothing]] |RETURNVALUE=
|p22= index: [[Number]] - checkbox index


| s2=control '''ctrlSetChecked''' [index, checked]        (''Since Arma 3 v1.71.141591'')|SYNTAX2=
|p23= checked: [[Boolean]] - [[true]] to check, [[false]] to uncheck the checkbox


|p21= control: [[Control]] - CT_CHECKBOXES control |PARAMETER21=
|r2=[[Nothing]]


|p22=  [index, checked]: [[Array]]  |PARAMETER22=
|x1= <sqf>_control ctrlSetChecked true;</sqf>


|p23= index: [[Number]] - checkbox index  |PARAMETER1=
|x2= <sqf>_control ctrlSetChecked [3, true];</sqf>


|p24= checked: [[Boolean]]- [[true]] to check, [[false]] to uncheck the checkbox  |PARAMETER2= 
|seealso= [[ctrlChecked]] [[cbChecked]] [[cbSetChecked]]
 
| r2=[[Nothing]] |RETURNVALUE=
 
|x1= <code>_control [[ctrlSetChecked]] [[true]];</code>|EXAMPLE1=
|x2= <code>_control [[ctrlSetChecked]] [3, [[true]]];</code>|EXAMPLE1=
 
____________________________________________________________________________________________
 
| [[ctrlChecked]], [[cbChecked]], [[cbSetChecked]] |SEEALSO=
 
|  |MPBEHAVIOUR=
____________________________________________________________________________________________
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Arma 3: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]

Latest revision as of 22:37, 4 September 2022

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

Description

Description:
Sets checked state of a CT_CHECKBOXES control.
Groups:
GUI Control

Syntax

Syntax:
control ctrlSetChecked checked
Parameters:
control: Control - CT_CHECKBOXES control. If control contain multiple checkboxes, only checkbox with index 0 is queried.
checked: Boolean - true to check, false to uncheck the checkbox
Return Value:
Nothing

Alternative Syntax

Syntax:
control ctrlSetChecked [index, checked]
Parameters:
control: Control - CT_CHECKBOXES control
index: Number - checkbox index
checked: Boolean - true to check, false to uncheck the checkbox
Return Value:
Nothing

Examples

Example 1:
_control ctrlSetChecked true;
Example 2:
_control ctrlSetChecked [3, true];

Additional Information

See also:
ctrlChecked cbChecked cbSetChecked

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=ctrlSetChecked&oldid=330383"