CustomTaskPaneCollection Classe (sistema de 2007)

Artigo
08/25/2010

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

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

Sintaxe

Public NotInheritable Class CustomTaskPaneCollection _
    Implements IEnumerable(Of CustomTaskPane), IEnumerable,  _
    ISupportInitialize, IDisposable

Dim instance As CustomTaskPaneCollection

public sealed class CustomTaskPaneCollection : IEnumerable<CustomTaskPane>, 
    IEnumerable, ISupportInitialize, IDisposable

Comentários

Use o CustomTaskPaneCollection classe em um suplemento em nível de aplicativo para adicionar um personalizado tarefa painel para um aplicativo, remova um personalizado tarefa acesso um personalizado existente ou painel tarefa painel.

Não criar sua própria instância do CustomTaskPaneCollection classe. Em vez disso, use o CustomTaskPanes campo de ThisAddIn classe em seu projeto suplemento. Para obter mais informações sobre o ThisAddIn classe, consulte Programação Application-Nível Adicionar-ins e Item de host addIn.

tarefa painéis são os painéis de interface do usuário que normalmente são encaixados em um dos lados de uma janela do aplicativo.Para obter mais informações sobre como criar personalizada tarefa painéis, consulte Visão geral de painéis de tarefas Personalizar.

Exemplos

O exemplo de código a seguir demonstra como criar uma personalizada tarefa painel usando o Add(UserControl, String) método. O exemplo também usa propriedades do CustomTaskPane objeto para modificar a aparência padrão do personalizado tarefa painel. Este exemplo de código é parte de um exemplo maior fornecido para a classe CustomTaskPane.

Private myUserControl1 As MyUserControl
PrivateWithEvents myCustomTaskPane As Microsoft.Office.Tools.CustomTaskPane

PrivateSub ThisAddIn_Startup(ByVal sender AsObject, ByVal e As System.EventArgs) _
    HandlesMe.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 = TrueEndWithEndSub

private MyUserControl myUserControl1;
private Microsoft.Office.Tools.CustomTaskPane myCustomTaskPane;

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

Hierarquia de herança

System.Object
Microsoft.Office.Tools.CustomTaskPaneCollection

Acesso thread-safe

Quaisquer membros static (Shared no Visual Basic) públicos deste tipo são thread-safe. Não há garantia de que qualquer membro de instância seja thread-safe.