ScrollableControl.ScrollToControl(Control) Method

Definition

Calculates the scroll offset to the specified child control.

protected:
 virtual System::Drawing::Point ScrollToControl(System::Windows::Forms::Control ^ activeControl);
protected virtual System.Drawing.Point ScrollToControl (System.Windows.Forms.Control activeControl);
abstract member ScrollToControl : System.Windows.Forms.Control -> System.Drawing.Point
override this.ScrollToControl : System.Windows.Forms.Control -> System.Drawing.Point
Protected Overridable Function ScrollToControl (activeControl As Control) As Point

Parameters

activeControl
Control

The child control to scroll into view.

Returns

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

Remarks

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.

Applies to

See also