CustomTaskPaneCollection (Interfaz)

Artículo
08/10/2011

Representa una colección de paneles de tareas personalizados en una aplicación de Microsoft Office.

Espacio de nombres: Microsoft.Office.Tools
Ensamblado: Microsoft.Office.Tools.Common (en Microsoft.Office.Tools.Common.dll)

Sintaxis

'Declaración
<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

El tipo CustomTaskPaneCollection expone los siguientes miembros.

Propiedades

	Nombre	Descripción
	Count	Obtiene el número de objetos CustomTaskPane de la colección CustomTaskPaneCollection actual.
	Item	Obtiene el CustomTaskPane en el índice especificado.

Arriba

Métodos

	Nombre	Descripción
	Add(UserControl, String)	Crea un nuevo CustomTaskPane y lo agrega a la CustomTaskPaneCollection actual.El panel de tareas personalizado se basa en el UserControl especificado y tiene el título especificado.
	Add(UserControl, String, Object)	Crea un nuevo CustomTaskPane y lo agrega a la CustomTaskPaneCollection actual.El panel de tareas personalizado se basa en el UserControl especificado, que tiene el título especificado y está asociado a la ventana de aplicación especificada.
	BeginInit	Infraestructura.
	Dispose	Realiza tareas definidas por la aplicación asociadas a la liberación o al restablecimiento de recursos no administrados. (Se hereda de IDisposable).
	EndInit	Infraestructura.
	GetEnumerator()	Devuelve un enumerador que recorre en iteración la colección. (Se hereda de IEnumerable<CustomTaskPane>).
	GetEnumerator()	Devuelve un enumerador que recorre en iteración una colección. (Se hereda de IEnumerable).
	Remove	Quita el CustomTaskPane especificado de CustomTaskPaneCollection.
	RemoveAt	Quita el CustomTaskPane situado en el índice especificado de CustomTaskPaneCollection.

Arriba

Comentarios

Utilice el objeto CustomTaskPaneCollection en un complemento de nivel de aplicación para agregar un panel de tareas personalizado a una aplicación, quitar un panel de tareas personalizado o tener acceso a uno existente. Para obtener acceso al objeto CustomTaskPaneCollection, utilice el campo CustomTaskPanes de la clase ThisAddIn en el proyecto de complemento. Para obtener más información, vea Programar complementos de nivel de aplicación.

Los paneles de tareas son paneles de interfaz de usuario que normalmente están acoplados a un lado de una ventana de aplicación. Para obtener más información acerca de cómo se crean los paneles de tareas personalizados, vea Información general sobre los paneles de tareas personalizados.

Nota

Esta interfaz está implementada por el motor en tiempo de ejecución de Visual Studio Tools para Office. No está prevista su implementación en el código. Para obtener más información, vea Información general sobre el Motor en tiempo de ejecución de Microsoft Visual Studio Tools para Office.

Uso

Esta documentación describe la versión de este tipo que se utiliza en los proyectos de Office destinados a .NET Framework 4. En los proyectos destinados a .NET Framework 3.5, este tipo puede tener miembros diferentes y es posible que los ejemplos de código proporcionados para dicho tipo no funcionen. Para informarse sobre este tipo en los proyectos destinados a .NET Framework 3.5, vea la siguiente sección de referencia en la documentación de Visual Studio 2008: https://go.microsoft.com/fwlink/?LinkId=160658.

Ejemplos

El ejemplo de código siguiente muestra cómo crear un panel de tareas personalizado mediante el método Add(UserControl, String). El ejemplo también utiliza propiedades del objeto CustomTaskPane para modificar la apariencia predeterminada del panel de tareas personalizado. Este ejemplo de código forma parte de un ejemplo más extenso proporcionado para 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);
}