ctrlEnable: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "(\|[pr][0-9]+ *= *[^-]+) *- *C([a-eg-z])" to "$1 - c$2")
(79 intermediate revisions by 12 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|C]]
{{RV|type=command
[[Category:Scripting Commands OFP 1.97|C]]
[[Category:Scripting Commands ArmA|C]]


|game1= ofp
|version1= 1.75


<h2 style="color:#000066"> '''ctrlEnable [''idc'', ''enable'']'''</h2>
|game2= ofpe
|version2= 1.00


|game3= arma1
|version3= 1.00


'''Operand types:'''
|game4= arma2
|version4= 1.00


'''[idc, enable]:''' [[Array]]
|game5= arma2oa
|version5= 1.50


'''Type of returned value:'''
|game6= tkoh
|version6= 1.00


[[Nothing]]
|game7= arma3
|version7= 0.50


'''Compatibility:'''
|arg= local


Added in version '''1.50'''
|eff= local


'''Description:'''
|gr1= GUI Control


'''Enable / disable''' control with id '''idc''' of topmost user [[dialog]].
|descr= Enables or disables a control of the currently active user dialog.
Disabled controls cannot be clicked onto.
Read [[Arma: GUI Configuration]] for more information about user dialogs and controls.


|s1= [[ctrlEnable]]  [idc, enable]


'''Example:'''
|p1= idc: [[Number]] - control IDC


'''ctrlEnable''' [100, [[false]]]
|p2= enable: [[Boolean]] - [[true]] to enable the control, [[false]] to disable it
 
|r1= [[Nothing]]
 
|s2= controlName [[ctrlEnable]] enable
 
|p21= controlName: [[Control]]
 
|p22= enable: [[Boolean]]
 
|r2= [[Nothing]]
 
|x1= <sqf>ctrlEnable [100, false];</sqf>
 
|x2= <sqf>_ctrl ctrlEnable false;</sqf>
 
|seealso= [[ctrlEnabled]]
}}
 
{{Note
|user= Yuval
|timestamp= 20170720115900
|text= Please do note that enabled controls can gain focus upon click. Therefore do not enable background controls or else they will cover any controls on top of them.<br>
As a general rule of thumb, enabled controls should only be already on the top of the GUI.
}}
 
{{Note
|user= R3vo
|timestamp= 20200907222600
|text= One can disable a control when it is loaded by using [[ctrlEnable]] in the [[User_Interface_Event_Handlers#onLoad|onLoad]] event handler.
<syntaxhighlight lang="cpp">
class MyDialog
{
class MyControl
{
onLoad = "(_this # 0) ctrlEnable false;";
};
};
</syntaxhighlight>
}}

Revision as of 14:59, 8 November 2023

Logo A0.png1.75ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
LALocalLELocal
Hover & click on the images for description

Description

Description:
Enables or disables a control of the currently active user dialog. Disabled controls cannot be clicked onto. Read Arma: GUI Configuration for more information about user dialogs and controls.
Groups:
GUI Control

Syntax

Syntax:
ctrlEnable [idc, enable]
Parameters:
idc: Number - control IDC
enable: Boolean - true to enable the control, false to disable it
Return Value:
Nothing

Alternative Syntax

Syntax:
controlName ctrlEnable enable
Parameters:
controlName: Control
enable: Boolean
Return Value:
Nothing

Examples

Example 1:
ctrlEnable [100, false];
Example 2:
_ctrl ctrlEnable false;

Additional Information

See also:
ctrlEnabled

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
Yuval - c
Posted on Jul 20, 2017 - 11:59 (UTC)
Please do note that enabled controls can gain focus upon click. Therefore do not enable background controls or else they will cover any controls on top of them.
As a general rule of thumb, enabled controls should only be already on the top of the GUI.
R3vo - c
Posted on Sep 07, 2020 - 22:26 (UTC)
One can disable a control when it is loaded by using ctrlEnable in the onLoad event handler. 
class MyDialog
{
	class MyControl
	{
		onLoad = "(_this # 0) ctrlEnable false;";
	};
};
Retrieved from "https://community.bistudio.com/wiki?title=ctrlEnable&oldid=348374"