.NET Framework Class Library
ScrollableControl..::.ScrollControlIntoView Method

Scrolls the specified child control into view on an auto-scroll enabled control.

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

Visual Basic (Declaration)
Public Sub ScrollControlIntoView ( _
    activeControl As Control _
)
Visual Basic (Usage)
Dim instance As ScrollableControl
Dim activeControl As Control

instance.ScrollControlIntoView(activeControl)
C#
public void ScrollControlIntoView(
    Control activeControl
)
Visual C++
public:
void ScrollControlIntoView(
    Control^ activeControl
)
JScript
public function ScrollControlIntoView(
    activeControl : Control
)

Parameters

activeControl
Type: System.Windows.Forms..::.Control
The child control to scroll into view.
Remarks

The AutoScroll property must be set to true, and at least one of the scroll bars, horizontal or vertical, must also be visible, for the ScrollControlIntoView method to have an effect. To make the horizontal and vertical scroll bars visible, the HScroll and VScroll properties, respectively, must be set to true.

If the activeControl parameter is not a child control, no action takes place.

This method may raise the Scroll event.

Examples

The following code example enables auto-scrolling for a form, resizes the form, and ensures that a button remains visible after the form is resized. The example requires that you have a Form with a Button named button2 on it.

Visual Basic
Private Sub ResizeForm()
   ' Enable auto-scrolling for the form.
   Me.AutoScroll = True

   ' Resize the form.
   Dim r As Rectangle = Me.ClientRectangle
   ' Subtract 100 pixels from each side of the Rectangle.
   r.Inflate(- 100, - 100)
   Me.Bounds = Me.RectangleToScreen(r)

   ' Make sure button2 is visible.
   Me.ScrollControlIntoView(button2)
End Sub
C#
private void ResizeForm()
{
   // Enable auto-scrolling for the form.
   this.AutoScroll = true;

   // Resize the form.
   Rectangle r = this.ClientRectangle;
   // Subtract 100 pixels from each side of the Rectangle.
   r.Inflate(-100, -100);
   this.Bounds = this.RectangleToScreen(r);

   // Make sure button2 is visible.
   this.ScrollControlIntoView(button2);
}
Visual C++
private:
   void ResizeForm()
   {

      // Enable auto-scrolling for the form.
      this->AutoScroll = true;

      // Resize the form.
      Rectangle r = this->ClientRectangle;

      // Subtract 100 pixels from each side of the Rectangle.
      r.Inflate(  -100, -100 );
      this->Bounds = this->RectangleToScreen( r );

      // Make sure button2 is visible.
      this->ScrollControlIntoView( button2 );
   }
Platforms

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.
Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
See Also

Reference

Tags :


Page view tracker