CustomTaskPane.Height 属性

定义

命名空间:

Microsoft.Office.Tools

程序集:

Microsoft.Office.Tools.Common.dll, Microsoft.Office.Tools.Common.v4.0.Utilities.dll, Microsoft.Office.Tools.Excel.v4.0.Utilities.dll, Microsoft.Office.Tools.Outlook.v4.0.Utilities.dll, Microsoft.Office.Tools.Word.v4.0.Utilities.dll

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

public:
 property int Height { int get(); void set(int value); };

public int Height { get; set; }

member this.Height : int with get, set

Public Property Height As Integer

属性值

Int32

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

例外

COMException

当你尝试设置 Height 属性时，DockPosition属性的值是 Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionRight 或 Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionLeft。-or-You 尝试在 或 VisibleChanged 事件的事件处理程序DockPositionChanged中设置Height属性。

ObjectDisposedException

已调用 CustomTaskPane 的 Microsoft.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 属性重新分配到最小高度。