Interface CustomTaskPaneCollection

Artigo
01/09/2014

Representa uma coleção de painéis de tarefa personalizada em um aplicativo do Microsoft Office.

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

Sintaxe

'Declaração
<GuidAttribute("c3a84bf1-e95b-4d23-952d-59e35673958e")> _
Public Interface CustomTaskPaneCollection _
    Inherits IEnumerable(Of CustomTaskPane), IEnumerable, IDisposable

[GuidAttribute("c3a84bf1-e95b-4d23-952d-59e35673958e")]
public interface CustomTaskPaneCollection : IEnumerable<CustomTaskPane>, 
    IEnumerable, IDisposable

O tipo CustomTaskPaneCollection expõe os membros a seguir.

Propriedades

	Nome	Descrição
	Count	Obtém o número de objetos de CustomTaskPane em CustomTaskPaneCollectionatual.
	Item	Obtém CustomTaskPane no índice especificado.

Superior

Métodos

	Nome	Descrição
	Add(UserControl, String)	Cria um novo CustomTaskPane e adicioná-lo a CustomTaskPaneCollectionatual.O painel de tarefa personalizada é baseado em UserControl especificado e tem o título especificado.
	Add(UserControl, String, Object)	Cria um novo CustomTaskPane e adicioná-lo a CustomTaskPaneCollectionatual.O painel de tarefa personalizada é baseado em UserControlespecificado, tem o título especificado, e está associado com a janela especificada do aplicativo.
	BeginInit	Infraestrutura.
	Dispose	Realiza tarefas definidas pelo aplicativo associadas à liberação ou à redefinição de recursos não gerenciados. (Herdado de IDisposable.)
	EndInit	Infraestrutura.
	GetEnumerator	Retorna um enumerador que itera através da coleção. (Herdado de IEnumerable<CustomTaskPane>.)
	Remove	Remove CustomTaskPane especificado de CustomTaskPaneCollection.
	RemoveAt	Remove CustomTaskPane no índice especificado de CustomTaskPaneCollection.

Superior

Comentários

Use o objeto de CustomTaskPaneCollection em um suplemento ao nível para adicionar um painel de tarefa adequada para um aplicativo, remover um painel de tarefa personalizada, ou acessar um painel existente de tarefa personalizada. Para acessar o objeto de CustomTaskPaneCollection , use o campo de CustomTaskPanes da classe de ThisAddIn em seu projeto do suplemento. Para obter mais informações, consulte Programando suplementos no nível do aplicativo.

Os painéis de tarefas são os painéis de interface do usuário que estão conectados normalmente a um lado de uma janela de aplicativo. Para obter mais informações sobre como criar os painéis de tarefa personalizada, consulte Painéis de tarefa personalizados.

Dica

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

Uso

Essa documentação descreve a versão desse tipo que é usada apenas nos projetos do Office direcionados ao .NET Framework 4 e ao .NET Framework 4.5. 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. Para conhecer a documentação sobre esse tipo de projeto direcionado ao .NET Framework 3.5, consulte a seguinte seção de referência na documentação do Visual Studio 2008: https://go.microsoft.com/fwlink/?LinkId=160658.

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