ScrollableControl.DockPadding Property (System.Windows.Forms)

.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)

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

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

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

[<BrowsableAttribute(false)>]
member 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.


    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;
 }


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++;
}

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Reference

ScrollableControl Class

System.Windows.Forms Namespace

ScrollableControl..::.DockPaddingEdges