Método CustomTaskPaneCollection.Add (UserControl, String)

  • Artigo

Cria um novo CustomTaskPane e o adiciona à atual CustomTaskPaneCollection. O painel de tarefas personalizado é baseado no usuário UserControl e tem o título especificado.

Namespace:  Microsoft.Office.Tools
Assembly:  Microsoft.Office.Tools.Common (em Microsoft.Office.Tools.Common.dll)

Sintaxe

'Declaração
Function Add ( _
    control As UserControl, _
    title As String _
) As CustomTaskPane

CustomTaskPane Add(
    UserControl control,
    string title
)

Parâmetros

  • title
    Tipo: System.String
    O texto que aparece na barra de título do novo painel de tarefas personalizado.

Valor de retorno

Tipo: Microsoft.Office.Tools.CustomTaskPane
A CustomTaskPane que representa o novo painel de tarefas personalizado.

Exceções

Exceção Condição
ArgumentNullException

controlor title is nulluma referência nula (Nothing no Visual Basic).
ObjectDisposedException

O Dispose() método já foi chamado de CustomTaskPaneCollection.

Comentários

Use esse método para criar uma nova CustomTaskPane que está associado com a janela ativa do aplicativo Microsoft Office.

Embora um CustomTaskPaneCollection o objeto é uma coleção de CustomTaskPane objetos, o Add método aceita UserControl objetos em vez de CustomTaskPane objetos. For more information, see Visão geral sobre painéis de tarefas personalizado.

Se você quiser especificar uma janela específica e associar o painel de tarefas personalizado, use o Add(UserControl, String, Object) método.

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 também usa propriedades do CustomTaskPane o objeto para modificar a aparência padrão do painel de tarefas personalizado. Este exemplo de código é parte de um exemplo maior fornecido para 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);
}

Segurança do .NET Framework

Consulte também

Referência

CustomTaskPaneCollection Interface

Sobrecargas Add

Namespace Microsoft.Office.Tools