ctrlSetTooltip: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "<sqf>([^↵][^\/]*↵[^\/]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(90 intermediate revisions by 12 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|CTRLSETTOOLTIP]]
{{RV|type=command
[[Category:Scripting Commands ArmA|CTRLSETTOOLTIP]]


|game1= arma1
|version1= 1.00


<h2 style="color:#000066">'''''display'' ctrlSetTooltip ''text'''''</h2>
|game2= arma2
|version2= 1.00


|game3= arma2oa
|version3= 1.50


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


'''display''': [[Control]]
|game5= arma3
   
|version5= 0.50
'''text''': [[String]]


'''Type of returned value:'''
|gr1= GUI Control


[[Nothing]]
|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.}}


'''Compatibility:'''
|s1= control [[ctrlSetTooltip]] text


Version 2.92 required.
|p1= control: [[Control]] - any [[Dialogs|control type]], (except for CT_STATIC & CT_STRUCTURED_TEXT, although Arma 3 now supports these too)


'''Description:'''
|p2= text: [[String]]


Sets tooltip text of given control.
|r1= [[Nothing]]


|x1= <sqf>_control ctrlSetTooltip "tooltip";</sqf>
|x2= <sqf>findDisplay 10000 displayCtrl 10001 ctrlSetTooltip "ThisIsAGoodTip";</sqf>


'''Example''':
|x3= <sqf>
   
with uiNamespace do
_control '''ctrlSetTooltip''' "tooltip"
{
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]]
}}
 
 
<dl class="command_description">
 
<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>

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"