Como criar um Add-In como uma interface do usuário

Artigo
12/18/2024

Este exemplo mostra como criar um complemento que é uma Fundação de Apresentação do Windows (WPF) hospedado por um aplicativo autônomo do WPF.

O suplemento é uma interface que se apresenta como um controle de usuário WPF. O conteúdo do controle do usuário é um único botão que, quando clicado, exibe uma caixa de mensagem. O aplicativo autônomo do WPF hospeda a IU do complemento como o conteúdo da janela principal do aplicativo.

pré-requisitos

Este exemplo realça as extensões do WPF para o modelo de add-in do .NET Framework que habilita esse cenário e pressupõe o seguinte:

Conhecimento do modelo de complemento do .NET Framework, incluindo pipeline, complemento e desenvolvimento de ambientes de execução. Se você não estiver familiarizado com esses conceitos, consulte Suplementos e Extensibilidade. Consulte o tutorial que demonstra a implementação de um pipeline, um complemento e um aplicativo host em Passo a passo: criando um aplicativo extensível.
Conhecimento das extensões do WPF para o modelo de add-in do .NET Framework. Consulte WPF Add-Ins Visão Geral.

Exemplo

Para criar um suplemento que seja uma interface do usuário do WPF, é necessário um código específico para cada segmento de pipeline, o suplemento e o aplicativo host.

Implementando o segmento de pipeline do contrato

Quando um suplemento é uma interface do usuário, o contrato para o suplemento deve implementar INativeHandleContract. No exemplo, IWPFAddInContract implementa INativeHandleContract, conforme mostrado no código a seguir.

using System.AddIn.Contract;
using System.AddIn.Pipeline;

namespace Contracts
{
    /// <summary>
    /// Defines the services that an add-in will provide to a host application.
    /// In this case, the add-in is a UI.
    /// </summary>
    [AddInContract]
    public interface IWPFAddInContract : INativeHandleContract {}
}


Imports System.AddIn.Contract
Imports System.AddIn.Pipeline

Namespace Contracts
    ''' <summary>
    ''' Defines the services that an add-in will provide to a host application.
    ''' In this case, the add-in is a UI.
    ''' </summary>
    <AddInContract>
    Public Interface IWPFAddInContract
        Inherits INativeHandleContract
        Inherits IContract
    End Interface
End Namespace

Implementando o segmento de pipeline de exibição de Add-In

Como o suplemento é implementado como uma subclasse do tipo FrameworkElement, a visualização do suplemento também deve ser uma subclasse de FrameworkElement. O código a seguir mostra a exibição do suplemento do contrato, implementada como a classe WPFAddInView.

using System.AddIn.Pipeline;
using System.Windows.Controls;

namespace AddInViews
{
    /// <summary>
    /// Defines the add-in's view of the contract.
    /// </summary>
    [AddInBase]
    public class WPFAddInView : UserControl { }
}


Imports System.AddIn.Pipeline
Imports System.Windows.Controls

Namespace AddInViews
    ''' <summary>
    ''' Defines the add-in's view of the contract.
    ''' </summary>
    <AddInBase>
    Public Class WPFAddInView
        Inherits UserControl
    End Class
End Namespace

Aqui, a exibição do complemento é derivada de UserControl. Consequentemente, a interface de usuário do complemento também deve derivar de UserControl.

Implementação do Segmento de Pipeline do Adaptador Add-In-Side

Embora o contrato seja um INativeHandleContract, o suplemento é um FrameworkElement (conforme especificado pelo segmento de pipeline de exibição do suplemento). Portanto, o FrameworkElement deve ser convertido em um INativeHandleContract antes de cruzar o limite de isolamento. Esse trabalho é executado pelo adaptador do suplemento chamando ViewToContractAdapter, conforme mostrado no código a seguir.

using System;
using System.AddIn.Contract;
using System.AddIn.Pipeline;
using System.Security.Permissions;

using AddInViews;
using Contracts;

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
    {
        WPFAddInView wpfAddInView;

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

        /// <summary>
        /// ContractBase.QueryContract must be overridden to:
        /// * Safely return a window handle for an add-in UI to the host
        ///   application's application.
        /// * Enable tabbing between host application UI and add-in UI, in the
        ///   "add-in is a UI" scenario.
        /// </summary>
        public override IContract QueryContract(string contractIdentifier)
        {
            if (contractIdentifier.Equals(typeof(INativeHandleContract).AssemblyQualifiedName))
            {
                return FrameworkElementAdapters.ViewToContractAdapter(this.wpfAddInView);
            }

            return base.QueryContract(contractIdentifier);
        }

        /// <summary>
        /// GetHandle is called by the WPF add-in model from the host application's
        /// application domain to get the window handle for an add-in UI from the
        /// add-in's application domain. GetHandle is called if a window handle isn't
        /// returned by other means, that is, overriding ContractBase.QueryContract,
        /// as shown above.
        /// NOTE: This method requires UnmanagedCodePermission to be called
        ///       (full-trust by default), to prevent illegal window handle
        ///       access in partially trusted scenarios. If the add-in could
        ///       run in a partially trusted application domain
        ///       (eg AddInSecurityLevel.Internet), you can safely return a window
        ///       handle by overriding ContractBase.QueryContract, as shown above.
        /// </summary>
        public IntPtr GetHandle()
        {
            return FrameworkElementAdapters.ViewToContractAdapter(this.wpfAddInView).GetHandle();
        }
    }
}


Imports System
Imports System.AddIn.Contract
Imports System.AddIn.Pipeline
Imports System.Security.Permissions

Imports AddInViews
Imports Contracts

Namespace AddInSideAdapters
    ''' <summary>
    ''' Adapts the add-in's view of the contract to the add-in contract
    ''' </summary>
    <AddInAdapter>
    Public Class WPFAddIn_ViewToContractAddInSideAdapter
        Inherits ContractBase
        Implements IWPFAddInContract

        Private wpfAddInView As WPFAddInView

        Public Sub New(ByVal wpfAddInView As WPFAddInView)
            ' Adapt the add-in view of the contract (WPFAddInView) 
            ' to the contract (IWPFAddInContract)
            Me.wpfAddInView = wpfAddInView
        End Sub

        ''' <summary>
        ''' ContractBase.QueryContract must be overridden to:
        ''' * Safely return a window handle for an add-in UI to the host 
        '''   application's application.
        ''' * Enable tabbing between host application UI and add-in UI, in the
        '''   "add-in is a UI" scenario.
        ''' </summary>
        Public Overrides Function QueryContract(ByVal contractIdentifier As String) As IContract
            If contractIdentifier.Equals(GetType(INativeHandleContract).AssemblyQualifiedName) Then
                Return FrameworkElementAdapters.ViewToContractAdapter(Me.wpfAddInView)
            End If

            Return MyBase.QueryContract(contractIdentifier)
        End Function

        ''' <summary>
        ''' GetHandle is called by the WPF add-in model from the host application's 
        ''' application domain to get the window handle for an add-in UI from the 
        ''' add-in's application domain. GetHandle is called if a window handle isn't 
        ''' returned by other means, that is, overriding ContractBase.QueryContract, 
        ''' as shown above.
        ''' </summary>
        Public Function GetHandle() As IntPtr Implements INativeHandleContract.GetHandle
            Return FrameworkElementAdapters.ViewToContractAdapter(Me.wpfAddInView).GetHandle()
        End Function

    End Class
End Namespace

No modelo de suplemento em que um suplemento retorna uma interface do usuário (consulte Criar um Add-In que retorna um), o adaptador do suplemento converteu o FrameworkElement em um INativeHandleContract chamando ViewToContractAdapter. ViewToContractAdapter também deve ser chamado nesse modelo, embora você precise implementar um método do qual escrever o código para chamá-lo. Faça isso substituindo QueryContract e implementando o código que chama ViewToContractAdapter se o código que está chamando QueryContract estiver esperando um INativeHandleContract. Nesse caso, o chamador será o adaptador do lado do host, que é abordado em uma subseção subsequente.

Nota

Você também precisa substituir QueryContract neste modelo para habilitar a navegação entre a interface de usuário do aplicativo anfitrião e a interface de usuário do suplemento. Para obter mais informações, consulte "Limitações de Add-In do WPF" no visão geral do Add-Ins WPF.

Como o adaptador do lado do complemento implementa uma interface derivada de INativeHandleContract, você também precisa implementar GetHandle, embora isso seja ignorado quando QueryContract é sobrescrito.

Implementando o segmento de pipeline de visualização de host

Nesse modelo, o aplicativo hospedeiro normalmente espera que a visualização hospedeira seja uma subclasse FrameworkElement. O adaptador do lado do host deve converter o INativeHandleContract em um FrameworkElement depois que o INativeHandleContract cruzar o limite de isolamento. Como um método não está sendo chamado pelo aplicativo host para obter o FrameworkElement, a visão do host deve "retornar" o FrameworkElement ao contê-lo. Consequentemente, a visão do host deve derivar de uma subclasse de FrameworkElement que possa conter outras UIs, como UserControl. O código a seguir mostra a visão de host do contrato, implementada como a classe WPFAddInHostView.

using System.Windows.Controls;

namespace HostViews
{
    /// <summary>
    /// Defines the host's view of the add-in
    /// </summary>
    public class WPFAddInHostView : UserControl { }
}


Imports System.Windows.Controls

Namespace HostViews
    ''' <summary>
    ''' Defines the host's view of the add-in
    ''' </summary>
    Public Class WPFAddInHostView
        Inherits UserControl
    End Class
End Namespace

Implementando o segmento de canalização do adaptador de Host-Side

Embora o contrato seja um INativeHandleContract, o aplicativo hospedeiro espera um UserControl (conforme especificado pela visualização do host). Consequentemente, o INativeHandleContract deve ser convertido em um FrameworkElement depois de cruzar o limite de isolamento, antes de ser definido como conteúdo da visão do host (que deriva de UserControl).

Esse trabalho é executado pelo adaptador do lado do host, conforme mostrado no código a seguir.

using System.AddIn.Contract;
using System.AddIn.Pipeline;
using System.Windows;

using Contracts;
using HostViews;

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

        public WPFAddIn_ContractToViewHostSideAdapter(IWPFAddInContract wpfAddInContract)
        {
            // Adapt the contract (IWPFAddInContract) to the host application's
            // view of the contract (WPFAddInHostView)
            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);

            // Convert the INativeHandleContract for the add-in UI that was passed
            // from the add-in side of the isolation boundary to a FrameworkElement
            string aqn = typeof(INativeHandleContract).AssemblyQualifiedName;
            INativeHandleContract inhc = (INativeHandleContract)wpfAddInContract.QueryContract(aqn);
            FrameworkElement fe = (FrameworkElement)FrameworkElementAdapters.ContractToViewAdapter(inhc);

            // Add FrameworkElement (which displays the UI provided by the add-in) as
            // content of the view (a UserControl)
            this.Content = fe;
        }
    }
}


Imports System.AddIn.Contract
Imports System.AddIn.Pipeline
Imports System.Windows

Imports Contracts
Imports HostViews

Namespace HostSideAdapters
    ''' <summary>
    ''' Adapts the add-in contract to the host's view of the add-in
    ''' </summary>
    <HostAdapter>
    Public Class WPFAddIn_ContractToViewHostSideAdapter
        Inherits WPFAddInHostView
        Private wpfAddInContract As IWPFAddInContract
        Private wpfAddInContractHandle As ContractHandle

        Public Sub New(ByVal wpfAddInContract As IWPFAddInContract)
            ' Adapt the contract (IWPFAddInContract) to the host application's
            ' view of the contract (WPFAddInHostView)
            Me.wpfAddInContract = wpfAddInContract

            ' Prevent the reference to the contract from being released while the
            ' host application uses the add-in
            Me.wpfAddInContractHandle = New ContractHandle(wpfAddInContract)

            ' Convert the INativeHandleContract for the add-in UI that was passed 
            ' from the add-in side of the isolation boundary to a FrameworkElement
            Dim aqn As String = GetType(INativeHandleContract).AssemblyQualifiedName
            Dim inhc As INativeHandleContract = CType(wpfAddInContract.QueryContract(aqn), INativeHandleContract)
            Dim fe As FrameworkElement = CType(FrameworkElementAdapters.ContractToViewAdapter(inhc), FrameworkElement)

            ' Add FrameworkElement (which displays the UI provided by the add-in) as
            ' content of the view (a UserControl)
            Me.Content = fe
        End Sub
    End Class
End Namespace

Como você pode ver, o adaptador do lado anfitrião adquire o INativeHandleContract chamando o método QueryContract do adaptador do lado do complemento (esse é o ponto em que o INativeHandleContract cruza o limite de isolamento).

O adaptador do lado do host, em seguida, converte o INativeHandleContract em um FrameworkElement ao chamar ContractToViewAdapter. Por fim, o FrameworkElement é definido como o conteúdo da visão do anfitrião.

Implementando o Add-In

Com o adaptador do lado do suplemento e o modo de exibição do suplemento já configurado, o suplemento pode ser implementado herdando do modo de exibição do suplemento, conforme mostrado no código a seguir.

using System.AddIn;
using System.Windows;

using AddInViews;

namespace WPFAddIn1
{
    /// <summary>
    /// Implements the add-in by deriving from WPFAddInView
    /// </summary>
    [AddIn("WPF Add-In 1")]
    public partial class AddInUI : WPFAddInView
    {
        public AddInUI()
        {
            InitializeComponent();
        }

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


Imports System.AddIn
Imports System.Windows

Imports AddInViews

Namespace WPFAddIn1
    ''' <summary>
    ''' Implements the add-in by deriving from WPFAddInView
    ''' </summary>
    <AddIn("WPF Add-In 1")>
    Partial Public Class AddInUI
        Inherits WPFAddInView
        Public Sub New()
            InitializeComponent()
        End Sub

        Private Sub clickMeButton_Click(ByVal sender As Object, ByVal e As RoutedEventArgs)
            MessageBox.Show("Hello from WPFAddIn1")
        End Sub
    End Class
End Namespace

Neste exemplo, você pode ver um benefício interessante desse modelo: os desenvolvedores de suplementos só precisam implementar o suplemento (já que é a interface do usuário também), em vez de uma classe de suplemento e uma interface do usuário do suplemento.

Implementando o aplicativo host

Com o adaptador do host e a visão do host criados, o aplicativo anfitrião pode usar o modelo de complemento do .NET Framework para iniciar o pipeline e adquirir uma visão do host do complemento. Essas etapas são mostradas no código a seguir.

// 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(WPFAddInHostView), appPath);
AddInToken wpfAddInToken = addInTokens[0];
this.wpfAddInHostView = wpfAddInToken.Activate<WPFAddInHostView>(AddInSecurityLevel.Internet);

// Display add-in UI
this.addInUIHostGrid.Children.Add(this.wpfAddInHostView);

' Get add-in pipeline folder (the folder in which this application was launched from)
Dim appPath As String = Environment.CurrentDirectory

' Rebuild visual add-in pipeline
Dim warnings() As String = AddInStore.Rebuild(appPath)
If warnings.Length > 0 Then
    Dim msg As String = "Could not rebuild pipeline:"
    For Each warning As String In warnings
        msg &= vbLf & warning
    Next warning
    MessageBox.Show(msg)
    Return
End If

' Activate add-in with Internet zone security isolation
Dim addInTokens As Collection(Of AddInToken) = AddInStore.FindAddIns(GetType(WPFAddInHostView), appPath)
Dim wpfAddInToken As AddInToken = addInTokens(0)
Me.wpfAddInHostView = wpfAddInToken.Activate(Of WPFAddInHostView)(AddInSecurityLevel.Internet)

' Display add-in UI
Me.addInUIHostGrid.Children.Add(Me.wpfAddInHostView)

O aplicativo host ativa o suplemento usando o código de modelo típico de suplemento do .NET Framework, o que retorna implicitamente a visão do host para o aplicativo host. O aplicativo host exibe posteriormente a visão do host (que é um UserControl) de um Grid.

O código responsável por processar interações com a interface do suplemento é executado no domínio de aplicação do suplemento. Essas interações incluem o seguinte:

Manipulando o evento Button Click.
Mostrando o MessageBox.

Essa atividade é completamente isolada do aplicativo host.

Consulte também

suplementos e extensibilidade
Visão Geral WPF Add-Ins

Compartilhar via