DockPanel.SetDock Method (System.Windows.Controls)

Switch View

SetDock Method

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

DockPanel..::.SetDock Method

Sets the value of the Dock attached property to a specified element.

Namespace: System.Windows.Controls
Assembly: PresentationFramework (in PresentationFramework.dll)

Syntax

Visual Basic (Declaration)

Public Shared Sub SetDock ( _
    element As UIElement, _
    dock As Dock _
)

Visual Basic (Usage)

Dim element As UIElement
Dim dock As Dock

DockPanel.SetDock(element, dock)

public static void SetDock(
    UIElement element,
    Dock dock
)

Visual C++

public:
static void SetDock(
    UIElement^ element, 
    Dock dock
)

JScript

public static function SetDock(
    element : UIElement, 
    dock : Dock
)

XAML

You cannot use methods in XAML.

Parameters

element: Type: System.Windows..::.UIElement
The element to which the attached property is written.

dock: Type: System.Windows.Controls..::.Dock
The needed Dock value.

Remarks

The SetDock method changes the position of a child element relative to other child elements within the same container. Alignment properties, such as HorizontalAlignment, change the position of a child element relative to its parent element.

Examples

The following example shows how to assign a Dock value for an object. The example uses the GetDock and SetDock methods of DockPanel.

The example creates an instance of the TextBlock element, txt1, and assigns a Dock value of Top by using the SetDock method of DockPanel. It then appends the value of the Dock property to the Text of the TextBlock element by using the GetDock method. Finally, the example adds the TextBlock element to the parent DockPanel, dp1.

            // Create the Panel DockPanel
            dp1 = new DockPanel();

            // Create a Text Control and then set its Dock property
            txt1 = new TextBlock();
            DockPanel.SetDock(txt1, System.Windows.Controls.Dock.Top);
            txt1.Text = "The Dock Property is set to " + DockPanel.GetDock(txt1);
            dp1.Children.Add(txt1);
            mainWindow.Content = dp1;
            mainWindow.Show();

More Code

How to: Change Dock Properties

The following example shows how to change the value of the Dock property of DockPanel. This example also demonstrates the functionality of the different Dock values.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

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

Reference

DockPanel Class

DockPanel Members

System.Windows.Controls Namespace

DockPanel

Dock