Procedura dettagliata: Chiamare il codice da VBA in un progetto Visual C#

  • Articolo

Questa procedura dettagliata illustra come chiamare un metodo in una personalizzazione a livello di documento di Microsoft Office Excel da codice Visual Basic, Applications Edition (VBA) contenuto nella cartella di lavoro. La procedura comporta tre passaggi di base: aggiungere un metodo alla classe dell'elemento host Sheet1 , esporre il metodo al codice VBA nella cartella di lavoro e quindi chiamare il metodo dal codice VBA contenuto nella cartella di lavoro.

Si applica a: le informazioni contenute in questo argomento si applicano ai progetti a livello di documento per Excel e Word. Per altre informazioni, vedere Funzionalità disponibili per app Office lication e tipo di progetto.

Benché questa procedura dettagliata usi Excel in modo specifico, i concetti illustrati sono applicabili anche ai progetti a livello di documento di Word.

In questa procedura dettagliata sono illustrati i task seguenti:

  • Creazione di una cartella di lavoro che contiene codice VBA.

  • Concessione dell'attendibilità al percorso della cartella di lavoro tramite il Centro protezione di Excel.

  • Aggiunta di un metodo alla classe dell'elemento host Sheet1 .

  • Estrazione di un'interfaccia dalla classe dell'elemento host Sheet1 .

  • Esposizione del metodo al codice VBA.

  • Chiamata del metodo dal codice VBA.

Nota

I nomi o i percorsi visualizzati per alcuni elementi dell'interfaccia utente di Visual Studio nelle istruzioni seguenti potrebbero essere diversi nel computer in uso. La versione di Visual Studio in uso e le impostazioni configurate determinano questi elementi. Per altre informazioni, vedere Personalizzare l'IDE di Visual Studio.

Prerequisiti

Per completare questa procedura dettagliata, è necessario disporre dei componenti seguenti:

Creare una cartella di lavoro contenente codice VBA

Il primo passaggio consiste nel creare una cartella di lavoro con attivazione macro contenente una macro VBA semplice. Prima di potere esporre codice in una personalizzazione a VBA, è necessario che la cartella di lavoro includa già codice VBA. In caso contrario, Visual Studio non può modificare il progetto VBA per consentire al codice VBA di eseguire chiamate nell'assembly di personalizzazione.

Se si ha già una cartella di lavoro contenente codice VBA che si vuole usare, è possibile ignorare questo passaggio.

Per creare una cartella di lavoro contenente codice VBA

  1. Avviare Excel.

  2. Salvare il documento attivo come cartella di lavoro abilitata per le macro di Excel (*.xlsm) con il nome WorkbookWithVBA. Salvarla in un percorso a propria scelta, ad esempio, il desktop.

  3. Sulla barra multifunzione fare clic sulla scheda Sviluppatore .

    Nota

    Se la scheda Sviluppatore non viene mostrata, è necessario abilitarne la visualizzazione. Per altre informazioni, vedere Procedura: Visualizzare la scheda sviluppatore sulla barra multifunzione.

  4. Nel gruppo Codice , selezionare Visual Basic.

    Viene aperto Microsoft Visual Basic Editor.

  5. Nella finestra, Progetto , fare doppio clic su ThisWorkbook.

    Viene aperto il file di codice relativo all'oggetto ThisWorkbook .

  6. Aggiungere il codice VBA seguente al file di codice. Questo codice definisce una funzione semplice che non esegue alcuna operazione. L'unico scopo di questa funzione è garantire l'esistenza di un progetto VBA nella cartella di lavoro. Tale requisito dovrà essere soddisfatto in alcuni passaggi successivi di questa procedura dettagliata.

    Sub EmptySub()
End Sub

  7. Salvare il documento e uscire da Excel.

Creare il progetto

A questo punto è possibile creare un progetto a livello di documento di Excel che usa la cartella di lavoro con attivazione macro appena creata.

Per creare un nuovo progetto

  1. Avviare Visual Studio.

  2. Scegliere Nuovo dal menu Filee quindi fare clic su Progetto.

  3. Nel riquadro Modelli espandere, Visual C#quindi espandere Office/SharePoint.

  4. Selezionare il nodo Componenti aggiuntivi di Office .

  5. Nell'elenco di modelli di progetto selezionare il progetto Cartella di lavoro di Excel 2010 o Cartella di lavoro di Excel 2013 .

  6. Nella casella Nome digitare CallingCodeFromVBA.

  7. Fare clic su OK.

    Viene visualizzata la Creazione guidata progetto Visual Studio Tools per Office .

  8. Selezionare Copia un documento esistentee, nella casella Percorso completo del documento esistente , specificare il percorso della cartella di lavoro WorkbookWithVBA creata in precedenza. Se si ha già una cartella di lavoro con attivazione macro che si vuole usare, specificare invece il percorso di questa cartella di lavoro.

  9. Fare clic su Fine.

    Visual Studio apre la cartella di lavoro WorkbookWithVBA nella finestra di progettazione e aggiunge il progetto CallingCodeFromVBA a Esplora soluzioni.

Considerare attendibile il percorso della cartella di lavoro

Per poter esporre il codice contenuto nella soluzione al codice VBA contenuto nella cartella di lavoro, è necessario che quest'ultima sia impostata come attendibile per l'esecuzione. È possibile eseguire questa operazione in diversi modi. In questa esercitazione si completerà questa attività concedendo l'attendibilità al percorso della cartella di lavoro nel Centro protezione in Excel.

Per concedere l'attendibilità al percorso della cartella di lavoro

  1. Avviare Excel.

  2. Scegliere la scheda File .

  3. Fare clic sul pulsante Opzioni di Excel .

  4. Nel riquadro delle categorie fare clic su Centro protezione.

  5. Nel riquadro dei dettagli fare clic su Impostazioni Centro protezione.

  6. Nel riquadro delle categorie fare clic su Percorsi attendibili.

  7. Nel riquadro dei dettagli fare clic su Aggiungi nuovo percorso.

  8. Nella finestra di dialogo Percorso attendibile di Microsoft Office passare alla cartella contenente il progetto CallingCodeFromVBA .

  9. Selezionare Considera attendibili anche le sottocartelle di questo percorso.

  10. Nella finestra di dialogo Percorso attendibile di Microsoft Office fare clic su OK.

  11. Scegliere OK nella finestra di dialogo Centro protezione.

  12. Scegliere OK nella finestra di dialogo Opzioni di Excel.

  13. Uscire da Excel.

Aggiungere un metodo alla classe Sheet1

Ora che il progetto VBA è configurato, aggiungere un metodo pubblico alla classe dell'elemento host Sheet1 che è possibile chiamare dal codice VBA.

Per aggiungere un metodo alla classe Sheet1

  1. In Esplora soluzionifare clic con il pulsante destro del mouse su Sheet1.cs, quindi scegliere Visualizza codice.

    Il file Sheet1.cs verrà aperto nell'editor del codice.

  2. Aggiungere il codice seguente alla classe Sheet1 . Il metodo CreateVstoNamedRange crea un nuovo oggetto NamedRange in corrispondenza dell'intervallo specificato. Verrà creato anche un gestore eventi per l'evento Selected della classe NamedRange. Più avanti nella procedura dettagliata il metodo CreateVstoNamedRange verrà chiamato dal codice VBA contenuto nel documento.

    private Microsoft.Office.Tools.Excel.NamedRange namedRange1;

public void CreateVstoNamedRange(Excel.Range range, string name)
{
    if (!this.Controls.Contains(name))
    {
        namedRange1 = this.Controls.AddNamedRange(range, name);
        namedRange1.Selected += new Excel.DocEvents_SelectionChangeEventHandler(
                namedRange1_Selected);
    }
    else
    {
        MessageBox.Show("A named range with this specific name " +
            "already exists on the worksheet.");
    }
}

private void namedRange1_Selected(Microsoft.Office.Interop.Excel.Range Target)
{
    MessageBox.Show("This named range was created by Visual Studio " +
        "Tools for Office.");
}

  3. Aggiungere il seguente metodo alla classe Sheet1. Questo metodo esegue l'override del metodo GetAutomationObject per restituire l'istanza corrente della classe Sheet1 .

    protected override object GetAutomationObject()
{
    return this;
}

  4. Applicare gli attributi seguenti prima della prima riga della dichiarazione della classe Sheet1 . Questi attributi rendono visibile la classe a COM, ma senza generare un'interfaccia di classe.

    [System.Runtime.InteropServices.ComVisible(true)]
[System.Runtime.InteropServices.ClassInterface(
    System.Runtime.InteropServices.ClassInterfaceType.None)]

Estrarre un'interfaccia per la classe Sheet1

Prima di potere esporre il metodo CreateVstoNamedRange al codice VBA, è necessario creare un'interfaccia pubblica che definisce questo metodo ed esporre l'interfaccia a COM.

Per estrarre un'interfaccia per la classe Sheet1

  1. Nel file di codice Sheet1.cs fare clic in un punto qualsiasi nella classe Sheet1 .

  2. Scegliere Estrai interfaccia dal menu Effettua refactoring.

  3. Nella casella Selezionare i membri pubblici per l'interfaccia della finestra di dialogo Estrai interfaccia fare clic sulla voce relativa al metodo CreateVstoNamedRange .

  4. Fare clic su OK.

    Visual Studio genera una nuova interfaccia denominata ISheet1e modifica la definizione della Sheet1 classe in modo che implementi l'interfaccia ISheet1 . Visual Studio apre anche il file ISheet1.cs nell'editor di codice.

  5. Nel file ISheet1.cs sostituire la dichiarazione di interfaccia ISheet1 con il codice seguente. Questo codice rende pubblica l'interfaccia ISheet1 e applica l'attributo ComVisibleAttribute per rendere visibile l'interfaccia a COM.

    [System.Runtime.InteropServices.ComVisible(true)]
public interface ISheet1
{
    void CreateVstoNamedRange(Microsoft.Office.Interop.Excel.Range range, string name);
}

  6. Compilare il progetto.

Esporre il metodo al codice VBA

Per esporre il metodo CreateVstoNamedRange al codice VBA nella cartella di lavoro, impostare la proprietà ReferenceAssemblyFromVbaProject dell'elemento host Sheet1 su True.

Per esporre il metodo al codice VBA

  1. In Esplora soluzionifare doppio clic su Sheet1.cs.

    Il file WorkbookWithVBA verrà aperto nella finestra di progettazione, con Sheet1 visibile.

  2. Nella finestra Proprietà selezionare la proprietà ReferenceAssemblyFromVbaProject e modificarne il valore impostandola su True.

  3. Fare clic su OK nel messaggio visualizzato.

  4. Compilare il progetto.

Chiamare il metodo dal codice VBA

A questo punto è possibile chiamare il metodo CreateVstoNamedRange dal codice VBA contenuto nella cartella di lavoro.

Nota

Questa procedura dettagliata prevede l'aggiunta di codice VBA alla cartella di lavoro durante l'esecuzione del debug del progetto. Se si ricompila il progetto, il codice VBA aggiunto a questo documento verrà sovrascritto. Infatti, Visual Studio sostituisce il documento contenuto nella cartella dell'output di compilazione con una copia del documento contenuto nella cartella del progetto principale. Se si vuole salvare il codice VBA è possibile copiarlo nel documento contenuto nella cartella del progetto. Per altre informazioni, vedere Combinare personalizzazioni a livello di documento e VBA.

Per chiamare il metodo dal codice VBA

  1. Premere F5 per eseguire il progetto.

  2. Nella scheda Sviluppatore fare clic su Visual Basic nel gruppo Codice.

    Viene aperto Microsoft Visual Basic Editor.

  3. Scegliere Modulo dal menu Inserisci.

  4. Aggiungere al nuovo modulo il codice seguente.

    Questo codice chiama il metodo CreateTable nell'assembly di personalizzazione. La macro accede a questo metodo usando il metodo globale GetManagedClass per accedere alla classe Sheet1 dell'elemento host esposta al codice VBA. Il metodo GetManagedClass è stato generato automaticamente nel passaggio precedente della procedura dettagliata in cui è stata impostata la proprietà ReferenceAssemblyFromVbaProject .

    Sub CallVSTOMethod()
    Dim VSTOSheet1 As CallingCodeFromVBA.Sheet1
    Set VSTOSheet1 = GetManagedClass(Sheet1)
    Call VSTOSheet1.CreateVstoNamedRange(Sheet1.Range("A1"), "VstoNamedRange")
End Sub

  5. Premere F5.

  6. Nella cartella di lavoro aperta fare clic sulla cella A1 in Sheet1. Verificare che venga visualizzata la finestra di messaggio.

  7. Uscire da Excel senza salvare le modifiche.

Passaggi successivi

Altre informazioni su come chiamare elementi di codice in soluzioni Office da VBA sono disponibili negli argomenti seguenti:

Contenuto correlato