Riquadri attività personalizzati

  • Articolo

I riquadri attività sono pannelli dell'interfaccia utente in genere ancorati a un lato di una finestra in un'applicazione di Microsoft Office. I riquadri attività personalizzati consentono di creare un riquadro attività basato sulle proprie esigenze specifiche e offrono agli utenti un'interfaccia utente nota per accedere alle funzionalità della soluzione. L'interfaccia può, ad esempio, contenere controlli che consentono di eseguire codice per la modifica dei documenti o per la visualizzazione dei dati di un'origine dati.

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

Nota

Un riquadro attività personalizzato è diverso da un riquadro azioni. Il riquadro azioni fa parte delle personalizzazioni a livello di documento per Microsoft Office Word e Microsoft Office Excel. Per altre informazioni, vedere Panoramica del riquadro Azioni.

Vantaggi dei riquadri attività personalizzati

I riquadri attività personalizzati consentono di integrare le funzionalità in un'interfaccia utente familiare. È possibile creare rapidamente un riquadro attività personalizzato usando gli strumenti di Visual Studio.

Interfaccia utente familiare

Gli utenti di applicazioni in Microsoft Office System hanno già familiarità con l'uso di riquadri attività, ad esempio stili e formattazione del riquadro attività in Word. I riquadri attività personalizzati presentano un funzionamento simile a quello di altri riquadri attività di Microsoft Office. Gli utenti possono ancorare i riquadri attività personalizzati a diversi lati della finestra dell'applicazione oppure possono trascinare i riquadri attività personalizzati in qualsiasi posizione all'interno della finestra. È possibile creare un componente aggiuntivo VSTO in grado di visualizzare più riquadri attività personalizzati allo stesso tempo, garantendo agli utenti la possibilità di controllare ogni riquadro attività singolarmente.

Supporto di Windows Form

L'interfaccia utente di un riquadro attività personalizzato creato mediante gli strumenti di sviluppo di Office in Visual Studio si basa sui controlli Windows Form. È possibile usare il noto strumento Progettazione Windows Form per progettare l'interfaccia utente per un riquadro attività personalizzato. È inoltre possibile usare il supporto del data binding dei Windows Form per associare un'origine dati ai controlli del riquadro attività.

Creare un riquadro attività personalizzato

È possibile creare un riquadro attività personalizzato di base in due passaggi:

  1. Creare un'interfaccia utente per il riquadro attività personalizzato aggiungendo controlli Windows Form a un oggetto UserControl.

  2. Creare un'istanza del riquadro attività personalizzato passando il controllo utente all'oggetto CustomTaskPaneCollection nel componente aggiuntivo VSTO. Questa raccolta restituisce un nuovo oggetto CustomTaskPane che può essere usato per modificare l'aspetto del riquadro attività e per rispondere agli eventi utente.

    Per altre informazioni, vedere Procedura: Aggiungere un riquadro attività personalizzato a un'applicazione.

Creare l'interfaccia utente

Tutti i riquadri attività personalizzati creati tramite gli strumenti di sviluppo di Office in Visual Studio contengono un oggetto UserControl. Tale controllo utente fornisce l'interfaccia utente del riquadro attività personalizzato È possibile creare il controllo utente in fase di progettazione o in fase di esecuzione. Se viene creato in fase di progettazione, è possibile usare Progettazione Windows Form per costruire l'interfaccia utente del riquadro attività.

Creare un'istanza del riquadro attività personalizzato

Dopo aver creato un controllo utente contenente l'interfaccia utente del riquadro attività personalizzato, è necessario creare un'istanza di un oggetto CustomTaskPane. A questo scopo, passare il controllo utente all'oggetto CustomTaskPaneCollection nel componente aggiuntivo VSTO chiamando uno dei metodi Add. Tale raccolta viene esposta come campo CustomTaskPanes della classe ThisAddIn. Per usare l'esempio di codice seguente è necessario eseguirlo dalla classe ThisAddIn.

myUserControl1 = new MyUserControl();
myCustomTaskPane = this.CustomTaskPanes.Add(myUserControl1, "My Task Pane");
myCustomTaskPane.Visible = true;

I metodi Add restituiscono un nuovo oggetto CustomTaskPane, che può essere usato per modificare l'aspetto del riquadro attività e per rispondere agli eventi utente.

Controllare il riquadro attività in più finestre

I riquadri attività personalizzati sono associati a una finestra cornice di documento che presenta all'utente una visualizzazione di un documento o di un elemento. Il riquadro attività è visibile solo quando la finestra associata è visibile.

Per determinare quale finestra visualizza il riquadro attività personalizzato, usare l'overload del metodo Add appropriato quando si crea il riquadro attività:

  • Per associare il riquadro attività alla finestra attiva, usare il metodo Add.

  • Per associare il riquadro attività a un documento ospitato da una finestra specifica, usare il metodo Add.

    Alcune applicazioni di Office richiedono istruzioni esplicite su quando creare o visualizzare il riquadro attività nei casi in cui siano aperte più finestre. In questi casi è importante prendere in considerazione il punto del codice in cui creare un'istanza del riquadro attività personalizzato per garantire che il riquadro attività visualizzato contenga i documenti o gli elementi appropriati dell'applicazione. Per altre informazioni, vedere Gestire riquadri attività personalizzati nelle finestre dell'applicazione.

Accedere all'applicazione dal riquadro attività

Per automatizzare l'applicazione dal controllo utente, è possibile accedere direttamente al modello a oggetti usando la classe Globals.ThisAddIn.Application nel codice. La classe statica Globals consente di accedere all'oggetto ThisAddIn. Il campo Application di questo oggetto rappresenta il punto di ingresso nel modello a oggetti dell'applicazione.

Per altre informazioni sul campo dell'oggetto, vedere Program VSTO Add-ins.For more information about the Application field of the ThisAddIn object, see Program VSTO Add-ins. Per una procedura dettagliata che illustra come automatizzare un'applicazione da un riquadro attività personalizzato, vedere Procedura dettagliata: Automatizzare un'applicazione da un riquadro attività personalizzato. Per altre informazioni sulla Globals classe , vedere Accesso globale agli oggetti nei progetti di Office.

Gestire l'interfaccia utente del riquadro attività

Dopo aver creato il riquadro attività è possibile usare le proprietà e gli eventi dell'oggetto CustomTaskPane per controllare l'interfaccia utente del riquadro attività e per definire il comportamento in risposta alle modifiche apportate dall'utente al riquadro attività.

Rendere visibile il riquadro attività personalizzato

Per impostazione predefinita, il riquadro attività non è visibile. Per rendere visibile il riquadro attività, è necessario impostare la Visible proprietà su true.

Gli utenti possono chiudere un riquadro attività in qualsiasi momento facendo clic sul pulsante Chiudi (X) nell'angolo del riquadro attività. Non esiste, tuttavia, una modalità predefinita per riaprire il riquadro attività personalizzato. Se un utente chiude un riquadro attività personalizzato, potrà visualizzarlo di nuovo solo se viene fornito uno strumento che consente di eseguire tale operazione.

Se si crea un riquadro attività personalizzato nel componente aggiuntivo VSTO, è consigliabile creare anche un elemento dell'interfaccia utente, ad esempio un pulsante, selezionabile dagli utenti per visualizzare o nascondere il riquadro stesso. Se il riquadro attività personalizzato viene creato in un'applicazione di Microsoft Office che supporta la personalizzazione della barra multifunzione, è possibile aggiungere un gruppo di controlli alla barra multifunzione contenente un pulsante che consente di visualizzare o nascondere il riquadro attività personalizzato. Per una procedura dettagliata che illustra come eseguire questa operazione, vedere Procedura dettagliata: Sincronizzare un riquadro attività personalizzato con un pulsante della barra multifunzione.

Se si crea un riquadro attività personalizzato in un'applicazione di Microsoft Office che non supporta la personalizzazione della barra multifunzione, è possibile aggiungere un oggetto CommandBarButton che consente di visualizzare o nascondere tale riquadro.

Modificare l'aspetto del riquadro attività

È possibile controllare le dimensioni e la posizione di un riquadro attività personalizzato usando le proprietà dell'oggetto CustomTaskPane, nonché apportare molte altre modifiche all'aspetto del riquadro attività usando le proprietà dell'oggetto UserControl contenuto nel riquadro stesso. È possibile, ad esempio, specificare un'immagine di sfondo per un riquadro attività personalizzato usando la proprietà BackgroundImage del controllo utente.

Nella tabella seguente sono elencate le modifiche che è possibile apportare a un riquadro attività personalizzato mediante le proprietà CustomTaskPane.

Attività Proprietà
Per modificare le dimensioni del riquadro attività Height

Width
Per modificare la posizione del riquadro attività DockPosition
Per nascondere il riquadro attività o renderlo visibile Visible
Per impedire che l'utente modifichi la posizione del riquadro attività DockPositionRestrict

Programmare eventi del riquadro attività personalizzati

È possibile che si desideri impostare il componente aggiuntivo VSTO in modo che risponda alle modifiche apportate dall'utente al riquadro attività personalizzato. Se, ad esempio, l'utente modifica l'orientamento del riquadro da verticale a orizzontale, potrebbe essere necessario riposizionare i controlli.

Nella tabella seguente sono elencati gli eventi che è possibile gestire per rispondere alle modifiche apportate dall'utente al riquadro attività personalizzato.

Attività Evento
Per definire il comportamento quando l'utente modifica la posizione del riquadro attività. DockPositionChanged
Per definire il comportamento quando l'utente nasconde o rende visibile il riquadro attività. VisibleChanged

Pulire le risorse usate dal riquadro attività

Dopo aver creato un riquadro attività personalizzato, l'oggetto CustomTaskPane rimane in memoria finché il componente aggiuntivo VSTO è in esecuzione. L'oggetto rimane in memoria anche dopo che l'utente fa clic sul pulsante Chiudi (X) nell'angolo del riquadro attività.

Per pulire le risorse usate dal riquadro attività mentre il componente aggiuntivo VSTO è ancora in esecuzione, usare i metodi Remove o RemoveAt. Tali metodi rimuovono l'oggetto CustomTaskPane specificato dalla raccolta CustomTaskPanes ed effettuano quindi la chiamata al metodo Dispose dell'oggetto.

Il Strumenti di Visual Studio per il runtime di Office pulisce automaticamente le risorse usate dal riquadro attività personalizzato quando il componente aggiuntivo VSTO viene scaricato. Non chiamare i Remove metodi o RemoveAt nel ThisAddIn_Shutdown gestore eventi nel progetto. Questi metodi genereranno un ObjectDisposedException' perché il Strumenti di Visual Studio per il runtime di Office pulisce le risorse usate dall'oggetto prima ThisAddIn_Shutdown di CustomTaskPane essere chiamato. Per altre informazioni su ThisAddIn_Shutdown, vedere Eventi nei progetti di Office.

Gestire riquadri attività personalizzati in più finestre dell'applicazione

Quando si crea un riquadro attività personalizzato in un'applicazione che usa più finestre per visualizzare documenti e altri elementi, è necessario effettuare altre azioni per assicurarsi che il riquadro attività sia visibile quando l'utente si aspetta che lo sia.

I riquadri attività personalizzati in tutte le applicazioni sono associati a una finestra cornice del documento che presenta una visualizzazione di un documento o di un elemento all'utente. Il riquadro attività è visibile solo quando la finestra associata è visibile. Non tutte le applicazioni usano tuttavia le finestre cornice del documento nello stesso modo.

I gruppi di applicazioni seguenti hanno requisiti di sviluppo diversi:

Outlook

Quando si crea un riquadro attività personalizzato per Outlook, tale riquadro viene associato a una finestra di esplorazione o a una finestra di controllo specifica. Esplora risorse sono finestre che visualizzano il contenuto di una cartella e Inspectors sono finestre che visualizzano un elemento, ad esempio un messaggio di posta elettronica o un'attività.

Per visualizzare un riquadro attività personalizzato con più finestre di esplorazione o di controllo, è necessario creare una nuova istanza del riquadro attività personalizzato quando viene aperta una nuova finestra di esplorazione o di controllo. A questo scopo, gestire un evento generato quando viene creata una finestra di esplorazione o di controllo, quindi creare il riquadro attività nel gestore eventi. È anche possibile gestire gli eventi relativi alle finestre di esplorazione e di controllo per nascondere o visualizzare i riquadri attività a seconda di quale finestra è visibile.

Per associare il riquadro attività a uno specifico Explorer o Inspector, utilizzare il Add metodo per creare il riquadro attività e passare l'oggetto Explorer o Inspector al parametro della finestra . Per altre informazioni sulla creazione di riquadri attività personalizzati, vedere Panoramica dei riquadri attività personalizzati.

Impedire più istanze di un riquadro attività personalizzato in Outlook

Per impedire la visualizzazione nelle finestre di Outlook di più istanze di un riquadro attività personalizzato, rimuovere esplicitamente il riquadro dalla raccolta CustomTaskPanes della classe ThisAddIn al momento della chiusura di ogni finestra. Chiamare il metodo Remove in un evento generato quando viene chiusa una finestra, ad esempio Close o Close.

Se non si rimuove esplicitamente il riquadro attività personalizzato, nelle finestre di Outlook potrebbero essere visualizzate più istanze di tale riquadro. In Outlook le finestre vengono talvolta riciclate e pertanto possono conservare riferimenti ai riquadri attività personalizzati a esse associati.

Word, InfoPath e PowerPoint

Word, InfoPath e PowerPoint visualizzano ogni documento in una finestra cornice documento diversa. Quando si crea un riquadro attività personalizzato per queste applicazioni, tale riquadro viene associato solo a un documento specifico. Se l'utente apre un documento diverso, il riquadro attività personalizzato viene nascosto fino a che il documento precedente non è nuovamente visibile.

Per visualizzare un riquadro attività personalizzato con più documenti, creare una nuova istanza del riquadro attività personalizzato quando l'utente crea un nuovo documento o ne apre uno esistente. A questo scopo, gestire gli eventi generati quando viene creato o aperto un documento, quindi creare il riquadro attività nei gestori di eventi. È inoltre possibile gestire gli eventi del documento per nascondere o visualizzare i riquadri attività a seconda del documento visibile.

Per associare il riquadro attività a una finestra di documento specifica, usare il Add metodo per creare il riquadro attività e passare un Window oggetto (per Word), WindowObject (per InfoPath) o DocumentWindow (per PowerPoint) al parametro window.

Eventi di Word

Per monitorare lo stato delle finestre di documento in Word, è possibile gestire gli eventi seguenti:

Eventi di InfoPath

Per monitorare lo stato delle finestre di documento in InfoPath, è possibile gestire gli eventi seguenti:

Eventi di PowerPoint

Per monitorare lo stato delle finestre di documento in PowerPoint, è possibile gestire gli eventi seguenti:

Contenuto correlato