Interfaccia CustomTaskPaneCollection

Articolo
05/17/2013

Rappresenta una raccolta di riquadri attività personalizzati in un'applicazione di Microsoft Office.

Spazio dei nomi: Microsoft.Office.Tools
Assembly: Microsoft.Office.Tools.Common (in Microsoft.Office.Tools.Common.dll)

Sintassi

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

Il tipo CustomTaskPaneCollection espone i seguenti membri.

Proprietà

	Nome	Descrizione
	Count	Ottiene il numero di oggetti CustomTaskPane inclusi nella classe CustomTaskPaneCollection corrente.
	Item	Ottiene l'oggetto CustomTaskPane in corrispondenza dell'indice specificato.

In alto

Metodi

	Nome	Descrizione
	Add(UserControl, String)	Crea un nuovo oggetto CustomTaskPane e lo aggiunge alla classe CustomTaskPaneCollection corrente.Il riquadro attività personalizzato è basato sulla classe UserControl specificata e ha il titolo specificato.
	Add(UserControl, String, Object)	Crea un nuovo oggetto CustomTaskPane e lo aggiunge alla classe CustomTaskPaneCollection corrente.Il riquadro attività personalizzato è basato sulla classe UserControl specificata, ha il titolo specificato ed è associato alla finestra dell'applicazione specificata.
	BeginInit	Infrastruttura.
	Dispose	Esegue le attività definite dall'applicazione associate alla versione, il rilascio, o reimpostare le risorse non gestite. (Ereditato da IDisposable)
	EndInit	Infrastruttura.
	GetEnumerator	Restituisce un enumeratore che scorre la raccolta. (Ereditato da IEnumerable<CustomTaskPane>)
	Remove	Rimuove l'oggetto CustomTaskPane specificato dall'oggetto CustomTaskPaneCollection.
	RemoveAt	Rimuove l'oggetto CustomTaskPane in corrispondenza dell'indice specificato della classe CustomTaskPaneCollection.

In alto

Note

Utilizzare l'oggetto CustomTaskPaneCollection in un componente aggiuntivo a livello di applicazione per aggiungere un riquadro attività personalizzato a un'applicazione, rimuovere un riquadro attività personalizzato oppure accedere a un riquadro attività esistente.Per accedere all'oggetto CustomTaskPaneCollection, utilizzare il campo CustomTaskPanes della classe ThisAddIn nel progetto del componente aggiuntivo.Per ulteriori informazioni, vedere Programmazione di componenti aggiuntivi a livello di applicazione.

I riquadri attività sono pannelli dell'interfaccia utente in genere ancorati a un lato della finestra di un'applicazione.Per ulteriori informazioni sulla creazione di riquadri attività personalizzati, vedere Riquadri attività personalizzati.

[!NOTA]

Questa interfaccia è implementata dal Runtime di Visual Studio Tools per Office. Non deve essere implementata nel codice. Per ulteriori informazioni, vedere Cenni preliminari su Visual Studio Tools per Office Runtime.

Utilizzo

Nella presente documentazione viene descritta la versione di questo tipo utilizzata nei progetti di Office destinati a .NET Framework 4 e .NET Framework 4.5. Nei progetti destinati a .NET Framework 3.5 questo tipo potrebbe avere membri diversi e gli esempi di codice forniti per il tipo potrebbero non funzionare. Per la documentazione relativa a questo tipo nei progetti destinati a .NET Framework 3.5, vedere la sezione di riferimento seguente nella documentazione di Visual Studio 2008: https://go.microsoft.com/fwlink/?LinkId=160658.

Esempi

Nell'esempio di codice seguente viene illustrato come creare un riquadro attività personalizzato utilizzando il metodo Add(UserControl, String).Nell'esempio vengono inoltre utilizzate proprietà dell'oggetto CustomTaskPane per modificare l'aspetto predefinito del riquadro attività personalizzato.Questo esempio di codice fa parte di un esempio più esaustivo fornito per 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);
}