Procedura dettagliata: Creare il primo componente aggiuntivo VSTO per Word

  • Articolo

Questa procedura dettagliata introduttiva illustra come creare un componente aggiuntivo VSTO per Microsoft Office Word. Le funzionalità create in questo tipo di soluzione sono disponibili per l'applicazione, indipendentemente da quali documenti vengano aperti.

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

In questa procedura dettagliata sono illustrati i task seguenti:

  • Creazione di un progetto di componente aggiuntivo VSTO di Word.

  • Scrittura di codice che usa il modello a oggetti di Word per aggiungere testo a un documento quando quest'ultimo viene salvato.

  • Creazione ed esecuzione del progetto a scopo di test.

  • Pulizia del progetto completato, per fare in modo che il componente aggiuntivo VSTO non venga più eseguito automaticamente nel computer di sviluppo.

    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.

Prerequisiti

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

Creare il progetto

Per creare un nuovo progetto per un componente aggiuntivo VSTO di Word in Visual Studio

  1. Avviare Visual Studio.

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

  3. Nel riquadro dei modelli, espandere Visual C# o Visual Basic, quindi espandere Office/SharePoint.

  4. Nel nodo Office/SharePoint espanso, selezionare il nodo Componenti aggiuntivi di Office .

  5. Nell'elenco dei modelli di progetto scegliere un progetto del componente aggiuntivo VSTO di Word.

  6. Nella casella Nome digitare FirstWordAddIn.

  7. Fare clic su OK.

    Visual Studio crea il progetto FirstWordAddIn e apre il file di codice ThisAddIn nell'editor.

Scrivere codice per aggiungere testo al documento salvato

Aggiungere quindi codice al file di codice ThisAddIn. Il nuovo codice usa il modello a oggetti di Word per aggiungere testo boilerplate in ogni documento salvato. Per impostazione predefinita, il file di codice ThisAddIn contiene il seguente codice generato:

  • Una definizione parziale della classe ThisAddIn . Questa classe fornisce un punto di ingresso per il codice e fornisce l'accesso al modello a oggetti di Word. Per altre informazioni, vedere Programmare componenti aggiuntivi VSTO. Il resto della ThisAddIn classe è definito in un file di codice nascosto che non è consigliabile modificare.

  • I gestori eventi ThisAddIn_Startup e ThisAddIn_Shutdown . Questi gestori eventi vengono chiamati quando Word carica e scarica il componente aggiuntivo VSTO. Usare questi gestori eventi per inizializzare il componente aggiuntivo VSTO al momento del caricamento e per eseguire la pulizia delle risorse usate dal componente aggiuntivo VSTO quando viene scaricato. Per altre informazioni, vedere Eventi nei progetti di Office.

Per aggiungere un paragrafo di testo nel documento salvato

  1. Nel file di codice ThisAddIn, aggiungere il codice seguente alla classe ThisAddIn . Il nuovo codice definisce un gestore eventi per l'evento DocumentBeforeSave, generato quando un documento viene salvato.

    Quando l'utente salva un documento, il gestore eventi aggiunge nuovo testo all'inizio del documento.

    void Application_DocumentBeforeSave(Word.Document Doc, ref bool SaveAsUI, ref bool Cancel)
{
    Doc.Paragraphs[1].Range.InsertParagraphBefore();
    Doc.Paragraphs[1].Range.Text = "This text was added by using code.";
}

    Nota

    Questo codice usa il valore di indice 1 per accedere al primo paragrafo della raccolta Paragraphs. Anche se Visual Basic e Visual C# usano matrici in base 0, il limite inferiore di matrice della maggior parte delle raccolte del modello a oggetti di Word è 1. Per altre informazioni, vedere Scrivere codice nelle soluzioni Office.

  2. Se si usa C#, aggiungere il seguente codice obbligatorio al gestore eventi ThisAddIn_Startup . Tale codice viene usato per connettere il gestore eventi Application_DocumentBeforeSave all'evento DocumentBeforeSave .

    this.Application.DocumentBeforeSave += 
    new Word.ApplicationEvents4_DocumentBeforeSaveEventHandler(Application_DocumentBeforeSave);

    Per modificare il documento quando viene salvato, negli esempi di codice precedenti vengono usati gli oggetti seguenti:

  • Il campo Application della classe ThisAddIn . Il campo Application restituisce un oggetto Application che rappresenta l'istanza corrente di Word.

  • Il parametro Doc del gestore eventi dell'evento DocumentBeforeSave . Il parametro Doc è un oggetto Document che rappresenta il documento salvato. Per altre informazioni, vedere Panoramica del modello a oggetti di Word.

Testare il progetto

Per testare il progetto

  1. Premere F5 per compilare ed eseguire il progetto.

    Quando si crea il progetto, il codice viene compilato in un assembly incluso nella cartella di output di compilazione relativa al progetto. Inoltre, Visual Studio crea un set di voci del Registro di sistema che consentono a Word di individuare e caricare il componente aggiuntivo VSTO e di configurare le impostazioni di sicurezza nel computer di sviluppo; in questo modo, si attiva l'esecuzione del componente aggiuntivo VSTO. Per altre informazioni, vedere Creare soluzioni Office.

  2. In Word, salvare il documento attivo.

  3. Verificare che il seguente testo venga aggiunto al documento.

    This text was added by using code.

  4. Chiudere Word.

Pulire il progetto

Al termine dello sviluppo di un progetto, rimuovere l'assembly del componente aggiuntivo VSTO, le voci del Registro di sistema e le impostazioni di sicurezza dal computer di sviluppo. In caso contrario, il componente aggiuntivo VSTO verrà eseguito ogni volta che si avvia Word nel computer di sviluppo.

Per pulire il progetto completato nel computer di sviluppo

  1. In Visual Studio, nel menu Compila , fare clic su Pulisci soluzione.

Passaggi successivi

Ora che è stato creato un componente aggiuntivo VSTO di base per Word, è possibile acquisire altre informazioni sullo sviluppo di componenti aggiuntivi VSTO in questi argomenti:

  • Attività di programmazione generali che è possibile eseguire nei componenti aggiuntivi VSTO: Programmare i componenti aggiuntivi VSTO.

  • Attività di programmazione specifiche dei componenti aggiuntivi VSTO di Word: soluzioni Word.

  • Uso del modello a oggetti di Word: Panoramica del modello a oggetti di Word.

  • Personalizzazione dell'interfaccia utente di Word, ad esempio, aggiungendo una scheda personalizzata alla barra multifunzione o creando un riquadro attività personalizzato: personalizzazione dell'interfaccia utente di Office.

  • Compilazione e debug di componenti aggiuntivi VSTO per Word: Creare soluzioni Office.

  • Distribuzione di componenti aggiuntivi VSTO per Word: Distribuire una soluzione Office.

Contenuto correlato