Allgemeiner COM-Wrapper für Späte Bindung
Beschreibung:
Wer verschiedene Office-Versionen mit dem Selben Stück Code automatisieren will, muss in den meisten Fällen zu Reflection greifen. Leider ist Reflection recht umständlich. Außerdem wird der Code sehr unleserlich und ist besonders für Entwickler mit weniger Erfahrung ein Buch mit sieben Siegeln.
Auch die determisitische Speicherverwaltung von COM-Anwendungen wie Office hat schon manchem einen bösen Streich gespielt. Im schlimmsten Fall werden die Office-Anwendungen nicht mehr sauber geschlossen und verbleiben als Müll im Hauptspeicher.
Deshalb habe ich einen allgemeinen Wrapper geschrieben, der den Umgang mit spätgebundenen COM-Objekten in C# einfacher und intuitiver gestaltet.
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Reflection;
using System.Runtime.InteropServices;
namespace Rainbird.Tools.ComInterop
{
/// <summary>
/// Allgemeiner Wrapper, um spätgebunden mit COM-Objekten (bzw. ActiveX-Komponenten) zu arbeiten.
/// </summary>
public class ComObject : IDisposable
{
// COM-Objekt
private object _realComObject = null;
/// <summary>
/// Übernimmt einen vorhanden Verweis auf ein COM-Objekt.
/// </summary>
/// <param name="injectedObject">Vorhandenes COM-Objekt</param>
public ComObject(object injectedObject)
{
// Wenn kein Objekt angegeben wurde ...
if (injectedObject==null)
// Ausnahme werfen
throw new ArgumentNullException("injectedObject");
// Wenn das angegebene Objekt kein COM-Objekt ist ...
if (!injectedObject.GetType().IsCOMObject)
// Ausnahme werfen
throw new ArgumentException("Das angegebene Objekt ist kein COM-Objekt!","injectedObject");
// Verweis übernehmen
_realComObject = injectedObject;
}
/// <summary>
/// Erzeugt ein neues COM-Objekt anhand einer COM ProgId.
/// </summary>
/// <param name="progId"></param>
public ComObject(string progId)
{
// Wenn keine ProgId angegeben wurde ...
if (string.IsNullOrEmpty(progId))
// Ausnahme werfen
throw new ArgumentException();
// Typinformationen über die ProgId ermitteln
Type comType = Type.GetTypeFromProgID(progId);
// Wenn keine Typeninformationene gefunden wurden ...
if (comType == null)
// Ausnahme werfen
throw new TypeLoadException(string.Format("Fehler beim Laden der Typinformationen zu ProgId '{0}'.", progId));
// Instanz erzeugen
_realComObject = Activator.CreateInstance(comType);
}
/// <summary>
/// Ruft eine Funktion auf, die als Rückgabewert ein COM-Objekt (also keinen primitiven Datentyp) zurückgibt.
/// </summary>
/// <param name="functionName">Funktionsname</param>
/// <param name="parameters">Parameter</param>
/// <returns>Rückgabeobjekt</returns>
public ComObject InvokeObjectReturningFunction(string functionName, params object[] parameters)
{
// Methode aufrufen
object result = _realComObject.GetType().InvokeMember(functionName, BindingFlags.InvokeMethod | BindingFlags.OptionalParamBinding, null, _realComObject, parameters);
// Wenn ein Objekt zurückgegeben wurde ...
if (result != null)
// Rückgabeobjekt in Wrapper einpacken und zurückgeben
return new ComObject(result);
// Nichts zurückgeben
return null;
}
/// <summary>
/// Ruft eine Funktion auf.
/// </summary>
/// <param name="functionName">Funktionsname</param>
/// <param name="parameters">Parameter</param>
/// <returns>Rückgabewert</returns>
public object InvokeFunction(string functionName, params object[] parameters)
{
// Methode aufrufen und Rückgabewert zurückgeben
return _realComObject.GetType().InvokeMember(functionName, BindingFlags.InvokeMethod | BindingFlags.OptionalParamBinding, null, _realComObject, parameters);
}
/// <summary>
/// Ruft eine Prozedur auf.
/// </summary>
/// <param name="procedureName">Prozedurname</param>
/// <param name="parameters">Parameter</param>
public void InvokeProcedure(string procedureName, params object[] parameters)
{
// Methode aufrufen
_realComObject.GetType().InvokeMember(procedureName, BindingFlags.InvokeMethod | BindingFlags.OptionalParamBinding, null, _realComObject, parameters);
}
/// <summary>
/// Ruft den Wert einer Eigenschaft ab.
/// </summary>
/// <param name="propertyName">Eigenschaftsname</param>
/// <returns>Rückgabewert</returns>
public object GetProperty(string propertyName)
{
// Methode aufrufen und Rückgabewert zurückgeben
return _realComObject.GetType().InvokeMember(propertyName, BindingFlags.GetProperty | BindingFlags.OptionalParamBinding, null, _realComObject, new object[0]);
}
/// <summary>
/// Legt den Wert einer Eigenschaft fest.
/// </summary>
/// <param name="propertyName">Eigenschaftsname</param>
/// <param name="parameters">Parameter</param>
public void SetProperty(string propertyName, object value)
{
// Methode aufrufen
_realComObject.GetType().InvokeMember(propertyName, BindingFlags.OptionalParamBinding | BindingFlags.SetProperty, null, _realComObject, new object[1] { value });
}
/// <summary>
/// Ruft den Wert einer Eigenschaft ab (für Eigenschaften, die Objekte zurückgeben).
/// </summary>
/// <param name="propertyName">Eigenschaftsname</param>
/// <returns>Rückgabeobjekt</returns>
public ComObject GetObjectReturningProperty(string propertyName)
{
// Methode aufrufen und Rückgabewert zurückgeben
object result=_realComObject.GetType().InvokeMember(propertyName, BindingFlags.GetProperty | BindingFlags.OptionalParamBinding, null, _realComObject, new object[0]);
// Wenn ein Objekt zurückgegeben wurde ...
if (result != null)
// Rückgabeobjekt in Wrapper einpacken und zurückgeben
return new ComObject(result);
// Nichts zurückgeben
return null;
}
#region IDisposable Member
/// <summary>
/// Verwendete Ressourcen freigeben-
/// </summary>
public void Dispose()
{
// Wenn das COM-Objekt nocht existiert ...
if (_realComObject != null)
{
// COM-Objekt freigeben und entsorgen
Marshal.ReleaseComObject(_realComObject);
_realComObject = null;
}
}
#endregion
}
}
Wenn man z.B. Microsoft Word (Version 2000-2007) automatisch starten, dann "Hello World!" auf ein neues Dokument schreiben lassen will und Word dann auch wieder sauber beenden möchte, geht das mit dem allgemeinen COM-Wrapper in etwa so:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Rainbird.Tools.ComInterop;
namespace Tester
{
class Program
{
static void Main(string[] args)
{
// Word.Application-Objekt erzeugen
ComObject word = new ComObject("Word.Application");
// Sichtbar machen
word.SetProperty("Visible",true);
// Dokument-Auflistung abrufen
ComObject documents = word.GetObjectReturningProperty("Documents");
// Neues Dokument erzeugen
ComObject document = documents.InvokeObjectReturningFunction("Add");
// Verweise auf Dokument und Dokumentauflistung entsorgen
document.Dispose();
documents.Dispose();
// Selection-Objekt der Word-Instanz abrufen
ComObject selection = word.GetObjectReturningProperty("Selection");
// "Hello World!" in aktuelles Dokument schreiben
selection.InvokeFunction("TypeText", "Hello World!");
// Selection-Objekt entsorgen
selection.Dispose();
// Auf Drücken von Enter warten
Console.WriteLine("Drücken Sie Enter, um die Erzeugte Word-Instanz sauber zu schließen.");
Console.ReadLine();
// Word beenden ohne zu speichern
word.InvokeProcedure("Quit",0);
// Word-Instanz entsoregn
word.Dispose();
}
}
}
Wer das Word-Objektmodell ein bischen kennt, sollte sich im obigen Beispiel sofort zu Hause fühlen.
Natürlich funktioniert der Wrapper nicht nur mit Office, sondern mit beliebigen COM-Objekten.
Was noch fehlt, ist das Konsumieren von Ereignissen. Wenn ich dazu komme, rüste ich das bei Zeiten nach.
Auch das Dispose-Pattern ist noch nicht ganz vollständig implementiert. Danke nochmal für die Hinweise diesbezüglich.
Schlagwörter: COMInterop, COM, Interop, Marshal.ReleaseComObject, Reflection, Word, Office
Hey super klasse...
ich schreibe gerade ein Addin für ein Programm. Ich hatte eine Vorlage in VB.NET, welche auch super funktioniert! Ich entwickel nun das ganze in C# nach, sieht soweit ganz gut aus, bis auf ein paar Funktionen von dem System.__ComObject, z.Bsp. folgende:
Public Function RequestData_(ByVal ptDateFrom As String,
ByVal ptDateTil As String, ByRef ptDataString As Variant,
ByRef plNumberOfRecords As Long, ByRef ptError As Variant, Optional
ByVal ptTypeFilter As String = "") As Boolean
Aufrufen tue ich die Funktion wie folgt:
return (bool)MyComObject.InvokeFunction("RequestData_", new Object[] { ptDateFrom, ptDateUntil, ptDataString, plNumberOfRecords, ptError ,""});
Lt. Beschreibung sind die Parameter als ByRef definiert, in denen Werte zurückgegeben werden, welche ich für den weiteren Programmablauf benötige. Wie komme ich an diese Werte??
Vielen Dank im Vorraus!
Gruß
MacWale
Hallo MacWale,
du musst das Object-Array vorher als Variable anlegen. Dann kannst Du nach der Ausführungt von InvokeMember die Werte der ref-Parameter wieder aus dem Array rauslesen.
Siehe hier: out, ref and InvokeMember !!!
Hallo
erstmal danke für deinen Wrapper, er hat mich schon sehr weit gebracht !!
Allerdings habe ich noch ein Problem. ich arbeite gerade an meinem 1. Projekt mit ComObjekten.
ich möchte auf Bilder in einem Wordfile zugreifen
// Word.Application-Objekt erzeugen
ComObject word = new ComObject("Word.Application");
// Sichtbar machen
word.SetProperty("Visible", true);
// Dokument-Auflistung abrufen
ComObject documents = word.GetObjectReturningProperty("Documents");
// Dokument öffnen
ComObject document = documents.InvokeObjectReturningFunction("Open", @"D:\xy.doc");
ComObject Shapes = document.GetObjectReturningProperty("Shapes");
int PicCount = (int)Shapes.GetProperty("Count");
for (int i = PicCount; i > 0; i--)
{
if (Shapes[i].Type == Microsoft.Office.Core.MsoShapeType.msoPicture) // <------------
{
Shapes[i].Delete(); // <------------
} }
mein Problem sind jetzt die letzten Zeilen....
ich habe keine Ahnung wie ich das ComObjekt Shapes durchgehen kann um zB wenn es sich um ein Bild handelt diesen Shape zu löschen
ich hoffe du kannst mir helfen
LG Roschi
Hallo Rainbird,
vielen Dank für deinen Wrapper, er hat mir ebenfalls schon viel gebracht.
Da ich Items aus einer Liste holen muss, habe ich den Wrapper um eine Methode erweitert.
/// <summary>
/// Ruft das jeweilige Item ab
/// </summary>
/// <param name="index">
/// der Index
/// </param>
/// <returns>
/// das Item
/// </returns>
public ComWrapper GetItem(int index)
{
var result = this.realComObject.GetType().InvokeMember(string.Empty, BindingFlags.Default | BindingFlags.InvokeMethod, null, this.realComObject, new object[] { index });
if (result != null)
{
return new ComWrapper(result);
}
return null;
}
Falls das mal jemand braucht (auch wenn der Beitrag schon alt ist), viel Spaß damit 😃
Beste Grüße
Hallo mstoll,
schön Dir mein Office-Wrapper gefällt.
Dann könnte aber auch das folgende Open Source-Projekt für Dich interessant sein:
http://netoffice.codeplex.com/
Das ist ein versionsunabhängiger (bezogen auf die Office-Version) Wrapper für Office und bringt noch eine Menge Zusatztools mit. Damit wird es noch viel einfacher verschiedene Office-Versionen mit einer einzigen Codebasis zu unterstützen.
Hallo,
Ich habe einen COM-Wrapper für späte Bindung nach diesem Muster erstellt, functioniert wunderbar. 👍
Nun zu Problem: der COM Server enthällt Funktionen (eigentlich Sub's) welche ihre Parameter By Ref erwarten und darüber ihre Ergebnisse zurückgeben.
Hier haperts 🙁 , von diesen Funktionen erhalte ich keine Werte, ich vermute, daß bei der Parameterübergabe was schief läuft.
Das paramarray vorher als Variable anzulegen löst das Problem leider nicht, die Objecte sind dann nach der auführung von InvokeMember immer noch NULL, bzw Nothing da ich VB nutze.
Gruß
Peter
Für ref Unterstützung musst du mit der ParameterModifierStruktur arbeiten.
Danke für den wertvollen Tip
Hallo,
Der Wrapper ist Klasse und hat mir auch schon gut geholfen...nur hab ich Probleme mit der SetProperty Funktion.
Und das an zwei Unterschiedlichen stellen : Zugriff auf Header und Font-Size
Mein Code für den Headerzugriff:
//early binding: oWord.ActiveWindow.ActivePane.View.SeekView = Word.WdSeekView.wdSeekCurrentPageHeader;
Object[] objWdSeedCurrentPageHeader = new Object[1];
objWdSeedCurrentPageHeader[0] = 9;
ComObject header= word.GetObjectReturningProperty("ActiveWindow");
header= header.GetObjectReturningProperty("ActivePane");
header= header.GetObjectReturningProperty("View");
// Bis hier läuft es
header.SetProperty("SeekView", objWdSeedCurrentPageHeader);
und der Code für die Schrifgröße:
ComObject Font_Size = selection.GetObjectReturningProperty("Font");
Font_Size.SetProperty("Size", new object[1] { 12 });
Fehler:> Fehlermeldung:
Ein Aufrufziel hat einen Ausnahmefehler verursacht.
Weiß jemand wo der Fehler steckt?
Irgendwie steh ich aufm Schlauch...ist bestimmt nur irgendwas kleines dummes ^^
grüße, Minski
Bei einer TargetInvokationException immer in die InnerException schauen, da dort die eigentliche Fehlerursache eingetragen ist.
Du verschweigst leider was _selection ist.
Erstens Arrays mit Initialisierungsliste werden ohne fester Grösse angegeben.
Entferne:
new object[1] { 12 })
und setze:
new object[] { 12 })
Ich vermute mal das _selection vom Typ Word.Selection ist.
_Font.Size ist vom Typ Single und daher ersetze bitte 12 durch 12.0.
Abschliessend möchte ich dir noch das NetOffice Projekt empfehlen das auf LateBinding basiert und dich von den Low-Levels Details von LateBinding befreit.
NetOffice - Ein versionsunabhängiger Wrapper für MS-Office