CustomTaskPane.DockPosition 属性

定义

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

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

属性值

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

例外

已调用 CustomTaskPaneMicrosoft.Office.Tools.CustomTaskPane.Dispose 方法。

尝试更改 DockPosition 属性的值时,属性的值DockPositionRestrict是 Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionRestrictNoChange。-或你尝试在 或 VisibleChanged 事件的事件处理程序DockPositionChanged中设置此属性。

示例

下面的代码示例创建自定义任务窗格,并针对窗格在活动应用程序窗口前显示以及停靠时配置不同的默认大小。 此代码示例是为 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

注解

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

“值” 描述
msoCTPDockPositionLeft 将自定义任务窗格停靠到窗口左侧。
msoCTPDockPositionTop 将自定义任务窗格停靠到窗口顶部。
msoCTPDockPositionRight 将自定义任务窗格停靠到窗口右侧。
msoCTPDockPositionBottom 将自定义任务窗格停靠到窗口底部。
msoCTPDockPositionFloating 在窗口前显示自定义任务窗格。 用户可以将任务窗格拖动到窗口中的任何位置。

适用于