Gets or sets a value that specifies where the custom task pane is located relative to the application window.
(in Microsoft.Office.Tools.Common.v9.0.dll)
Visual Basic (Declaration)
Public Property DockPosition As MsoCTPDockPosition
Dim instance As CustomTaskPane
Dim value As MsoCTPDockPosition
value = instance.DockPosition
instance.DockPosition = value
public 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.
The following table lists the values of the Microsoft.Office.Core.MsoCTPDockPosition enumeration.
Value | Description |
|---|
msoCTPDockPositionLeft
| Docks the custom task pane to the left side of the window. |
msoCTPDockPositionTop
| Docks the custom task pane to the top of the window. |
msoCTPDockPositionRight
| Docks the custom task pane to the right side of the window. |
msoCTPDockPositionBottom
| Docks the custom task pane to the bottom of the window. |
msoCTPDockPositionFloating
| 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 the CustomTaskPane class.
Private myUserControl1 As MyUserControl
Private WithEvents myCustomTaskPane As Microsoft.Office.Tools.CustomTaskPane
Private Sub ThisAddIn_Startup(ByVal sender As Object, ByVal e As System.EventArgs) _
Handles Me.Startup
myUserControl1 = New MyUserControl()
myCustomTaskPane = Me.CustomTaskPanes.Add(myUserControl1, "New Task Pane")
With myCustomTaskPane
.DockPosition = Office.MsoCTPDockPosition.msoCTPDockPositionFloating
.Height = 500
.Width = 500
.DockPosition = Office.MsoCTPDockPosition.msoCTPDockPositionRight
.Width = 300
.Visible = True
End With
End Sub
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 =
Office.MsoCTPDockPosition.msoCTPDockPositionFloating;
myCustomTaskPane.Height = 500;
myCustomTaskPane.Width = 500;
myCustomTaskPane.DockPosition =
Office.MsoCTPDockPosition.msoCTPDockPositionRight;
myCustomTaskPane.Width = 300;
myCustomTaskPane.Visible = true;
myCustomTaskPane.DockPositionChanged +=
new EventHandler(myCustomTaskPane_DockPositionChanged);
}
Reference