CustomTaskPane.DockPosition Property

Reference

Definition

Namespace:: Microsoft.Office.Tools

Assemblies:: Microsoft.Office.Tools.Common.dll, Microsoft.Office.Tools.Common.v4.0.Utilities.dll, Microsoft.Office.Tools.Excel.v4.0.Utilities.dll, Microsoft.Office.Tools.Outlook.v4.0.Utilities.dll, Microsoft.Office.Tools.Word.v4.0.Utilities.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 property Microsoft::Office::Core::MsoCTPDockPosition DockPosition { Microsoft::Office::Core::MsoCTPDockPosition get(); void set(Microsoft::Office::Core::MsoCTPDockPosition value); };

public Microsoft.Office.Core.MsoCTPDockPosition DockPosition { get; set; }

member this.DockPosition : Microsoft.Office.Core.MsoCTPDockPosition with get, set

Public Property DockPosition As MsoCTPDockPosition

Property Value

MsoCTPDockPosition

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

Exceptions

ObjectDisposedException

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

COMException

The value of the DockPositionRestrict property is Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionRestrictNoChange when you try to change the value of the DockPosition property.-or-You try to set this property in the event handler for the DockPositionChanged or VisibleChanged event.

Examples

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

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

Remarks

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.

Applies to

Share via