ctrlAutoScrollRewind: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "<code>_([a-zA-Z0-9_]+) = \[\[([a-zA-Z0-9]+)\]\] _([a-zA-Z0-9_]+);?<\/code>" to "<sqf>_$1 = $2 _$3;</sqf>")
 
(32 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma2 |Game name=
|game1= arma2
|version1= 1.00


|1.00|Game version=
|game2= arma2oa
|version2= 1.50


|gr1= GUI Control |GROUP1=
|game3= tkoh
|version3= 1.00


|gr2= GUI Control - ListBox |GROUP2=
|game4= arma3
|version4= 0.50


|gr3= GUI Control - ListNBox  |GROUP3=
|gr1= GUI Control
____________________________________________________________________________________________


| Returns [[true]] if auto-scroll should move back to start after it reaches the end.
|gr2= GUI Control - ListBox
<br><br>
Autorscroll is available for [[DialogControls-ListBoxes|CT_LISTBOX]] and [[DialogControls-ControlsGroup|CT_CONTROLS_GROUP]] types of controls only. Autoscroll will wait [[ctrlAutoScrollDelay]] seconds (must be  > 0) and then will scroll the scroll bar down to the bottom. [[ctrlAutoScrollSpeed]] defines the speed with which scrollbar is scrolled. If [[ctrlAutoScrollRewind]] is [[true]], the control will fade out, immediately rewind to the top, then fade in, wait [[ctrlAutoScrollDelay]] seconds and then repeat the scrolling in a loop. If user focuses on the control, autoscrolling is interrupted. |DESCRIPTION=
____________________________________________________________________________________________


| '''ctrlAutoScrollRewind''' control |SYNTAX=
|gr3= GUI Control - ListNBox


|p1= control: [[Control]] - [[DialogControls-ListBoxes|CT_LISTBOX]] or [[DialogControls-ControlsGroup|CT_CONTROLS_GROUP]] |PARAMETER1=
|descr= Returns [[true]] if auto-scroll should move back to start after it reaches the end.
<br><br>
Autorscroll is available for [[DialogControls-ListBoxes|CT_LISTBOX]] and [[CT_CONTROLS_GROUP]] types of controls only. Autoscroll will wait [[ctrlAutoScrollDelay]] seconds (must be  > 0) and then will scroll the scroll bar down to the bottom. [[ctrlAutoScrollSpeed]] defines the speed with which scrollbar is scrolled. If [[ctrlAutoScrollRewind]] is [[true]], the control will fade out, immediately rewind to the top, then fade in, wait [[ctrlAutoScrollDelay]] seconds and then repeat the scrolling in a loop. If user focuses on the control, autoscrolling is interrupted.


|p2= |PARAMETER2=  
|s1= [[ctrlAutoScrollRewind]] control


|p3= |PARAMETER3=
|p1= control: [[Control]] - [[DialogControls-ListBoxes|CT_LISTBOX]] or [[CT_CONTROLS_GROUP]]


| [[Boolean]] |RETURNVALUE=
|r1= [[Boolean]]


|x1= <sqf>_ctrlRewind = ctrlAutoScrollRewind _ctrlGroup;</sqf>


|x1= <code>_ctrlRewind = [[ctrlAutoScrollRewind]] _ctrlGroup;</code>|EXAMPLE1=
|seealso= [[ctrlSetAutoScrollSpeed]] [[ctrlAutoScrollSpeed]] [[ctrlSetAutoScrollDelay]] [[ctrlAutoScrollDelay]] [[ctrlSetAutoScrollRewind]]
 
____________________________________________________________________________________________
 
| [[ctrlSetAutoScrollSpeed]], [[ctrlAutoScrollSpeed]], [[ctrlSetAutoScrollDelay]], [[ctrlAutoScrollDelay]], [[ctrlSetAutoScrollRewind]] |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 Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]

Latest revision as of 21:24, 7 May 2022

Logo 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:
Returns true if auto-scroll should move back to start after it reaches the end.

Autorscroll is available for CT_LISTBOX and CT_CONTROLS_GROUP types of controls only. Autoscroll will wait ctrlAutoScrollDelay seconds (must be > 0) and then will scroll the scroll bar down to the bottom. ctrlAutoScrollSpeed defines the speed with which scrollbar is scrolled. If ctrlAutoScrollRewind is true, the control will fade out, immediately rewind to the top, then fade in, wait ctrlAutoScrollDelay seconds and then repeat the scrolling in a loop. If user focuses on the control, autoscrolling is interrupted.
Groups:
GUI ControlGUI Control - ListBoxGUI Control - ListNBox

Syntax

Syntax:
ctrlAutoScrollRewind control
Parameters:
control: Control - CT_LISTBOX or CT_CONTROLS_GROUP
Return Value:
Boolean

Examples

Example 1:
_ctrlRewind = ctrlAutoScrollRewind _ctrlGroup;

Additional Information

See also:
ctrlSetAutoScrollSpeed ctrlAutoScrollSpeed ctrlSetAutoScrollDelay ctrlAutoScrollDelay ctrlSetAutoScrollRewind

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=ctrlAutoScrollRewind&oldid=310871"