ctrlSetTooltip: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Most A3 controls now support tooltips.)
m (Text replacement - "<sqf>([^↵][^\/]*↵[^\/]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(78 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma |= Game name
|game1= arma1
|version1= 1.00


|1.00|= Game version
|game2= arma2
____________________________________________________________________________________________
|version2= 1.00


| Sets tooltip text of given control. |= Description
|game3= arma2oa
____________________________________________________________________________________________
|version3= 1.50


| control '''ctrlSetTooltip''' text |= Syntax
|game4= tkoh
|version4= 1.00


|p1= control: [[Control]] - Any [[Dialogs|control type]], (except for CT_STATIC & CT_STRUCTURED_TEXT, although Arma 3 now supports these too) |= Parameter 1
|game5= arma3
|version5= 0.50


|p2= text: [[String]] |= Parameter 2
|gr1= GUI Control


| [[Nothing]] |= Return value
|descr= Sets tooltip text of given control.
____________________________________________________________________________________________
{{Feature|informative|If control supports URL property, like {{hl|RscActiveText}} for example, and the URL is set, tooltip text displayed on mouse over will be appended with URL text.}}
 
|x1= <pre>_control ctrlSetTooltip "tooltip"</pre> |= Example 1
|x2= <code>(([[findDisplay]] 10000) [[displayCtrl]] 10001) '''ctrlSetTooltip''' "ThisIsAGoodTip"
</code> |= Example 2
____________________________________________________________________________________________


| |= See also
|s1= control [[ctrlSetTooltip]] text


|p1= control: [[Control]] - any [[Dialogs|control type]], (except for CT_STATIC & CT_STRUCTURED_TEXT, although Arma 3 now supports these too)
|p2= text: [[String]]
|r1= [[Nothing]]
|x1= <sqf>_control ctrlSetTooltip "tooltip";</sqf>
|x2= <sqf>findDisplay 10000 displayCtrl 10001 ctrlSetTooltip "ThisIsAGoodTip";</sqf>
|x3= <sqf>
with uiNamespace do
{
bar = findDisplay 46 createDisplay "RscDisplayEmpty" ctrlCreate ["RscProgress", -1];
bar ctrlSetPosition [0,0,1,0.01];
bar ctrlCommit 0;
bar progressSetPosition 0.75;
bar ctrlSetTooltip "lalalalalalalala";
};
</sqf>
|seealso= [[ctrlSetTooltipColorBox]] [[ctrlSetTooltipColorShade]] [[ctrlSetTooltipColorText]]
}}
}}


<h3 style="display:none">Notes</h3>
 
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
<dt></dt>
<dd class="notedate">Posted on 2017-09-26 - 08:08 (UTC)</dd>
<dt class="note">[[User:Demellion|Demellion]]</dt>
<dd class="note">
'''NOTE''': If you want to receive a multi-line tooltip, you can simply input newline escape symbol in your text:
<sqf>_ctrl ctrlSetTooltip "Your text\nYour text on next line";</sqf>
Localization files (stringtable.xml) also supports that.
</dd>
 
</dl>
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|CTRLSETTOOLTIP]]
[[Category:Scripting Commands ArmA|CTRLSETTOOLTIP]]
[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]

Latest revision as of 11:34, 3 September 2024

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

Description

Description:
Sets tooltip text of given control.
ⓘ
If control supports URL property, like RscActiveText for example, and the URL is set, tooltip text displayed on mouse over will be appended with URL text.
Groups:
GUI Control

Syntax

Syntax:
control ctrlSetTooltip text
Parameters:
control: Control - any control type, (except for CT_STATIC & CT_STRUCTURED_TEXT, although Arma 3 now supports these too)
text: String
Return Value:
Nothing

Examples

Example 1:
_control ctrlSetTooltip "tooltip";
Example 2:
findDisplay 10000 displayCtrl 10001 ctrlSetTooltip "ThisIsAGoodTip";
Example 3:
with uiNamespace do { bar = findDisplay 46 createDisplay "RscDisplayEmpty" ctrlCreate ["RscProgress", -1]; bar ctrlSetPosition [0,0,1,0.01]; bar ctrlCommit 0; bar progressSetPosition 0.75; bar ctrlSetTooltip "lalalalalalalala"; };

Additional Information

See also:
ctrlSetTooltipColorBox ctrlSetTooltipColorShade ctrlSetTooltipColorText

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


Posted on 2017-09-26 - 08:08 (UTC)
Demellion
NOTE: If you want to receive a multi-line tooltip, you can simply input newline escape symbol in your text:
_ctrl ctrlSetTooltip "Your text\nYour text on next line";
Localization files (stringtable.xml) also supports that.
Retrieved from "https://community.bistudio.com/wiki?title=ctrlSetTooltip&oldid=369134"