ScrollableControl.DockPadding Property (System.Windows.Forms)

DockPadding Property

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

ScrollableControl..::.DockPadding Property

Gets the dock padding settings for all edges of the control.

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

Syntax

Visual Basic (Declaration)

<BrowsableAttribute(False)> _
Public ReadOnly Property DockPadding As ScrollableControl..::.DockPaddingEdges

Visual Basic (Usage)

Dim instance As ScrollableControl
Dim value As ScrollableControl..::.DockPaddingEdges

value = instance.DockPadding

[BrowsableAttribute(false)]
public ScrollableControl..::.DockPaddingEdges DockPadding { get; }

Visual C++

[BrowsableAttribute(false)]
public:
property ScrollableControl..::.DockPaddingEdges^ DockPadding {
    ScrollableControl..::.DockPaddingEdges^ get ();
}

JScript

public function get DockPadding () : ScrollableControl..::.DockPaddingEdges

Property Value

Type: System.Windows.Forms..::.ScrollableControl..::.DockPaddingEdges
A ScrollableControl..::.DockPaddingEdges that represents the padding for all the edges of a docked control.

Remarks

This property controls the border inside of this control for docked components.

Examples

The following code example uses the derived class, Panel. The example docks a button in a panel control and cycles through the ScrollableControl..::.DockPaddingEdges properties, setting each individually on the click of the button. The example requires that you have created an instance of a Panel control and a Button on a form, and you have declared a class level member variable named myCounter as a 32-bit signed integer. You should call this code on the Click event of the button.

Visual Basic

Private Sub SetDockPadding()
    ' Dock the button in the panel.
    button1.Dock = System.Windows.Forms.DockStyle.Fill

    ' Reset the counter if it is greater than 5.
    If myCounter > 5 Then
        myCounter = 0
    End If

    ' Set the appropriate DockPadding and display
    ' which one was set on the button face.
    Select Case myCounter
        Case 0
            panel1.DockPadding.All = 0
            button1.Text = "Start"
        Case 1
            panel1.DockPadding.Top = 10
            button1.Text = "Top"
        Case 2
            panel1.DockPadding.Bottom = 10
            button1.Text = "Bottom"
        Case 3
            panel1.DockPadding.Left = 10
            button1.Text = "Left"
        Case 4
            panel1.DockPadding.Right = 10
            button1.Text = "Right"
        Case 5
            panel1.DockPadding.All = 20
            button1.Text = "All"
    End Select

    ' Increment the counter.
    myCounter += 1
End Sub

private void SetDockPadding()
 {
    // Dock the button in the panel.
    button1.Dock = System.Windows.Forms.DockStyle.Fill;

    // Reset the counter if it is greater than 5.
    if (myCounter > 5)
    {
       myCounter = 0;
    }

    // Set the appropriate DockPadding and display
    // which one was set on the button face.
    switch (myCounter)
    {
       case 0:
          panel1.DockPadding.All = 0;
          button1.Text = "Start";
          break;
       case 1:
          panel1.DockPadding.Top = 10;
          button1.Text = "Top";
          break;
       case 2:
          panel1.DockPadding.Bottom = 10;
          button1.Text = "Bottom";
          break;
       case 3:
          panel1.DockPadding.Left = 10;
          button1.Text = "Left";
          break;
       case 4:
          panel1.DockPadding.Right = 10;
          button1.Text = "Right";
          break;
       case 5:
          panel1.DockPadding.All = 20;
          button1.Text = "All";
          break;
    }

    // Increment the counter.
    myCounter += 1;
 }

Visual C++

void SetDockPadding()
{
   // Dock the button in the panel.
   button1->Dock = System::Windows::Forms::DockStyle::Fill;

   // Reset the counter if it is greater than 5.
   if ( myCounter > 5 )
   {
      myCounter = 0;
   }

   // Set the appropriate DockPadding and display
   // which one was set on the button face.
   switch ( myCounter )
   {
      case 0:
         panel1->DockPadding->All = 0;
         button1->Text = "Start";
         break;

      case 1:
         panel1->DockPadding->Top = 10;
         button1->Text = "Top";
         break;

      case 2:
         panel1->DockPadding->Bottom = 10;
         button1->Text = "Bottom";
         break;

      case 3:
         panel1->DockPadding->Left = 10;
         button1->Text = "Left";
         break;

      case 4:
         panel1->DockPadding->Right = 10;
         button1->Text = "Right";
         break;

      case 5:
         panel1->DockPadding->All = 20;
         button1->Text = "All";
         break;
   }
   myCounter++;
}

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

ScrollableControl..::.DockPaddingEdges

Padding

Margin

AutoScrollMargin