CustomTaskPaneCollection-Schnittstelle

Artikel
05/07/2013

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

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

Syntax

'Declaration
<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

Der CustomTaskPaneCollection-Typ macht die folgenden Member verfügbar.

Eigenschaften

	Name	Beschreibung
	Count	Ruft die Anzahl der CustomTaskPane-Objekte in der aktuellen CustomTaskPaneCollection ab.
	Item	Ruft den CustomTaskPane am angegebenen Index ab.

Zum Seitenanfang

Methoden

	Name	Beschreibung
	Add(UserControl, String)	Erstellt einen neuen CustomTaskPane und fügt ihn der aktuellen CustomTaskPaneCollection hinzu.Der benutzerdefinierte Aufgabenbereich basiert auf dem angegebenen UserControl und verfügt über den angegebenen Titel.
	Add(UserControl, String, Object)	Erstellt einen neuen CustomTaskPane und fügt ihn der aktuellen CustomTaskPaneCollection hinzu.Der benutzerdefinierte Aufgabenbereich basiert auf dem angegebenen UserControl, verfügt über den angegebenen Titel und ist dem angegebenen Anwendungsfenster zugeordnet.
	BeginInit	Infrastruktur.
	Dispose	Führt anwendungsspezifische Aufgaben aus, die mit dem Freigeben, Zurückgeben oder Zurücksetzen von nicht verwalteten Ressourcen zusammenhängen. (Von IDisposable geerbt.)
	EndInit	Infrastruktur.
	GetEnumerator	Gibt einen Enumerator zurück, der die Auflistung durchläuft. (Von IEnumerable<CustomTaskPane> geerbt.)
	Remove	Entfernt den angegebenen CustomTaskPane aus der CustomTaskPaneCollection.
	RemoveAt	Entfernt den CustomTaskPane am angegebenen Index der CustomTaskPaneCollection.

Zum Seitenanfang

Hinweise

Verwenden Sie ein CustomTaskPaneCollection-Objekt 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.Wenn Sie auf das CustomTaskPaneCollection-Objekt zugreifen möchten, verwenden Sie das CustomTaskPanes-Feld der ThisAddIn-Klasse im Add-In-Projekt.Weitere Informationen finden Sie unter Programmieren von Add-Ins auf Anwendungsebene.

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 Benutzerdefinierte Aufgabenbereiche.

Hinweis
Diese Schnittstelle wird von der Visual Studio-Tools für Office-Laufzeit implementiert. Es ist nicht vorgesehen, dass der Typ direkt vom Code implementiert wird. Weitere Informationen finden Sie unter Übersicht über die Visual Studio Tools for Office-Laufzeit.

Verwendung

Diese Dokumentation beschreibt die Version des Typs, der in Office-Projekten verwendet wird, die auf .NET Framework 4 und .NET Framework 4.5 ausgerichtet sind. In Projekten, die auf .NET Framework 3.5 abzielen, verfügt dieser Typ möglicherweise über unterschiedliche Member, und die für diesen Typ bereitgestellten Codebeispiele funktionieren möglicherweise nicht. Dokumentation zu diesem Typ in Projekten mit der Zielversion .NET Framework 3.5 finden Sie im folgenden Verweisabschnitt in der Visual Studio 2008-Dokumentation: https://go.microsoft.com/fwlink/?LinkId=160658.

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