CustomTaskPane.DockPosition Property


Gets or sets a value that specifies where the custom task pane is located relative to the application window.

Namespace:   Microsoft.Office.Tools
Assembly:  Microsoft.Office.Tools.Common (in Microsoft.Office.Tools.Common.dll)

MsoCTPDockPosition DockPosition { get; set; }

Property Value

Type: Microsoft.Office.Core.MsoCTPDockPosition

One of the Microsoft.Office.Core.MsoCTPDockPosition values. The default is Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionRight.

Exception Condition

The M:Microsoft.Office.Tools.CustomTaskPane.Dispose method of the CustomTaskPane has already been called.


The value of the DockPositionRestrict property is Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionRestrictNoChange when you try to change the value of the DockPosition property.


You try to set this property in the event handler for the DockPositionChanged or VisibleChanged event.

The following table lists the values of the Microsoft.Office.Core.MsoCTPDockPosition enumeration.




Docks the custom task pane to the left side of the window.


Docks the custom task pane to the top of the window.


Docks the custom task pane to the right side of the window.


Docks the custom task pane to the bottom of the window.


Displays the custom task pane in front of the window. The user can drag the task pane to any location in the window.

The following code example creates a custom task pane and configures different default sizes for when the pane displays in front of the active application window, and when it is docked. This code example is part of a larger example provided for CustomTaskPane.

private MyUserControl myUserControl1;
private Microsoft.Office.Tools.CustomTaskPane myCustomTaskPane;

private void ThisAddIn_Startup(object sender, System.EventArgs e)
    myUserControl1 = new MyUserControl();
    myCustomTaskPane = this.CustomTaskPanes.Add(myUserControl1,
        "New Task Pane");

    myCustomTaskPane.DockPosition =
    myCustomTaskPane.Height = 500;
    myCustomTaskPane.Width = 500;

    myCustomTaskPane.DockPosition =
    myCustomTaskPane.Width = 300;

    myCustomTaskPane.Visible = true;
    myCustomTaskPane.DockPositionChanged +=
        new EventHandler(myCustomTaskPane_DockPositionChanged);
Return to top