CustomTaskPane 类 (2007 system)

2008-09-04

更新：2007 年 11 月

代表 Microsoft Office 应用程序中的自定义任务窗格。

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

语法

声明
Public NotInheritable Class CustomTaskPane _
    Implements IDisposable
用法
Dim instance As CustomTaskPane

public sealed class CustomTaskPane : IDisposable

备注

在应用程序级外接程序中使用 CustomTaskPane 类可以修改自定义任务窗格，或者在自定义任务窗格的位置或可见性发生变化时做出响应。

若要控制自定义任务窗格的大小或位置，可以使用诸如 Height、Width 和 Visible 等属性。

若要在自定义任务窗格移动或可见性发生变化时做出响应，可以处理 DockPositionChanged 和 VisibleChanged 事件。

任务窗格是通常停靠在应用程序窗口一侧的用户界面面板。有关如何创建自定义任务窗格的信息，请参见自定义任务窗格概述。

示例

下面的代码示例演示如何使用 Add(UserControl, String) 方法创建自定义任务窗格。此示例使用 CustomTaskPane 对象的属性来设置自定义任务窗格的默认外观，并为 DockPositionChanged 事件定义事件处理程序。若要编译此示例，请将代码复制到支持自定义任务窗格的应用程序的外接程序项目中的 ThisAddIn 类。使用此示例中的 ThisAddIn_Startup 方法替换 ThisAddIn 类中的默认 ThisAddIn_Startup 方法。此示例还假定项目包含一个名为 MyUserControl 的 UserControl，且 UserControl 包含一个名为 FlowPanel 的 FlowLayoutPanel。

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 Sub myCustomTaskPane_DockPositionChanged(ByVal sender As Object, _
    ByVal e As EventArgs) Handles myCustomTaskPane.DockPositionChanged

    Dim taskPane As Microsoft.Office.Tools.CustomTaskPane = _
        TryCast(sender, Microsoft.Office.Tools.CustomTaskPane)

    If taskPane IsNot Nothing Then

        ' Adjust sizes of user control and flow panel to fit current task pane size.
        Dim userControl As MyUserControl = TryCast(taskPane.Control, MyUserControl)
        Dim paneSize As System.Drawing.Size = _
            New System.Drawing.Size(taskPane.Width, taskPane.Height)
        userControl.Size = paneSize
        userControl.FlowPanel.Size = paneSize

        ' Adjust flow direction of controls on the task pane.
        If taskPane.DockPosition = _
            Office.MsoCTPDockPosition.msoCTPDockPositionTop Or _
            taskPane.DockPosition = _
            Office.MsoCTPDockPosition.msoCTPDockPositionBottom Then

            userControl.FlowPanel.FlowDirection = _
                System.Windows.Forms.FlowDirection.LeftToRight
        Else
            userControl.FlowPanel.FlowDirection = _
                System.Windows.Forms.FlowDirection.TopDown
        End If
    End If
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);
}

private void myCustomTaskPane_DockPositionChanged(object sender, EventArgs e)
{
    Microsoft.Office.Tools.CustomTaskPane taskPane =
        sender as Microsoft.Office.Tools.CustomTaskPane;

    if (taskPane != null)
    {
        // Adjust sizes of user control and flow panel to fit current task pane size.
        MyUserControl userControl = taskPane.Control as MyUserControl;
        System.Drawing.Size paneSize = new System.Drawing.Size(taskPane.Width, taskPane.Height);
        userControl.Size = paneSize;
        userControl.FlowPanel.Size = paneSize;

        // Adjust flow direction of controls on the task pane.
        if (taskPane.DockPosition == 
            Office.MsoCTPDockPosition.msoCTPDockPositionTop ||
            taskPane.DockPosition ==
            Office.MsoCTPDockPosition.msoCTPDockPositionBottom)
        {
            userControl.FlowPanel.FlowDirection =
                System.Windows.Forms.FlowDirection.LeftToRight;
        }
        else
        {
            userControl.FlowPanel.FlowDirection =
                System.Windows.Forms.FlowDirection.TopDown;
        }
    }
}