CustomTaskPaneCollection, interface

Article
05/16/2013

Représente une collection de volets Office personnalisés dans une application Microsoft Office.

Espace de noms : Microsoft.Office.Tools
Assembly : Microsoft.Office.Tools.Common (dans Microsoft.Office.Tools.Common.dll)

Syntaxe

'Déclaration
<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

Le type CustomTaskPaneCollection expose les membres suivants.

Propriétés

	Nom	Description
	Count	Obtient le nombre d'objets CustomTaskPane présents dans la CustomTaskPaneCollection en cours.
	Item	Obtient le CustomTaskPane à l'index spécifié.

Début

Méthodes

	Nom	Description
	Add(UserControl, String)	Crée un nouveau CustomTaskPane et l'ajoute à la CustomTaskPaneCollection en cours.Le volet Office personnalisé est basé sur le UserControl spécifié et a le titre spécifié.
	Add(UserControl, String, Object)	Crée un nouveau CustomTaskPane et l'ajoute à la CustomTaskPaneCollection en cours.Le volet Office personnalisé est basé sur le UserControl spécifié, il a le titre spécifié et il est associé à la fenêtre d'application spécifiée.
	BeginInit	Infrastructure.
	Dispose	Exécute les tâches définies par l'application associées à la libération ou à la redéfinition des ressources non managées. (Hérité de IDisposable.)
	EndInit	Infrastructure.
	GetEnumerator	Retourne un énumérateur qui itère au sein de la collection. (Hérité de IEnumerable<CustomTaskPane>.)
	Remove	Supprime le CustomTaskPane spécifié de la CustomTaskPaneCollection.
	RemoveAt	Supprime le CustomTaskPane à l'index spécifié de la CustomTaskPaneCollection.

Début

Notes

Utilisez l'objet CustomTaskPaneCollection dans un complément d'application pour ajouter un volet de tâches personnalisé à une application, supprimer un volet de tâches personnalisé ou pour accéder à un volet de tâches personnalisé existant.Pour accéder à l'objet CustomTaskPaneCollection, utilisez le champ CustomTaskPanes de la classe ThisAddIn de votre projet de complément.Pour plus d'informations, consultez Programmation de compléments d'application.

Les volets de tâches sont des panneaux d'interface utilisateur généralement ancrés à l'un des côtés d'une fenêtre d'application.Pour plus d'informations sur la création de volets de tâches personnalisés, consultez Volets de tâches personnalisés.

[!REMARQUE]

Cette interface est implémentée par Visual Studio Tools pour Office Runtime. Elle n'est pas destinée à être implémentée dans votre code. Pour plus d'informations, consultez Vue d'ensemble de Visual Studio Tools pour Office Runtime.

Utilisation

Cette documentation décrit la version de ce type utilisée dans les projets Office qui ciblent .NET Framework 4 et .NET Framework 4.5. Dans les projets qui ciblent .NET Framework 3.5, ce type peut contenir d'autres membres, et les exemples de code qui y figurent sont susceptibles de ne pas fonctionner. Pour obtenir de la documentation sur ce type dans les projets ciblant .NET Framework 3.5, consultez la section de référence suivante dans la documentation Visual Studio 2008 : https://go.microsoft.com/fwlink/?LinkId=160658.

Exemples

L'exemple de code suivant montre comment créer un volet de tâches personnalisé à l'aide de la méthode Add(UserControl, String).L'exemple utilise également des propriétés de l'objet CustomTaskPane pour modifier l'apparence par défaut du volet Office personnalisé.Cet exemple de code fait partie d'un exemple plus complet, fourni pour 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);
}