Практическое руководство. Создание надстройки, возвращающей пользовательский интерфейс

Статья
11/05/2008

Обновлен: Ноябрь 2007

В этом примере показано, как создать надстройку, возвращающую пользовательский интерфейс WPF (Windows Presentation Foundation) в узел автономного приложения WPF.

Надстройка возвращает Пользовательский интерфейс, представляющий собой пользовательский элемент управления WPF. Содержимое пользовательского элемента управления составляет одна кнопка, при нажатии которой отображается окно сообщения. The WPF standalone application hosts the add-in and displays the user control (returned by the add-in) as the content of the main application window.

Необходимые компоненты

В этом примере акцентируются расширения WPF для модели надстройки .NET Framework, поддерживающей этот сценарий, и предполагается соблюдение следующих условий:

Знание модели надстройки .NET Framework, включая конвейер, надстройку и разработку ведущего приложения. Для ознакомления с этими понятиями см. раздел Обзор надстройки. Руководство, в котором демонстрируется реализация конвейера, надстройки и ведущего приложения, см. в разделе Пошаговое руководство. Создание расширяемого приложения.
Знание расширений WPF для модели надстройки .NET Framework, которые можно найти в разделе Общие сведения о надстройках Windows Presentation Foundation.

Образец

Полный пример для этого раздела см. в разделе Пример использования надстроек, возвращающих пользовательский интерфейс.

Пример

Чтобы создать надстройку, возвращающуюПользовательский интерфейс WPF, требуется специальный код для каждого сегмента конвейера, надстройки и ведущего приложения.

Реализация сегмента конвейера «контракт»

Метод должен быть определен контрактом для возвращения Пользовательский интерфейс, и возвращаемое значение должно иметь тип INativeHandleContract. Это демонстрируется методом GetAddInUI для IWPFAddInContract контракта в следующем коде.

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();
    }
}

Реализация сегмента конвейера «представление надстройки»

Поскольку надстройка реализует Пользовательские интерфейсы, она предоставляет в качестве подклассов FrameworkElement, метод представления надстройки, соответствующий IWPFAddInView.GetAddInUI, должен возвращать значение типа FrameworkElement. В следующем коде показано представление надстройки контракта, реализованное как интерфейс.

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();
    }
}

Реализация сегмента конвейера «адаптер на стороне надстройки»

Метод контракта возвращает INativeHandleContract, но надстройка возвращает FrameworkElement (как указано представлением надстройки). Следовательно, FrameworkElement должен быть преобразован в INativeHandleContract прежде чем будет пересечена граница изоляции. Эту работу выполняет адаптер на стороне надстройки, вызывая ViewToContractAdapter (как показано в следующем коде).

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;
        }
    }
}

Реализация сегмента конвейера «хост-представление»

Так как в главное приложение будет отображать FrameworkElement, метод представления узла соответствующего IWPFAddInHostView.GetAddInUI должен возвращать значение типа FrameworkElement. В следующем коде показано представление узла контракта, реализованный как интерфейс.

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();
    }
}

Реализация сегмента конвейера «адаптер на стороне узла»

Метод контракта возвращает INativeHandleContract, но главное приложение ожидает FrameworkElement (как указано представлением узла). Следовательно, INativeHandleContract должен быть преобразован в FrameworkElement после пересечения границы изоляции. Эта работа выполняется с помощью адаптера узла путем вызова ContractToViewAdapter, как показано в следующем коде.

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;
        }
    }
}

Реализация надстройки

С помощью адаптера надстройки и созданного представления надстройки, надстройка (WPFAddIn1.AddIn) должна реализовать IWPFAddInView.GetAddInUI метод для возврата FrameworkElement объекта ( UserControl в этом примере). Реализация интерфейса AddInUIUserControl показывается с помощью следующего кода.

    <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");
        }
    }
}

Реализации IWPFAddInView.GetAddInUI посредством надстройки требуется новый экземпляр AddInUI, как показано в следующем коде.

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();
        }
    }
}

Реализация ведущего приложения

С помощью адаптера и созданного представления узла, ведущее приложение может использовать .NET Framework модель надстройки для открытия канала, получения представления узла надстройки и вызова IWPFAddInHostView.GetAddInUI метода. Эти действия показаны в следующем коде.

// 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);

См. также

Задачи

Пример использования надстроек, возвращающих пользовательский интерфейс

Основные понятия

Обзор надстройки

Общие сведения о надстройках Windows Presentation Foundation

Поделиться через