通过

CustomTaskPane.Height 属性

  • 项目

获取或设置自定义任务窗格的高度（以磅为单位）。

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

语法

声明
Property Height As Integer
    Get
    Set

int Height { get; set; }

属性值

类型：System.Int32
自定义任务窗格的高度（以磅为单位）。

异常

异常 条件
COMException

当尝试设置 Height 属性时，DockPosition 属性的值为 Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionRight 或 Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionLeft。

- 或 -

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

已调用 CustomTaskPane 的 Dispose() 方法。

备注

如果自定义任务窗格停靠在文档窗口的左侧或右侧，请不要使用 Height 属性。 如果 DockPosition 属性为 Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionRight 或 Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionLeft，则 Height 属性将返回 0，并在您尝试设置它时引发 COMException。

最大高度取决于停靠位置。 当自定义任务窗格停靠到文档窗口的顶部或底部时，最大高度大约为屏幕高度的一半。 当自定义任务窗格浮动时，没有最大高度。

最小高度取决于多个因素，可以在 Microsoft Office 的将来版本中更改。 如果尝试将 Height 属性设置为小于最小高度的值，应用程序会自动将 Height 属性分配为最小高度。

示例

下面的代码示例创建一个自定义任务窗格，当该窗格显示在活动应用程序窗口的前面时具有指定的高度。 此代码示例摘自为 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 命名空间