CustomTaskPane.DockPosition 属性

  • 项目

获取或设置一个指定自定义任务窗格相对于应用程序窗口的位置的值。

命名空间：  Microsoft.Office.Tools
程序集：  Microsoft.Office.Tools.Common（在 Microsoft.Office.Tools.Common.dll 中）

语法

声明
Property DockPosition As MsoCTPDockPosition

MsoCTPDockPosition DockPosition { get; set; }

属性值

类型：Microsoft.Office.Core.MsoCTPDockPosition
Microsoft.Office.Core.MsoCTPDockPosition 值之一。默认值为 Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionRight。

异常

异常 条件
ObjectDisposedException

已调用 CustomTaskPane 的 Dispose 方法。
COMException

当尝试更改 DockPosition 属性的值时，DockPositionRestrict 属性的值为 Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionRestrictNoChange。

- 或 -

您可以尝试在 DockPositionChanged 或 VisibleChanged 事件的事件处理程序中设置此属性。

备注

下表列出了 Microsoft.Office.Core.MsoCTPDockPosition 枚举的值。

值

描述

msoCTPDockPositionLeft

将自定义任务窗格停靠在窗口的左侧。

msoCTPDockPositionTop

将自定义任务窗格停靠在窗口的顶部。

msoCTPDockPositionRight

将自定义任务窗格停靠在窗口的右侧。

msoCTPDockPositionBottom

将自定义任务窗格停靠在窗口的底部。

msoCTPDockPositionFloating

将自定义任务窗格显示在窗口的前面。用户可以将任务窗格拖动到窗口中的任意位置。

示例

下面的代码示例创建一个自定义任务窗格，并配置当该窗格显示在活动应用程序窗口的前面时以及该窗格停靠时的不同默认大小。此代码示例摘自为 CustomTaskPane 提供的一个更大的示例。

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

.NET Framework 安全性

请参见

参考

CustomTaskPane 接口

Microsoft.Office.Tools 命名空间