NGWS SDK Documentation  

This is preliminary documentation and subject to change.
To comment on this topic, please send us email at ngwssdk@microsoft.com. Thanks!

ScrollableControl.SetAutoScrollMargin

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.

If a negative number is passed in as theorvalues, the value will be reset to zero.

Example [Visual Basic]

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 text box on the the panel so that it overlaps at least one of the panel's edges. Call this sub procedure 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

See Also

ScrollableControl Class | ScrollableControl Members | System.WinForms Namespace