CustomTaskPaneCollection-Klasse (2007 System)

Artikel
08/23/2008

Aktualisiert: November 2007

Stellt eine Auflistung von benutzerdefinierten Aufgabenbereichen in einer Microsoft Office-Anwendung dar.

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

Syntax

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

Dim instance As CustomTaskPaneCollection

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

Hinweise

Verwenden Sie die CustomTaskPaneCollection-Klasse in einem Add-In auf Anwendungsebene, um einer Anwendung einen benutzerdefinierten Aufgabenbereich hinzuzufügen, einen benutzerdefinierten Aufgabenbereich zu entfernen oder auf einen benutzerdefinierten Aufgabenbereich zuzugreifen.

Erstellen Sie nicht eine eigene Instanz der CustomTaskPaneCollection-Klasse. Verwenden Sie stattdessen das CustomTaskPanes-Feld der ThisAddIn-Klasse im Add-In-Projekt. Weitere Informationen zur ThisAddIn-Klasse finden Sie unter Programmieren von Add-Ins auf Anwendungsebene und unter AddIn-Hostelement.

Aufgabenbereiche sind Bereiche der Benutzeroberfläche, die i. d. R. an eine Seite eines Anwendungsfensters angedockt sind. Weitere Informationen zum Erstellen von benutzerdefinierten Aufgabenbereichen finden Sie unter Übersicht über benutzerdefinierte Aufgabenbereiche.

Beispiele

Im folgenden Codebeispiel wird veranschaulicht, wie mithilfe der Add(UserControl, String)-Methode ein benutzerdefinierter Aufgabenbereich erstellt wird. In diesem Beispiel werden zudem Eigenschaften des CustomTaskPane-Objekts verwendet, um die Standarddarstellung des benutzerdefinierten Aufgabenbereichs zu ändern. Dieses Codebeispiel ist Teil eines umfangreicheren Beispiels, das sich auf die CustomTaskPane-Klasse bezieht.

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

Vererbungshierarchie

System.Object
Microsoft.Office.Tools.CustomTaskPaneCollection

Threadsicherheit

Alle öffentlichen static (Shared in Visual Basic)-Member dieses Typs sind threadsicher. Bei Instanzmembern ist die Threadsicherheit nicht gewährleistet.