ctrlAutoScrollSpeed: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (control cat added)
(updated)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Returns number of seconds to auto-scroll one line. -1 if auto-scroll is disabled. -2 if scrollbar not present. |= Description
| Returns number of seconds to auto-scroll one line. -1 if auto-scroll is disabled. -2 if scrollbar not present.  
<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
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''ctrlAutoScrollSpeed''' control |= Syntax
| '''ctrlAutoScrollSpeed''' control |= Syntax


|p1= control: [[Control]] - |= PARAMETER1  
|p1= control: [[Control]] - [[DialogControls-ListBoxes|CT_LISTBOX]] or [[DialogControls-ControlsGroup|CT_CONTROLS_GROUP]] |= PARAMETER1  


|p2= |= PARAMETER2  
|p2= |= PARAMETER2  
Line 21: Line 24:




|x1= <code>(example)</code>|= EXAMPLE1  
|x1= <code>_ctrlSpeed =  [[ctrlAutoScrollSpeed]] _ctrlGroup;</code>|= EXAMPLE1  


____________________________________________________________________________________________
____________________________________________________________________________________________


|  |= SEEALSO  
[[ctrlSetAutoScrollSpeed]], [[ctrlSetAutoScrollDelay]], [[ctrlAutoScrollDelay]], [[ctrlSetAutoScrollRewind]], [[ctrlAutoScrollRewind]] |= SEEALSO  


|  |= MPBEHAVIOUR  
|  |= MPBEHAVIOUR  

Revision as of 23:26, 14 January 2017

Hover & click on the images for description

Description

Description:
Returns number of seconds to auto-scroll one line. -1 if auto-scroll is disabled. -2 if scrollbar not present.

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:
Uncategorised

Syntax

Syntax:
ctrlAutoScrollSpeed control
Parameters:
control: Control - CT_LISTBOX or CT_CONTROLS_GROUP
Return Value:
Number

Examples

Example 1:
_ctrlSpeed = ctrlAutoScrollSpeed _ctrlGroup;

Additional Information

See also:
ctrlSetAutoScrollSpeedctrlSetAutoScrollDelayctrlAutoScrollDelayctrlSetAutoScrollRewindctrlAutoScrollRewind

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

Notes

Bottom Section