Interface CustomTaskPaneCollection

Artigo
08/01/2011

Representa uma coleção de painéis de tarefas personalizados em um aplicativo de 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 CustomTaskPane objetos no atual CustomTaskPaneCollection.
	Item	Obtém o CustomTaskPane no índice especificado.

Início

Métodos

	Nome	Descrição
	Add(UserControl, String)	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.
	Add(UserControl, String, Object)	Cria um novo CustomTaskPane e o adiciona à atual CustomTaskPaneCollection.O painel de tarefas personalizado é baseado no usuário UserControl, tem o título especificado e está associado com a janela do aplicativo especificado.
	BeginInit	Infraestrutura.
	Dispose	Executa tarefas de definição de aplicativo associadas liberando, liberando ou redefinindo recursos não gerenciados. (Herdado de IDisposable.)
	EndInit	Infraestrutura.
	GetEnumerator()	Retorna um enumerador que itera através da coleção. (Herdado de IEnumerable<CustomTaskPane>.)
	GetEnumerator()	Retorna um enumerador que itera por meio de uma coleção. (Herdado de IEnumerable.)
	Remove	Remove o especificado CustomTaskPane partir do CustomTaskPaneCollection.
	RemoveAt	Remove o CustomTaskPane no índice especificado da CustomTaskPaneCollection.

Início

Comentários

Use o CustomTaskPaneCollection o objeto em um suplemento do nível do aplicativo para adicionar um painel de tarefas personalizado a um aplicativo, remova o painel de tarefas personalizado ou acessar um painel de tarefas personalizado existente. Para acessar o CustomTaskPaneCollection de objeto, use o CustomTaskPanes campo o ThisAddIn classe no seu suplemento do projeto. For more information, see Os suplementos de nível de aplicativo de programação..

Painéis são os painéis de interface do usuário que normalmente são encaixados em um lado da janela do aplicativo. Para obter mais informações sobre como criar painéis de tarefas personalizados, consulte Visão geral sobre painéis de tarefas personalizado.

Observação
Esta 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 Visual Studio Tools for Office visão geral sobre o tempo de execução.

Usage

Esta documentação descreve a versão deste tipo que é usada em projetos do Office destinados ao .NET Framework 4. Em projetos destinados ao .NET Framework 3.5, este tipo poderá ter membros diferentes, e os exemplos de código fornecidos para o tipo talvez não funcionem. Para obter documentação sobre este tipo em projetos destinados 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 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);
}