This documentation is archived and is not being maintained.

ScrollableControl.ScrollToControl Method

Calculates the scroll offset to the specified child control.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

'Declaration
Protected Overridable Function ScrollToControl ( _
	activeControl As Control _
) As Point
'Usage
Dim activeControl As Control 
Dim returnValue As Point 

returnValue = Me.ScrollToControl(activeControl)

Parameters

activeControl
Type: System.Windows.Forms.Control

The child control to scroll into view.

Return Value

Type: System.Drawing.Point
The upper-left hand Point of the display area relative to the client area required to scroll the control into view.

The ScrollControlIntoView method uses the ScrollToControl method to calculate how far it must scroll to display the specified control. The AutoScrollOffset property of the child control is used to adjust the scrolled position.

ScrollToControl does not cause scrolling; the SetDisplayRectLocation method is typically used to subsequently scroll to the calculated position.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: