Interfejs CustomTaskPaneCollection

Artykuł
01/08/2014

Reprezentuje kolekcję niestandardowe okienka zadań w aplikacji pakietu Microsoft Office.

Przestrzeń nazw: Microsoft.Office.Tools
Zestaw: Microsoft.Office.Tools.Common (w Microsoft.Office.Tools.Common.dll)

Składnia

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

Typ CustomTaskPaneCollection uwidacznia następujące elementy członkowskie.

Właściwości

	Nazwa	Opis
	Count	Pobiera numer CustomTaskPane obiektów w bieżącym CustomTaskPaneCollection.
	Item	Pobiera CustomTaskPane pod określonym indeksem.

Początek

Metody

	Nazwa	Opis
	Add(UserControl, String)	Tworzy nowy CustomTaskPane i dodaje go do bieżącego CustomTaskPaneCollection.Niestandardowe okienko zadań jest oparta na określonym UserControl i ma określony tytuł.
	Add(UserControl, String, Object)	Tworzy nowy CustomTaskPane i dodaje go do bieżącego CustomTaskPaneCollection.Niestandardowe okienko zadań jest oparta na określonym UserControl, ma określony tytuł i wiąże się z okna określonej aplikacji.
	BeginInit	Infrastruktura.
	Dispose	Wykonuje zadania zdefiniowane przez aplikację skojarzone z uwalnianiem, zwalnianiem lub resetowaniem niezarządzanych zasobów. (Odziedziczone z IDisposable).
	EndInit	Infrastruktura.
	GetEnumerator	Zwraca modułu wyliczającego, który dokonuje iteracji w kolekcji. (Odziedziczone z IEnumerable<CustomTaskPane>).
	Remove	Usuwa określony CustomTaskPane z CustomTaskPaneCollection.
	RemoveAt	Usuwa CustomTaskPane pod określonym indeksem z CustomTaskPaneCollection.

Początek

Uwagi

Użycie CustomTaskPaneCollection obiektu w poziomie aplikacji dodatek do dodać niestandardowe okienko zadań do aplikacji, usunąć niestandardowe okienko zadań lub dostępu do istniejących niestandardowe okienko zadań.Do dostępu do CustomTaskPaneCollection obiektów, użyj CustomTaskPanes pole ThisAddIn klasy w projekcie dodatek.Aby uzyskać więcej informacji, zobacz Programowanie dodatków na poziomie aplikacji.

Panele interfejsu użytkownika, które zazwyczaj są zadokowane z jednej strony okna aplikacji są okienka zadań.Aby uzyskać więcej informacji na temat tworzenia niestandardowych okienek zadań, zobacz Niestandardowe okienka zadań.

[!UWAGA]

Ten interfejs jest implementowany przez Visual Studio Tools for Office Runtime. Nie jest on przeznaczony do implementacji w kodzie. Aby uzyskać więcej informacji, zobacz Visual Studio Tools for Office Runtime ― Przegląd.

Użycie

W dokumentacji opisano wersję typu używanego w projektach dla pakietu Office przeznaczonych do pracy z programem .NET Framework 4 i .NET Framework 4.5. W projektach przeznaczonych do pracy z programem .NET Framework 3.5 ten typ może mieć inne elementy członkowskie, a przykładowy kod podany dla tego typu może nie działać. Aby uzyskać dokumentację tego typu używanego w projektach przeznaczonych do działania z programem .NET Framework 3.5, zobacz następującą sekcję informacyjną w dokumentacji programu Visual Studio 2008: https://go.microsoft.com/fwlink/?LinkId=160658.

Przykłady

Poniższy przykład kodu pokazuje, jak utworzyć niestandardowe okienko zadań za pomocą Add(UserControl, String) metody.W przykładzie użyto również właściwości CustomTaskPane obiekt, aby modyfikować domyślnego wyglądu niestandardowe okienko zadań.Poniższy przykład kodu jest częścią większy przykład przewidziane 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);
}