CustomTaskPane Interface

Definição

Representa um painel de tarefas personalizado em um aplicativo do Microsoft Office.

[System.Runtime.InteropServices.Guid("881b42fd-484d-4494-8500-779de4e4aac1")]
public interface CustomTaskPane : IDisposable
Atributos
Implementações

Exemplos

O exemplo de código a seguir demonstra como criar um painel de tarefas personalizado usando o Add(UserControl, String) método. O exemplo usa as propriedades do CustomTaskPane objeto para definir a aparência padrão do painel de tarefas personalizado e define um manipulador de eventos para o DockPositionChanged evento. Para compilar este exemplo, copie o código na ThisAddIn classe em um projeto de suplemento para um aplicativo que ofereça suporte a painéis de tarefas personalizados. Substitua o ThisAddIn_Startup método padrão na ThisAddIn classe pelo ThisAddIn_Startup método neste exemplo. Este exemplo também pressupõe que o projeto contém um UserControl nomeado MyUserControl e UserControl contém um FlowLayoutPanel nomeado FlowPanel .

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;
        }
    }
}
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

Comentários

Use um CustomTaskPane objeto em um suplemento de nível de aplicativo para modificar um painel de tarefas personalizado ou para responder quando o local ou a visibilidade do painel de tarefas personalizado for alterado. Os painéis de tarefas são painéis de interface do usuário que normalmente são encaixados em um lado de uma janela de aplicativo. Para obter informações sobre como criar painéis de tarefas personalizados, consulte painéis de tarefas personalizados.

Para controlar o tamanho ou o local do painel de tarefas personalizado, você pode usar propriedades como Height , Width e Visible .

Para responder quando o painel de tarefas personalizado move ou altera a visibilidade, você pode manipular os DockPositionChanged VisibleChanged eventos e.

Observação

Essa interface é implementada pelo Visual Studio Tools para Office Runtime. Ela não se destina a ser implementada em seu código. Para obter mais informações, consulte Visão geral do Visual Studio Tools para Office Runtime.

Uso

Essa documentação descreve a versão desse tipo que é usada nos projetos do Office direcionados ao .NET Framework 4 ou posterior. Em projetos direcionados ao .NET Framework 3.5, esse tipo pode ter membros diferentes e os exemplos de código fornecidos para este tipo talvez não funcionem. Conheça a documentação sobre este tipo em projetos direcionados ao .NET Framework 3.5 na seguinte seção de referência na documentação do Visual Studio 2008: http://go.microsoft.com/fwlink/?LinkId=160658.

Propriedades

Control

Obtém o UserControl que fornece a interface do usuário do painel de tarefas personalizado.

DockPosition

Obtém ou define um valor que especifica onde o painel de tarefas personalizado está localizado em relação à janela do aplicativo.

DockPositionRestrict

Obtém ou define um valor que impede que o painel de tarefas personalizado seja encaixado na posição especificada.

Height

Obtém ou define a altura do painel de tarefas personalizado em pontos.

Title

Obtém o título do painel de tarefas personalizado.

Visible

Obtém ou define um valor que especifica se o painel de tarefas personalizado está visível.

Width

Obtém ou define a largura do painel de tarefas personalizado em pontos.

Window

Obtém a janela do documento ao qual o painel de tarefas personalizado está associado.

Eventos

DockPositionChanged

Ocorre quando o usuário altera a posição de encaixe do painel de tarefas personalizado ou quando o código altera o valor da propriedade DockPosition.

VisibleChanged

Ocorre quando o usuário exibe ou fecha o painel de tarefas personalizado ou quando o código altera o valor da propriedade Visible.

Aplica-se a