Gewusst wie: Erstellen eines Add-Ins, das eine Benutzeroberfläche zurückgibt
Aktualisiert: November 2007
Dieses Beispiel zeigt, wie Sie ein Add-In erstellen, das eine Windows Presentation Foundation (WPF)-Benutzeroberfläche (user interface, UI) für eine eigenständige WPF-Hostanwendung zurückgibt.
Das Add-In gibt eine Benutzeroberfläche zurück, bei der es sich um ein WPF-Benutzersteuerelement handelt. Der Inhalt des Benutzersteuerelements ist eine einzelne Schaltfläche, bei der ein Meldungsfeld angezeigt wird, wenn Benutzer darauf klicken. Die eigenständige WPF-Anwendung hostet das Add-In und zeigt das (vom Add-In zurückgegebene) Benutzersteuerelement als Inhalt des Hauptfensters der Anwendung an.
Vorbereitungsmaßnahmen
Dieses Beispiel zeigt die WPF-Erweiterungen des .NET Framework-Add-In-Modells, die dieses Szenario ermöglichen. Dabei wird Folgendes vorausgesetzt:
Kenntnis des .NET Framework-Add-In-Modells, einschließlich Pipeline-, Add-In- und Hostentwicklung. Wenn Sie mit diesen Begriffen nicht vertraut sind, finden Sie weitere Informationen unter Übersicht über Add-Ins. Ein Lernprogramm, das die Implementierung einer Pipeline, eines Add-Ins und einer Hostanwendung veranschaulicht, finden Sie unter Exemplarische Vorgehensweise: Erstellen von erweiterbaren Anwendungen.
Kenntnis der WPF-Erweiterungen des .NET Framework-Add-In-Modells. Informationen finden Sie unter: Windows Presentation Foundation – Übersicht über Add-Ins.
Beispiel
Das vollständige Beispiel zu diesem Thema finden Sie unter Add-In gibt eine Benutzeroberfläche zurück – Beispiel.
Beispiel
Zum Erstellen eines Add-Ins, das eine WPF-Benutzeroberfläche zurückgibt, ist spezieller Code für die einzelnen Pipelinesegmente, das Add-In und die Hostanwendung erforderlich.
Implementieren des Vertragspipelinesegments
Im Vertrag muss eine Methode zum Zurückgeben einer Benutzeroberfläche festgelegt sein, und der Rückgabewert muss vom Typ INativeHandleContract sein. Dies wird durch die GetAddInUI-Methode des IWPFAddInContract-Vertrags im folgenden Code veranschaulicht.
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();
}
}
Implementieren des Add-In-Ansichtspipelinesegments
Da das Add-In die UIs implementiert, die es als Unterklassen von FrameworkElement bereitstellt, muss die Methode der Add-In-Ansicht, die mit IWPFAddInView.GetAddInUI verknüpft ist, einen Wert vom Typ FrameworkElement zurückgeben. Im folgenden Code wird die als Schnittstelle implementierte Add-In-Ansicht des Vertrags gezeigt.
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();
}
}
Implementieren des Add-In-seitigen Adapterpipelinesegments
Durch die Vertragsmethode wird INativeHandleContract zurückgegeben, das Add-In gibt jedoch FrameworkElement zurück (wie durch die Add-In-Ansicht festgelegt). Daher muss FrameworkElement vor dem Überschreiten der Isolationsgrenze in INativeHandleContract umgewandelt werden. Dieser Vorgang wird vom Add-In-seitigen Adapter durch Aufrufen von ViewToContractAdapter ausgeführt, wie im folgenden Code gezeigt.
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;
}
}
}
Implementieren des Host-Ansichtspipelinesegments
Da die Hostanwendung FrameworkElement anzeigt, muss die Methode der Hostansicht, die mit IWPFAddInHostView.GetAddInUI verknüpft ist, einen Wert vom Typ FrameworkElement zurückgeben. Im folgenden Code wird die als Schnittstelle implementierte Hostansicht des Vertrags gezeigt.
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();
}
}
Implementieren des hostseitigen Adapterpipelinesegments
Durch die Vertragsmethode wird INativeHandleContract zurückgegeben, die Hostanwendung erwartet jedoch FrameworkElement (wie durch die Hostansicht festgelegt). Daher muss INativeHandleContract nach dem Überschreiten der Isolationsgrenze in FrameworkElement umgewandelt werden. Dieser Vorgang wird vom hostseitigen Adapter durch Aufrufen von ContractToViewAdapter ausgeführt, wie im folgenden Code gezeigt.
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;
}
}
}
Implementieren des Add-Ins
Wenn der Add-In-seitige Adapter und die Add-In-Ansicht erstellt sind, muss das Add-In (WPFAddIn1.AddIn) die IWPFAddInView.GetAddInUI-Methode implementieren, um ein FrameworkElement-Objekt zurückzugeben (in diesem Beispiel UserControl). Der folgende Code zeigt die Implementierung von 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");
}
}
}
Bei der Implementierung von IWPFAddInView.GetAddInUI über das Add-In muss lediglich eine neue Instanz von AddInUI zurückgegeben werden. Dies ist im folgenden Code gezeigt.
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();
}
}
}
Implementieren der Hostanwendung
Sind der hostseitige Adapter und die Hostansicht erstellt, kann die Hostanwendung das Add-In-Modell von .NET Framework verwenden, um die Pipeline zu öffnen, eine Hostansicht des Add-Ins abzurufen und die IWPFAddInHostView.GetAddInUI-Methode aufzurufen. Diese Schritte werden im folgenden Code gezeigt.
// 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);
Siehe auch
Aufgaben
Add-In gibt eine Benutzeroberfläche zurück – Beispiel