Eventi di progetti Visual Studio Tools per Office

Articolo
04/28/2010

Aggiornamento: novembre 2007

Ogni modello di progetto Visual Studio Tools per Office genera automaticamente vari gestori eventi. I gestori eventi relativi alle personalizzazioni a livello di documento sono lievemente differenti rispetto ai gestori eventi relativi ai componenti aggiuntivi a livello di applicazione.

Per ulteriori informazioni sulle personalizzazioni e sui componenti aggiuntivi, vedere Cenni preliminari sullo sviluppo di soluzioni Office.

Personalizzazioni a livello di documento

Visual Studio Tools per Office fornisce codice generato sottostante documenti o fogli di lavoro nuovi o esistenti nelle personalizzazioni a livello di documento. Tale codice genera due eventi distinti: Startup e Shutdown.

Evento Startup

L'evento Startup viene generato per ogni elemento host (documento o foglio di lavoro) dopo l'avvio dell'esecuzione del documento e dopo il completamento dell'esecuzione dell'intero codice di inizializzazione contenuto nell'assembly. L'evento Startup è pertanto l'ultimo elemento a essere eseguito nel costruttore della classe in cui il codice viene eseguito. Per ulteriori informazioni sugli elementi host, vedere Cenni preliminari sugli elementi e sui controlli host.

Quando si crea un progetto a livello di documento, Visual Studio Tools per Office crea gestori eventi per l'evento Startup nei file di codice generati:

Per i progetti Microsoft Office Word, il gestore eventi è denominato ThisDocument_Startup.
Per i progetti Microsoft Office Excel, i gestori eventi sono denominati come segue:
- Sheet1_Startup
- Sheet2_Startup
- Sheet3_Startup
- ThisWorkbook_Startup

Evento Shutdown

L'evento Shutdown viene generato per ogni elemento host (documento o foglio di lavoro) quando il dominio applicazione in cui è caricato il codice sta per essere scaricato. Si tratta dell'ultimo evento da chiamare nella classe durante lo scaricamento.

Quando si crea un progetto a livello di documento, Visual Studio Tools per Office crea gestori eventi per l'evento Shutdown nei file di codice generati:

Per i progetti Microsoft Office Word, il gestore eventi è denominato ThisDocument_Shutdown.
Per i progetti Microsoft Office Excel, i gestori eventi sono denominati come segue:
- Sheet1_Shutdown
- Sheet2_Shutdown
- Sheet3_Shutdown
- ThisWorkbook_Shutdown

Nota:
Non rimuovere i controlli a livello di codice utilizzando il gestore eventi Shutdown del documento: gli elementi di interfaccia utente del documento non sono più disponibili quando si verifica l'evento Shutdown. Se si desidera rimuovere i controlli prima della chiusura dell'applicazione, aggiungere il codice a un altro gestore eventi, ad esempio BeforeClose o BeforeSave.

Dichiarazioni di metodo dei gestori eventi

A ogni dichiarazione di metodo del gestore eventi vengono passati gli stessi argomenti, ovvero sender ed e. In Excel l'argomento sender è riferito al foglio, ad esempio Sheet1 o Sheet2; in Word l'argomento sender è riferito al documento. L'argomento e si riferisce agli argomenti standard disponibili per un evento, non utilizzati in questo caso.

Nell'esempio di codice seguente vengono illustrati i gestori eventi predefiniti in progetti a livello di documento Word.

Private Sub ThisDocument_Startup(ByVal sender As Object, ByVal e As System.EventArgs) _
    Handles Me.Startup

End Sub

Private Sub ThisDocument_Shutdown(ByVal sender As Object, ByVal e As System.EventArgs) _
    Handles Me.Shutdown

End Sub

private void ThisDocument_Startup(object sender, System.EventArgs e)
{
}

private void ThisDocument_Shutdown(object sender, System.EventArgs e)
{
}

Nell'esempio di codice seguente vengono illustrati i gestori eventi predefiniti in progetti a livello di documento Excel.

Nota:
Nell'esempio di codice seguente vengono illustrati i gestori eventi della classe Sheet1. I nomi dei gestori eventi delle altre classi di elemento host corrispondono al nome della classe. Ad esempio, il gestore eventi Startup della classe Sheet2 viene denominato Sheet2_Startup, mentre il gestore eventi Startup della classe ThisWorkbook viene denominato ThisWorkbook_Startup.

Private Sub Sheet1_Startup(ByVal sender As Object, ByVal e As System.EventArgs) _
    Handles Me.Startup

End Sub

Private Sub Sheet1_Shutdown(ByVal sender As Object, ByVal e As System.EventArgs) _
    Handles Me.Shutdown

End Sub

private void Sheet1_Startup(object sender, System.EventArgs e)
{
}

private void Sheet1_Shutdown(object sender, System.EventArgs e)
{
}

Componenti aggiuntivi a livello di applicazione

Visual Studio Tools per Office fornisce codice generato nei componenti aggiuntivi a livello di applicazione. Tale codice genera due eventi distinti: Startup e Shutdown.

Evento Startup

L'evento Startup viene generato dopo il caricamento del componente aggiuntivo e l'esecuzione di tutto il codice di inizializzazione contenuto nell'assembly. Questo evento viene gestito dal metodo ThisAddIn_Startup contenuto nel file di codice generato.

Il codice contenuto nel gestore eventi ThisAddIn_Startup è il primo codice utente a essere eseguito, a meno che il componente aggiuntivo utilizzato esegua l'override del metodo RequestComAddInAutomationService. In questo caso, il gestore eventi ThisAddIn_Startup viene chiamato dopo la chiamata al metodo RequestComAddInAutomationService. Nei componenti aggiuntivi di Microsoft Office System 2007, se il componente aggiuntivo utilizzato esegue l'override del metodo RequestService, è possibile che dopo la chiamata a questo metodo venga chiamato anche il gestore eventi ThisAddIn_Startup.

Per ulteriori informazioni sulla sequenza di avvio dei componenti aggiuntivi, vedere Architettura dei componenti aggiuntivi a livello di applicazione.

Evento Shutdown

L'evento Shutdown viene generato quando il dominio applicazione in cui il codice è caricato sta per essere scaricato. Questo evento viene gestito dal metodo ThisAddIn_Shutdown contenuto nel file di codice generato. Questo gestore eventi è l'ultimo codice utente a essere eseguito quando il componente aggiuntivo viene scaricato.