TreeView_SetAutoScrollInfo macro (commctrl.h)

Article
10/23/2024

Sets information used to determine auto-scroll characteristics. Use this macro or send the TVM_SETAUTOSCROLLINFO message explicitly.

Syntax

LRESULT TreeView_SetAutoScrollInfo(
   HWND hwnd,
   UINT uPixPerSec,
   UINT uUpdateTime
);

Parameters

hwnd

Type: HWND

Handle to the tree-view control.

uPixPerSec

Type: UINT

Specifies pixels per second. The offset to scroll is divided by the uPixPerSec to determine the total duration of the auto-scroll.

uUpdateTime

Type: UINT

Specifies the redraw time interval. Redraw at every elapsed interval, until the item is scrolled into view. Given uPixPerSec, the location of the item is calculated and a repaint occurs. Set this value to create smooth scrolling.

Return value

Type: LRESULT

Returns TRUE.

Remarks

Autoscroll information is used to scroll a nonvisible item into view. The control must have the TVS_EX_AUTOHSCROLL extended style. For information on extended styles, see Tree-View Control Extended Styles.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	commctrl.h

Share via