ScrollableControl::ScrollToControl Method (Control^)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Calculates the scroll offset to the specified child control.

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

protected:
virtual Point ScrollToControl(
	Control^ 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.

.NET Framework
Available since 2.0
Return to top
Show: