ctrlClassName: 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)
 
(47 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.26


|1.26|Game version=
|gr1= GUI Control


|gr1= GUI Control |GROUP1=
|descr= Returns the class name of a [[Control]] as it is defined in config. If you need config class of a game created [[Display]], it is stored on display itself:
<sqf>_className = findDisplay 12 getVariable ["BIS_fnc_initDisplay_configClass", ""]; // "RscDiary"</sqf>


|s1= [[ctrlClassName]] control


|p1= control : [[Control]]


|gr1= GUI Control |=GROUP1
|r1= [[String]] - class name
____________________________________________________________________________________________


| Returns the class name of a [[Control]] as it is defined in config. If you need config class of a game created [[Display]], it is stored on display itself:
|x1= List class names of all controls present on display 46:
<code>_className <nowiki>=</nowiki> [[findDisplay]] 12 [[getVariable]] ["BIS_fnc_initDisplay_configClass", ""]; // "RscDiary"</code> |DESCRIPTION=
<sqf>
____________________________________________________________________________________________
_return = [];
 
| '''ctrlClassName''' control |SYNTAX=
 
|p1= control : [[Control]]  |PARAMETER1=
 
| [[String]] - class name|RETURNVALUE=
 
 
|x1= List class names of all controls present on display 46:<code>_return = [] ;
{
{
_return [[pushBack]] [[format]] ["IDC: %1, className: %2", [[ctrlIDC]] _x, [[ctrlClassName]] _x];
_return pushBack format ["IDC: %1, className: %2", ctrlIDC _x, ctrlClassName _x];
} [[forEach]] ([[allControls]] ([[findDisplay]] 46));
} forEach (allControls findDisplay 46);
[[copyToClipboard]] (_return [[joinString]] [[endl]]);</code>|EXAMPLE1=
____________________________________________________________________________________________


| [[ctrlIDC]], [[ctrlIDD]], [[ctrlType]], [[ctrlCreate]], [[ctrlDelete]], [[ctrlModel]], [[ctrlSetModel]], [[ctrlPosition]], [[ctrlSetPosition]], [[ctrlModelScale]], [[ctrlSetModelScale]], [[ctrlModelDirAndUp]], [[ctrlSetModelDirAndUp]]  |SEEALSO=
copyToClipboard (_return joinString endl);
</sqf>


| |MPBEHAVIOUR=  
|seealso= [[ctrlIDC]] [[ctrlIDD]] [[ctrlType]] [[ctrlCreate]] [[ctrlDelete]] [[ctrlModel]] [[ctrlSetModel]] [[ctrlPosition]] [[ctrlSetPosition]] [[ctrlModelScale]] [[ctrlSetModelScale]] [[ctrlModelDirAndUp]] [[ctrlSetModelDirAndUp]]
____________________________________________________________________________________________
}}
}}
<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: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}}}}]]

Latest revision as of 12:30, 13 May 2022

Hover & click on the images for description

Description

Description:
Returns the class name of a Control as it is defined in config. If you need config class of a game created Display, it is stored on display itself:
_className = findDisplay 12 getVariable ["BIS_fnc_initDisplay_configClass", ""]; // "RscDiary"
Groups:
GUI Control

Syntax

Syntax:
ctrlClassName control
Parameters:
control : Control
Return Value:
String - class name

Examples

Example 1:
List class names of all controls present on display 46:
_return = []; { _return pushBack format ["IDC: %1, className: %2", ctrlIDC _x, ctrlClassName _x]; } forEach (allControls findDisplay 46); copyToClipboard (_return joinString endl);

Additional Information

See also:
ctrlIDC ctrlIDD ctrlType ctrlCreate ctrlDelete ctrlModel ctrlSetModel ctrlPosition ctrlSetPosition ctrlModelScale ctrlSetModelScale ctrlModelDirAndUp ctrlSetModelDirAndUp

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