Condividi tramite

Procedura: creare un componente aggiuntivo che restituisce un'interfaccia utente

Aggiornamento: novembre 2007

In questo esempio viene illustrato come creare un componente aggiuntivo che restituisce un'interfaccia utente di Windows Presentation Foundation (WPF) a un'applicazione host WPF autonoma.

Il componente aggiuntivo restituisce un'interfaccia utente che rappresenta un controllo utente di WPF. Il contenuto del controllo utente è costituito da un unico pulsante che consente di visualizzare una finestra di messaggio. Nell'applicazione WPF autonoma viene ospitato il componente aggiuntivo e visualizzato il controllo utente, restituito da quest'ultimo, come contenuto della finestra principale dell'applicazione.

Prerequisiti

In questo esempio vengono evidenziate le estensioni WPF al modello di componente aggiuntivo .NET Framework responsabile dell'attivazione di tale scenario e si presuppongono le seguenti condizioni:

Esempio

Per l'esempio completo associato a questo argomento, vedere Esempio di componente aggiuntivo che restituisce un'interfaccia utente.

Esempio

La creazione di un componente aggiuntivo che restituisce un'interfaccia utente di WPF richiede l'utilizzo di codice specifico per ciascun segmento di pipeline, per il componente aggiuntivo e per l'applicazione host.

Implementazione del segmento di pipeline di contratto

Per poter restituire un'interfaccia utente, un metodo deve essere definito dal contratto e il relativo valore restituito deve essere di tipo INativeHandleContract, come illustrato dal metodo GetAddInUI del contratto IWPFAddInContract nel codice seguente.

using System.AddIn.Contract; // IContract, INativeHandleContract
using System.AddIn.Pipeline; // AddInContractAttribute

namespace Contracts
{
    /// <summary>
    /// Defines the services that an add-in will provide to a host application
    /// </summary>
    [AddInContract]
    public interface IWPFAddInContract : IContract
    {
        // Return a UI to the host application
        INativeHandleContract GetAddInUI();
    }
}

Implementazione del segmento di pipeline di visualizzazione del componente aggiuntivo

Poiché il componente aggiuntivo implementa le interfacce utente fornite come sottoclassi di FrameworkElement, il metodo nella visualizzazione del componente aggiuntivo correlata a IWPFAddInView.GetAddInUI deve restituire un valore di tipo FrameworkElement. Nel codice riportato di seguito viene illustrata la visualizzazione del componente aggiuntivo del contratto, implementata come interfaccia.

using System.AddIn.Pipeline; // AddInBaseAttribute
using System.Windows; // FrameworkElement

namespace AddInViews
{
    /// <summary>
    /// Defines the add-in's view of the contract
    /// </summary>
    [AddInBase]
    public interface IWPFAddInView
    {
        // The add-in's implementation of this method will return
        // a UI type that directly or indirectly derives from 
        // FrameworkElement.
        FrameworkElement GetAddInUI();
    }
}

Implementazione del segmento di pipeline dell'adattatore sul lato componente aggiuntivo

Il metodo del contratto restituisce INativeHandleContract, ma il componente aggiuntivo restituisce FrameworkElement, come specificato dalla visualizzazione del componente. Di conseguenza, l'oggetto FrameworkElement deve essere convertito in INativeHandleContract prima di oltrepassare il limite di isolamento. La conversione viene eseguita dall'adattatore sul lato componente aggiuntivo mediante una chiamata a ViewToContractAdapter, come illustrato nel codice seguente.

using System.AddIn.Contract; // INativeHandleContract
using System.AddIn.Pipeline; // AddInAdapterAttribute, FrameworkElementAdapters, ContractBase
using System.Windows; // FrameworkElement

using AddInViews; // IWPFAddInView
using Contracts; // IWPFAddInContract

namespace AddInSideAdapters
{
    /// <summary>
    /// Adapts the add-in's view of the contract to the add-in contract
    /// </summary>
    [AddInAdapter]
    public class WPFAddIn_ViewToContractAddInSideAdapter : ContractBase, IWPFAddInContract
    {
        IWPFAddInView wpfAddInView;

        public WPFAddIn_ViewToContractAddInSideAdapter(IWPFAddInView wpfAddInView)
        {
            // Adapt the add-in view of the contract (IWPFAddInView) 
            // to the contract (IWPFAddInContract)
            this.wpfAddInView = wpfAddInView;
        }

        public INativeHandleContract GetAddInUI()
        {
            // Convert the FrameworkElement from the add-in to an INativeHandleContract 
            // that will be passed across the isolation boundary to the host application.
            FrameworkElement fe = this.wpfAddInView.GetAddInUI();
            INativeHandleContract inhc = FrameworkElementAdapters.ViewToContractAdapter(fe);
            return inhc;
        }
    }
}

Implementazione del segmento di pipeline di visualizzazione host

Poiché l'applicazione host visualizzerà FrameworkElement, il metodo nella visualizzazione host correlata a IWPFAddInHostView.GetAddInUI deve restituire un valore di tipo FrameworkElement. Nel codice riportato di seguito viene illustrata la visualizzazione host del contratto, implementata come interfaccia.

using System.Windows; // FrameworkElement

namespace HostViews
{
    /// <summary>
    /// Defines the host's view of the add-in
    /// </summary>
    public interface IWPFAddInHostView
    {
        // The view returns as a class that directly or indirectly derives from 
        // FrameworkElement and can subsequently be displayed by the host 
        // application by embedding it as content or sub-content of a UI that is 
        // implemented by the host application.
        FrameworkElement GetAddInUI();
    }
}

Implementazione del segmento di pipeline dell'adattatore sul lato host

Il metodo del contratto restituisce INativeHandleContract, ma l'applicazione host prevede FrameworkElement, come specificato dalla visualizzazione host. Di conseguenza, l'oggetto INativeHandleContract deve essere convertito in FrameworkElement dopo aver oltrepassato il limite di isolamento. La conversione viene eseguita dall'adattatore sul lato host mediante una chiamata a ContractToViewAdapter, come illustrato nel codice seguente.

using System.AddIn.Contract; // INativeHandleContract
using System.AddIn.Pipeline; // HostAdapterAttribute, FrameworkElementAdapters, ContractHandle
using System.Windows; // FrameworkElement

using Contracts; // IWPFAddInContract
using HostViews; // IWPFAddInHostView

namespace HostSideAdapters
{
    /// <summary>
    /// Adapts the add-in contract to the host's view of the add-in
    /// </summary>
    [HostAdapter]
    public class WPFAddIn_ContractToViewHostSideAdapter : IWPFAddInHostView
    {
        IWPFAddInContract wpfAddInContract;
        ContractHandle wpfAddInContractHandle;

        public WPFAddIn_ContractToViewHostSideAdapter(IWPFAddInContract wpfAddInContract)
        {
            // Adapt the contract (IWPFAddInContract) to the host application's
            // view of the contract (IWPFAddInHostView)
            this.wpfAddInContract = wpfAddInContract;

            // Prevent the reference to the contract from being released while the
            // host application uses the add-in
            this.wpfAddInContractHandle = new ContractHandle(wpfAddInContract);
        }

        public FrameworkElement GetAddInUI()
        {
            // Convert the INativeHandleContract that was passed from the add-in side
            // of the isolation boundary to a FrameworkElement
            INativeHandleContract inhc = this.wpfAddInContract.GetAddInUI();
            FrameworkElement fe = FrameworkElementAdapters.ContractToViewAdapter(inhc);
            return fe;
        }
    }
}

Implementazione del componente aggiuntivo

Dopo aver creato l'adattatore sul lato componente aggiuntivo e la visualizzazione del componente, il componente aggiuntivo (WPFAddIn1.AddIn) deve implementare il metodo IWPFAddInView.GetAddInUI per restituire un oggetto FrameworkElement (UserControl in questo esempio). Nel codice riportato di seguito viene illustrata l'implementazione di UserControl, AddInUI.

    <UserControl
    xmlns="https://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="https://schemas.microsoft.com/winfx/2006/xaml"
    x:Class="WPFAddIn1.AddInUI">

    <StackPanel>
        <Button Click="clickMeButton_Click" Content="Click Me!" />
    </StackPanel>

</UserControl>

using System.Windows; // MessageBox, RoutedEventArgs
using System.Windows.Controls; // UserControl

namespace WPFAddIn1
{
    public partial class AddInUI : UserControl
    {
        public AddInUI()
        {
            InitializeComponent();
        }

        void clickMeButton_Click(object sender, RoutedEventArgs e)
        {
            MessageBox.Show("Hello from WPFAddIn1");
        }
    }
}

L'implementazione di IWPFAddInView.GetAddInUI da parte del componente aggiuntivo deve semplicemente restituire una nuova istanza di AddInUI, come illustrato nel codice seguente.

using System.AddIn; // AddInAttribute
using System.Windows; // FrameworkElement

using AddInViews; // IWPFAddInView

namespace WPFAddIn1
{
    /// <summary>
    /// Add-In implementation
    /// </summary>
    [AddIn("WPF Add-In 1")]
    public class WPFAddIn : IWPFAddInView
    {
        public FrameworkElement GetAddInUI()
        {
            // Return add-in UI
            return new AddInUI();
        }
    }
}

Implementazione dell'applicazione host

Una volta creato l'adattatore sul lato host e la visualizzazione host, nell'applicazione host è possibile utilizzare il modello di componente aggiuntivo .NET Framework per aprire la pipeline, acquisire una visualizzazione host del componente aggiuntivo e chiamare il metodo IWPFAddInHostView.GetAddInUI. Nel codice riportato di seguito vengono illustrati i diversi passaggi.

// Get add-in pipeline folder (the folder in which this application was launched from)
string appPath = Environment.CurrentDirectory;

// Rebuild visual add-in pipeline
string[] warnings = AddInStore.Rebuild(appPath);
if (warnings.Length > 0)
{
    string msg = "Could not rebuild pipeline:";
    foreach (string warning in warnings) msg += "\n" + warning;
    MessageBox.Show(msg);
    return;
}

// Activate add-in with Internet zone security isolation
Collection<AddInToken> addInTokens = AddInStore.FindAddIns(typeof(IWPFAddInHostView), appPath);
AddInToken wpfAddInToken = addInTokens[0];
this.wpfAddInHostView = wpfAddInToken.Activate<IWPFAddInHostView>(AddInSecurityLevel.Internet);

// Get and display add-in UI
FrameworkElement addInUI = this.wpfAddInHostView.GetAddInUI();
this.addInUIHostGrid.Children.Add(addInUI);

Vedere anche

Attività

Esempio di componente aggiuntivo che restituisce un'interfaccia utente

Concetti

Cenni preliminari sui componenti aggiuntivi

Cenni preliminari sui componenti aggiuntivi Windows Presentation Foundation

  • Last updated on