ScrollableControl.SetAutoScrollMargin Method (System.Windows.Forms)

SetAutoScrollMargin Method

.NET Framework Class Library

ScrollableControl..::.SetAutoScrollMargin Method

Sets the size of the auto-scroll margins.

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

Syntax

Visual Basic (Declaration)

Public Sub SetAutoScrollMargin ( _
    x As Integer, _
    y As Integer _
)

Visual Basic (Usage)

Dim instance As ScrollableControl
Dim x As Integer
Dim y As Integer

instance.SetAutoScrollMargin(x, y)

public void SetAutoScrollMargin(
    int x,
    int y
)

Visual C++

public:
void SetAutoScrollMargin(
    int x, 
    int y
)

JScript

public function SetAutoScrollMargin(
    x : int, 
    y : int
)

Parameters

x: Type: System..::.Int32
The Width value.

y: Type: System..::.Int32
The Height value.

Remarks

The margin sets the width and height of the border around each control. This margin is used to determine when scroll bars are needed on the container and where to scroll to when a control is selected.

Note:
If a negative number is passed in as the x or y values, the value will be reset to 0.

Examples

The following code example uses the derived class, Panel. The example evaluates the location of a text box and changes the appearance and behavior of its parent container, the panel control. The example requires that you have created an instance of a Panel control, TextBox, and Button. Place the box on the panel so that it overlaps at least one of the panel's edges. Call this subprocedure on the click of a button to see the difference in the panel's behavior and appearance.

Visual Basic

Private Sub MySub()
    ' If the text box is outside the panel's bounds,
    ' turn on auto-scrolling and set the margin. 
    If (text1.Location.X > panel1.Location.X) Or _
        (text1.Location.Y > panel1.Location.Y) Then

        panel1.AutoScroll = True            
        ' If the AutoScrollMargin is set to
        ' less than (5,5), set it to 5,5. 
        If (panel1.AutoScrollMargin.Width < 5) Or _
            (panel1.AutoScrollMargin.Height < 5) Then

            panel1.SetAutoScrollMargin(5, 5)
        End If
    End If
End Sub

private void MySub()
 {
    /* If the text box is outside the panel's bounds, 
       turn on auto-scrolling and set the margin. */
    if (text1.Location.X > panel1.Location.X ||
     text1.Location.Y > panel1.Location.Y)
    {
       panel1.AutoScroll = true;
       /* If the AutoScrollMargin is set to 
          less than (5,5), set it to 5,5. */
       if(panel1.AutoScrollMargin.Width < 5 ||
        panel1.AutoScrollMargin.Height < 5)
       {
          panel1.SetAutoScrollMargin(5, 5);
       }
    }
 }

Visual C++

void MySub()
{
   /* If the text box is outside the panel's bounds, 
          turn on auto-scrolling and set the margin. */
   if ( text1->Location.X > panel1->Location.X || text1->Location.Y > panel1->Location.Y )
   {
      panel1->AutoScroll = true;

      /* If the AutoScrollMargin is set to 
                less than (5,5), set it to 5,5. */
      if ( panel1->AutoScrollMargin.Width < 5 || panel1->AutoScrollMargin.Height < 5 )
      {
         panel1->SetAutoScrollMargin( 5, 5 );
      }
   }
}

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

Reference

ScrollableControl Class

ScrollableControl Members

System.Windows.Forms Namespace

AutoScrollMargin

AutoScroll

AutoScrollMinSize