CustomTaskPane.Height 属性

定义

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

public int Height { get; set; }

属性值

Int32

自定义任务窗格的高度(以磅为单位)。

例外

当尝试设置 Height 属性时,DockPosition 属性的值为 Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionRightMicrosoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionLeft

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

示例

下面的代码示例创建一个自定义任务窗格,该窗格在活动应用程序窗口的前面显示时具有指定的高度。 此代码示例是为提供的更大示例的一部分 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

注解

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

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

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

适用于