Tutorial: Agregar controles a una hoja de cálculo en tiempo de ejecución en un proyecto en el nivel de la aplicación

Puede agregar controles a una hoja de cálculo abierta mediante un complemento de Excel.En este tutorial se muestra cómo utilizar la cinta de opciones para permitir que los usuarios agreguen un Button, un NamedRange y un ListObject a una hoja de cálculo.Para obtener más información, vea Agregar controles a documentos de Office en tiempo de ejecución.

La información deSe aplica a: The en este tema se aplica a los proyectos de nivel de aplicación de Excel 2010.Para obtener más información, vea Características disponibles por aplicación y tipo de proyecto de Office.

En este tutorial se muestran las tareas siguientes:

Proporcionar una interfaz de usuario para agregar controles a la hoja de cálculo.
Agregar controles a la hoja de cálculo.
Quitar controles de la hoja de cálculo.

[!NOTA]

Es posible que su equipo muestre nombres o ubicaciones diferentes para algunos de los elementos de la interfaz de usuario de Visual Studio incluidos en las instrucciones siguientes. La edición de Visual Studio que se tenga y la configuración que se utilice determinan estos elementos. Para obtener más información, vea Valores de configuración de Visual Studio.

Requisitos previos

Necesita los componentes siguientes para completar este tutorial:

Una edición de Visual Studio 2012 que incluye las herramientas para desarrolladores de Microsoft Office. Para obtener más información, vea [Configurar un equipo para desarrollar soluciones de Office](bb398242\(v=vs.110\).md).

Excel 2013 o Excel 2010.

Crear un nuevo proyecto de complemento de Excel

Comience por crear un proyecto de complemento de Excel.

Para crear un nuevo proyecto de complemento de Excel

En Visual Studio, cree un proyecto de complemento de Excel con el nombre ExcelDynamicControls.Para obtener más información, vea Cómo: Crear proyectos de Office en Visual Studio.
Agregue una referencia al ensamblado Microsoft.Office.Tools.Excel.v4.0.Utilities.dll .Esta referencia es obligatoria para agregar mediante programación un control Windows Forms a una hoja de cálculo posteriormente en este tutorial.

Proporcionar una interfaz de usuario para agregar controles a una hoja de cálculo

Agregue una pestaña personalizada a la cinta de opciones de Excel.Los usuarios pueden activar las casillas de la ficha para agregar controles a una hoja de cálculo.

Para proporcionar una interfaz de usuario para agregar controles a una hoja de cálculo

En el menú Proyecto, haga clic en Agregar nuevo elemento.
En el cuadro de diálogo Agregar nuevo elemento, seleccione Cinta (diseñador visual) y haga clic en Agregar.

Un archivo denominado CustomerRibbon.cs o CustomerRibbon.vb se abre en el Diseñador de la cinta de opciones y muestra una ficha y un grupo predeterminados.
Desde la ficha Controles de la cinta de opciones de Office del Cuadro de herramientas, arrastre un control CheckBox a group1.
Haga clic en CheckBox1 para seleccionarlo.
En la ventana Propiedades, cambie las siguientes propiedades.

Propiedad

Valor

Nombre

Button

Etiqueta

Button
Agregue una segunda casilla a group1 y, a continuación, cambie las propiedades siguientes.

Propiedad

Valor

Nombre

NamedRange

Etiqueta

NamedRange
Agregue una tercera casilla a group1 y, a continuación, cambie las propiedades siguientes.

Propiedad

Valor

Nombre

ListObject

Etiqueta

ListObject

Propiedad	Valor
Nombre	Button
Etiqueta	Button

Propiedad	Valor
Nombre	NamedRange
Etiqueta	NamedRange

Propiedad	Valor
Nombre	ListObject
Etiqueta	ListObject

Agregar controles a la hoja de cálculo

Los controles administrados únicamente se pueden agregar a los elementos host que actúan como contenedores.Dado que los proyectos de complemento funcionan con cualquier libro abierto, el complemento convierte la hoja de cálculo en un elemento host, u obtiene un elemento host existente, antes de agregar el control.Agregue código a los controladores de eventos "click" de cada control para generar un elemento host Worksheet basado en la hoja de cálculo abierta.A continuación, agregue un Button, un NamedRangey un ListObject a la selección actual de la hoja de cálculo.

Para agregar controles a una hoja de cálculo

En el Diseñador de la cinta de opciones, haga doble clic en Button.

El controlador de eventos Click de la casilla Button se abre en el Editor de código.

Reemplace el controlador de evento Button_Click con el código siguiente.

Este código utiliza el método GetVstoObject para obtener un elemento host que representa la primera hoja de cálculo del libro y, a continuación, agrega un control Button a la celda que está seleccionada.

Private Sub Button_Click(ByVal sender As System.Object, _
    ByVal e As Microsoft.Office.Tools.Ribbon.RibbonControlEventArgs) _
        Handles Button.Click

    Dim NativeWorksheet As Microsoft.Office.Interop.Excel.Worksheet =
        Globals.ThisAddIn.Application.ActiveWorkbook.Worksheets(1)

    Dim worksheet As Microsoft.Office.Tools.Excel.Worksheet =
        Globals.Factory.GetVstoObject(NativeWorksheet)


    Dim buttonName As String = "MyButton"

    If CType(sender, RibbonCheckBox).Checked Then
        Dim selection As Excel.Range = Globals.ThisAddIn.Application.Selection
        If Not (selection Is Nothing) Then
            Dim button As New Microsoft.Office.Tools.Excel.Controls.Button()
            worksheet.Controls.AddControl(button, selection, buttonName)
        End If
    Else
        worksheet.Controls.Remove(buttonName)
    End If
End Sub

private void Button_Click(object sender, RibbonControlEventArgs e)
{
    Worksheet worksheet = Globals.Factory.GetVstoObject(
        Globals.ThisAddIn.Application.ActiveWorkbook.Worksheets[1]);


    string buttonName = "MyButton";

    if (((RibbonCheckBox)sender).Checked)
    {
        Excel.Range selection = Globals.ThisAddIn.Application.Selection as Excel.Range;
        if (selection != null)
        {
            Microsoft.Office.Tools.Excel.Controls.Button button =
                new Microsoft.Office.Tools.Excel.Controls.Button();
            worksheet.Controls.AddControl(button, selection, buttonName);
        }
    }
    else
    {
        worksheet.Controls.Remove(buttonName);
    }
}

En el Explorador de soluciones, seleccione Ribbon1.cs o Ribbon1.vb.
En el menú Ver, haga clic en Diseñador.
En el Diseñador de la cinta de opciones, haga doble clic en NamedRange.

Reemplace el controlador de evento NamedRange_Click con el código siguiente.

Este código utiliza el método GetVstoObject para obtener un elemento host que representa la primera hoja de cálculo del libro y, a continuación, define un control NamedRange para la celda o celdas que están seleccionadas.

Private Sub NamedRange_Click(ByVal sender As System.Object, _
    ByVal e As Microsoft.Office.Tools.Ribbon.RibbonControlEventArgs) _
        Handles NamedRange.Click

    Dim NativeWorksheet As Microsoft.Office.Interop.Excel.Worksheet =
        Globals.ThisAddIn.Application.ActiveWorkbook.Worksheets(1)

    Dim worksheet As Microsoft.Office.Tools.Excel.Worksheet =
        Globals.Factory.GetVstoObject(NativeWorksheet)

    Dim rangeName As String = "MyNamedRange"

    If CType(sender, RibbonCheckBox).Checked Then
        Dim selection As Excel.Range = Globals.ThisAddIn.Application.Selection
        If Not (selection Is Nothing) Then
            Dim namedRange As NamedRange = _
                worksheet.Controls.AddNamedRange(selection, rangeName)
        End If
    Else
        worksheet.Controls.Remove(rangeName)
    End If
End Sub

private void NamedRange_Click(object sender, RibbonControlEventArgs e)
{
    Worksheet worksheet = Globals.Factory.GetVstoObject(
        Globals.ThisAddIn.Application.ActiveWorkbook.Worksheets[1]);


    string Name = "MyNamedRange";

    if (((RibbonCheckBox)sender).Checked)
    {
        Excel.Range selection = Globals.ThisAddIn.Application.Selection as Excel.Range;
        if (selection != null)
        {
            worksheet.Controls.AddNamedRange(selection, Name);
        }
    }
    else
    {
        worksheet.Controls.Remove(Name);
    }
}

En el Diseñador de la cinta de opciones, haga doble clic en ListObject.

Reemplace el controlador de evento ListObject_Click con el código siguiente.

Este código utiliza el método GetVstoObject para obtener un elemento host que representa la primera hoja de cálculo del libro y, a continuación, define un control ListObject para la celda o celdas que están seleccionadas.

Private Sub ListObject_Click(ByVal sender As System.Object, _
    ByVal e As Microsoft.Office.Tools.Ribbon.RibbonControlEventArgs) _
        Handles ListObject.Click

    Dim NativeWorksheet As Microsoft.Office.Interop.Excel.Worksheet =
        Globals.ThisAddIn.Application.ActiveWorkbook.Worksheets(1)

    Dim worksheet As Microsoft.Office.Tools.Excel.Worksheet =
        Globals.Factory.GetVstoObject(NativeWorksheet)


    Dim listObjectName As String = "MyListObject"

    If CType(sender, RibbonCheckBox).Checked Then
        Dim selection As Excel.Range = _
            Globals.ThisAddIn.Application.Selection
        If Not (selection Is Nothing) Then
            worksheet.Controls.AddListObject(selection, listObjectName)
        End If
    Else
        worksheet.Controls.Remove(listObjectName)
    End If
End Sub

private void ListObject_Click(object sender, RibbonControlEventArgs e)
{
    Worksheet worksheet = Globals.Factory.GetVstoObject(
        Globals.ThisAddIn.Application.ActiveWorkbook.Worksheets[1]);


    string listObjectName = "MyListObject";

    if (((RibbonCheckBox)sender).Checked)
    {
        Excel.Range selection = Globals.ThisAddIn.Application.Selection as Excel.Range;
        if (selection != null)
        {
            worksheet.Controls.AddListObject(selection, listObjectName);
        }
    }
    else
    {
        worksheet.Controls.Remove(listObjectName);
    }
}

Agregue las siguientes instrucciones a la parte superior del archivo de código de la cinta de opciones.

Imports Excel = Microsoft.Office.Interop.Excel
Imports Microsoft.Office.Tools.Excel
Imports Microsoft.Office.Tools.Excel.Extensions

using Excel = Microsoft.Office.Interop.Excel;
using Microsoft.Office.Tools.Excel;
using Microsoft.Office.Tools.Excel.Extensions;

Quitar controles de la hoja de cálculo

No se conservan los controles cuando se guarda y se cierra la hoja de cálculo.Debería quitar mediante programación todos los controles generados de formularios Windows Forms antes de guardar la hoja de cálculo, o solamente aparecerá un contorno del control cuando se vuelva a abrir el libro.Agregue código al evento WorkbookBeforeSave que quita los controles de formularios Windows Forms de la colección de controles del elemento host generado.Para obtener más información, vea Guardar controles dinámicos en documentos de Office.

Para quitar controles de la hoja de cálculo

En el Explorador de soluciones, seleccione ThisAddIn.cs o ThisAddIn.vb.
En el menú Ver, haga clic en Código.

Agregue el método siguiente a la clase ThisAddIn.Este código obtiene la primera hoja de cálculo del libro y, a continuación, utiliza el método HasVstoObject para comprobar si la hoja tiene un objeto de hoja de cálculo generado.Si el objeto de hoja de cálculo generado tiene controles, el código obtiene ese objeto de hoja de cálculo, recorre en iteración la colección del control y quita los controles.

Sub Application_WorkbookBeforeSave _
    (ByVal workbook As Microsoft.Office.Interop.Excel.Workbook, _
     ByVal SaveAsUI As Boolean, ByRef Cancel As Boolean) _
     Handles Application.WorkbookBeforeSave

    Dim worksheet As Excel.Worksheet = workbook.Worksheets(1)

    If Globals.Factory.HasVstoObject(worksheet) And
        Globals.Factory.GetVstoObject(worksheet).Controls.Count > 0 Then
        Dim vstoWorksheet As Worksheet = Globals.Factory.GetVstoObject(worksheet)

        While vstoWorksheet.Controls.Count > 0
            Dim vstoControl As Object = vstoWorksheet.Controls(0)
            vstoWorksheet.Controls.Remove(vstoControl)
        End While
    End If
End Sub

void Application_WorkbookBeforeSave(Microsoft.Office.Interop.Excel.Workbook workbook, 
    bool SaveAsUI, ref bool Cancel)
{
    Excel.Worksheet worksheet =
        workbook.Worksheets[1] as Excel.Worksheet;

    if (Globals.Factory.HasVstoObject(worksheet) && 
        Globals.Factory.GetVstoObject(worksheet).Controls.Count > 0)
    {
        Worksheet vstoWorksheet = Globals.Factory.GetVstoObject(worksheet);



        while (vstoWorksheet.Controls.Count > 0)
        {
            object vstoControl = vstoWorksheet.Controls[0];
            vstoWorksheet.Controls.Remove(vstoControl);
        }

    }
}

En C#, debe crear un controlador de eventos para el evento WorkbookBeforeSave.Puede colocar este código en el método ThisAddIn_Startup.Para obtener información sobre cómo crear controladores de eventos, vea Cómo: Crear controladores de eventos en proyectos de Office.Reemplace el método ThisAddIn_Startup por el código siguiente.
```
private void ThisAddIn_Startup(object sender, System.EventArgs e)
{
    this.Application.WorkbookBeforeSave += 
        new Microsoft.Office.Interop.Excel.AppEvents_WorkbookBeforeSaveEventHandler
            (Application_WorkbookBeforeSave);
}
```

Comprobar la solución

Agregue controles a una hoja de cálculo seleccionándolos en una ficha personalizada de la cinta de opciones.Al guardar la hoja de cálculo, se quitan estos controles.

Para probar la solución.

Presione F5 para ejecutar el proyecto.
Seleccione cualquier celda de Sheet1.
Haga clic en la ficha Complementos.
En el grupo group1, haga clic en Button.

Aparecerá un botón en la celda seleccionada.
Seleccione una celda diferente en Sheet1.
En el grupo group1, haga clic en NamedRange.

Se definirá un rango con nombre para la celda seleccionada.
Seleccione una serie de celdas en Sheet1.
En el grupo group1, haga clic en ListObject.

Se agregará un objeto de lista a las celdas seleccionadas.
Guarde la hoja de cálculo.

Los controles que agregó a Sheet1 ya no aparecen.

Pasos siguientes

Para obtener más información sobre controles en los proyectos de complemento de Excel, vea este tema:

Para obtener información sobre cómo guardar los controles en una hoja de cálculo, vea el ejemplo Excel Add-In Dynamic Controls en Ejemplos y tutoriales del desarrollo de Office.