ScrollableControl.DockPadding Property


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

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

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

Public ReadOnly Property DockPadding As 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.

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

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

.NET Framework
Available since 1.1
Return to top