Export (0) Print
Expand All

ScrollableControl.SetAutoScrollMargin Method

Sets the size of the auto-scroll margins.

[Visual Basic]
Public Sub SetAutoScrollMargin( _
   ByVal x As Integer, _
   ByVal y As Integer _
)
[C#]
public void SetAutoScrollMargin(
 int x,
 int y
);
[C++]
public: void SetAutoScrollMargin(
 int x,
 int y
);
[JScript]
public function SetAutoScrollMargin(
   x : int,
 y : int
);

Parameters

x
The Width value.
y
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 zero.

Example

[Visual Basic, C#, C++] The following 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. This example assumes a Panel control, TextBox, and Button have been instantiated. 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


[C#] 
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);
       }
    }
 }
 

[C++] 
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);
       }
    }
 }
 

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

ScrollableControl Class | ScrollableControl Members | System.Windows.Forms Namespace | AutoScrollMargin | AutoScroll | AutoScrollMinSize

Show:
© 2014 Microsoft