ScrollableControl.AutoScrollMargin Property
Assembly: System.Windows.Forms (in system.windows.forms.dll)
[LocalizableAttribute(true)] public: property Size AutoScrollMargin { Size get (); void set (Size value); }
/** @property */ public Size get_AutoScrollMargin () /** @property */ public void set_AutoScrollMargin (Size value)
public function get AutoScrollMargin () : Size public function set AutoScrollMargin (value : Size)
Not applicable.
Property Value
A Size that represents the height and width of the auto-scroll margin in pixels.The auto-scroll margin is the distance between any child controls and the edges of the scrollable parent control. The AutoScrollMargin size is added to the size of any child controls contained in the scrollable control to determine whether or not scroll bars are needed. The AutoScrollMargin property is evaluated when the parent scrollable control is resized or the individual child controls are brought into view, and is used to determine if scroll bars must be displayed. Docked controls are excluded from the calculations that determine if scroll bars must be displayed.
Note: |
|---|
| If a docked control's Dock property is set to DockStyle.Fill, the control fills the parent scrollable control and the docked control is ignored when using the AutoScrollMargin to determine whether scroll bars are needed. |
If the distance from the edge of a child control to the parent scrollable control is less than the value assigned to the AutoScrollMargin property and the AutoScroll property is set to true, the appropriate scroll bar is displayed.
Note: |
|---|
| We recommend, when docking controls within a scrollable control, that you add a child scrollable control, such as a Panel, to contain any other controls that might require scrolling. You should add the child Panel control to the scrollable control and its Dock property set to DockStyle.Fill and its AutoScroll property set to true. You should set the AutoScroll property of the parent scrollable control to false. |
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 text box on the panel so that it overlaps at least one of the panel's edges. Call this function on the click of a button to see the difference in the panel's behavior and appearance.
void SetAutoScrollMargins() { /* 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 ); } } }
private void SetAutoScrollMargins()
{
/* If the text box is outside the panel's bounds,
turn on auto-scrolling and set the margin. */
if (text1.get_Location().get_X() > panel1.get_Location().get_X()
|| text1.get_Location().get_Y() > panel1.get_Location().get_Y()) {
panel1.set_AutoScroll(true);
/* If the AutoScrollMargin is set to less
than (5,5), set it to 5,5. */
if (panel1.get_AutoScrollMargin().get_Width() < 5
|| panel1.get_AutoScrollMargin().get_Height() < 5) {
panel1.SetAutoScrollMargin(5, 5);
}
}
} //SetAutoScrollMargins
Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.
Note: