Compartilhar via

Método CustomTaskPaneCollection.Add (UserControl, String)

  • Artigo

Cria um novo CustomTaskPane e adicioná-lo a CustomTaskPaneCollectionatual. O painel de tarefa personalizada é baseado em UserControl especificado 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 tarefa personalizada.

Valor de retorno

Tipo: Microsoft.Office.Tools.CustomTaskPane
CustomTaskPane que representa o novo painel de tarefa personalizada.

Exceções

Exceção Condição
ArgumentNullException

control ou title são nulluma referência nula (Nothing no Visual Basic).
ObjectDisposedException

O método de Dispose tiver sido chamado já CustomTaskPaneCollection.

Comentários

Use este método para criar um novo CustomTaskPane que está associado com a janela ativa de aplicativo do Microsoft Office.

Embora um objeto de CustomTaskPaneCollection é uma coleção de objetos CustomTaskPane , o método de Add aceita objetos de UserControl em vez de objetos de CustomTaskPane . Para obter mais informações, consulte Painéis de tarefa personalizados.

Se você desejar especificar uma janela específico e para associar o painel de tarefa personalizada com ele, use o método de Add(UserControl, String, Object) .

Exemplos

O exemplo de código demonstra como criar um painel de tarefa personalizada usando o método Add(UserControl, String) . O exemplo também usa propriedades do objeto de CustomTaskPane para alterar a aparência padrão do painel de tarefa personalizada. 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