CustomTaskPane.DockPosition 屬性

  • 發行項

取得或設定值，指定自訂工作窗格相對於應用程式視窗的位置。

命名空間：  Microsoft.Office.Tools
組件：  Microsoft.Office.Tools.Common (在 Microsoft.Office.Tools.Common.dll 中)

語法

'宣告
Property DockPosition As MsoCTPDockPosition
    Get
    Set

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 列舉型別 (Enumeration) 的值。

值

描述

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 命名空間