Compartir a través de

CustomTaskPaneCollection.Add (Método) (UserControl, String)

  • Artículo

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.

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

Sintaxis

'Declaración
Function Add ( _
    control As UserControl, _
    title As String _
) As CustomTaskPane

CustomTaskPane Add(
    UserControl control,
    string title
)

Parámetros

  • title
    Tipo: System.String
    Texto que aparece en la barra de título del nuevo panel de tareas personalizado.

Valor devuelto

Tipo: Microsoft.Office.Tools.CustomTaskPane
CustomTaskPane que representa el nuevo panel de tareas personalizado.

Excepciones

Excepción Condición
ArgumentNullException

El valor de control o title es nullreferencia null (Nothing en Visual Basic).
ObjectDisposedException

Ya se ha llamado al método Dispose() en CustomTaskPaneCollection.

Comentarios

Utilice este método para crear un nuevo CustomTaskPane que esté asociado a la ventana activa de la aplicación de Microsoft Office.

Aunque un objeto CustomTaskPaneCollection es una colección de objetos CustomTaskPane, el método Add acepta objetos UserControl en lugar de objetos CustomTaskPane. Para obtener más información, vea Información general sobre los paneles de tareas personalizados.

Si desea especificar una ventana determinada y asociarla con el panel de tareas personalizado, utilice el método Add(UserControl, String, Object).

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

Seguridad de .NET Framework

Vea también

Referencia

CustomTaskPaneCollection Interfaz

Add (Sobrecarga)

Microsoft.Office.Tools (Espacio de nombres)