twinBASIC<\/h2>\n
Auch das Tool, das wir zum Erstellen des COM-Add-Ins nutzen, ist zumindest in der Variante, die das Erstellen von 32-Bit-Dateien erlaubt, kostenlos. Du findest weitere Informationen dazu zum Beispiel in twinBASIC: Visual Basic für die Zukunft <\/b>(www.vbentwickler.de\/310<\/b>), COM-Add-Ins mit twinBASIC <\/b>(www.vbentwickler.de\/311<\/b>) und Ribbon-Signaturen für VBA, VB6 und twinBASIC <\/b>(www.vbentwickler.de\/314<\/b>).<\/p>\nZiel des Artikels<\/h2>\n
Bevor wir in die Programmierung einsteigen, schauen wir uns den Plan an. Das Ziel ist es, dass wir per Mausklick auf einen Ribbon-Eintrag einen Übersetzungsvorgang starten können. Dieser Vorgang soll entweder den aktuell markierten Text übersetzen oder, wenn keine Markierung vorhanden ist, den Absatz übersetzen, in dem sich aktuell die Einfügemarke befindet.<\/p>\n
Neben dem Button für das eigentliche Übersetzen benötigen wir natürlich noch eine Möglichkeit, die Original- und die Zielsprache festzulegen. Dies wollen wir ebenfalls im Ribbon ermöglichen, indem wir die verfügbaren Sprachen dort zur Auswahl anbieten.<\/p>\n
Anlegen eines twinBASIC-Projekts<\/h2>\n
Für das COM-Add-In benötigen wir ein twinBASIC-Projekt, welches wir nach dem Öffnen von twinBASIC auf Basis des Beispielprojekts Sample 5. MyCOMAddIn <\/b>erstellen (siehe Bild 1).<\/p>\n
![\"Auswahl](\"..\/fileadmin\/_temp_\/2023_01\/pic_347_001.png\")
<\/p>\n
Bild 1: Auswahl einer Vorlage<\/span><\/b><\/p>\n Wir schauen uns nicht im Detail an, welche Änderungen wir an dem bestehenden Code vornehmen, sondern beschreiben im Anschluss den neuen Code des COM-Add-Ins.<\/p>\n Wir wollen das Add-In nutzen, um auf das Objektmodell von Word zuzugreifen und die darin markierten Elemente auslesen, um diese zu übersetzen.<\/p>\n Damit wir dabei nicht mit Late Binding arbeiten müssen, fügen wir einen Verweis auf die Bibliothek Microsoft Word 16.0 Object Library <\/b>hinzu. Außerdem brauchen wir noch einen Verweis auf die Bibliothek Microsoft XML, v6.0<\/b>.<\/p>\n Dieser liefert das Objekt ServerXMLHTTP60<\/b>, das wir für den Zugriff auf die DeepL<\/b>-REST-API benötigen.<\/p>\n Diese Verweise fügen wir in twinBASIC im Bereich Settings <\/b>hinzu. Hier scrollen wir ein wenig nach unten und finden dort den Bereich COM Type Library \/ ActiveX References<\/b>. In der unteren Liste namens ALL AVAILABLE COM REFERENCES <\/b>können wir nach den Namen dieser beiden Bibliotheken suchen und sie durch Setzen eines Hakens zum Projekt hinzufügen (siehe Bild 2).<\/p>\n Bild 2: Hinzufügen von Verweisen<\/span><\/b><\/p>\n Bevor wir die Änderungen nach dem Hinzufügen der Verweise speichern, was vor dem Kompilieren unbedingt notwendig ist, stellen wir gleich noch ein paar weitere Eigenschaften ein. Dabei handelt es sich um den Projektnamen, die Projektbeschreibung und den Anwendungstitel. Alle drei stellen wir im oberen Bereich unter Settings ein (siehe Bild 3).<\/p>\n Bild 3: Ändern weiterer Projekteigenschaften<\/span><\/b><\/p>\n Danach speichern wir das Projekt und geben als Namen beispielsweise amvWordTranslator.twinproj<\/b> an.<\/p>\n Bevor wir uns um die eigentliche Funktionalität kümmern, fügen wir noch ein neues Modul hinzu. Dazu klicken wir mit der rechten Maustaste auf den Eintrag Sources <\/b>im Projekt-Explorer und wählen dort den Eintrag Add|Add Module <\/b>aus (siehe Bild 4).<\/p>\n Bild 4: Hinzufügen eines neuen Moduls<\/span><\/b><\/p>\n Das noch leere Modul nennen wir mdlDeepL <\/b>und fügen diesem den Code hinzu, den wir im Artikel Texte übersetzen mit DeepL <\/b>(www.vbentwickler.de\/322<\/b>) entworfen haben.<\/p>\n Das Beispielprojekt enthält normalerweise den Code, um das COM-Add-In für den Gebrauch in Excel und Access zu registrieren. Diesen müssen wir anpassen, denn wir wollen unser COM-Add-In in Word anzeigen. Dazu öffnen wir das Modul DLLRegistration<\/b>. Dieses passen wir nun an beziehungsweise gestalten es neu. Das Ergebnis kannst Du Listing 1 entnehmen.<\/p>\n Listing 1: Das Modul mit dem Code zum Registrieren und De-Registrieren des COM-Add-Ins<\/span><\/b><\/p>\n Hier definieren wir zunächst einige Konstanten. Die erste enthält den Projektnamen. Diesen lesen wir aus VBA.Compilation.CurrentProjectName <\/b>aus, den wir zuvor in den Einstellungen des Projekts festgelegt haben.<\/p>\n Den Klassennamen stellen wir auf amvWordTranslator ein. Diese Bezeichnung sollten wir gleich beim Gestalten des Hauptmoduls als Bezeichnung des Moduls als auch als Name der darin enthaltenen Klasse verwenden.<\/p>\n Schließlich stellen wir in AddinQualifiedClassName <\/b>noch die Kombination aus AddinProjectName <\/b>und AddinClassName <\/b>zusammen – getrennt durch einen Punkt. Diese Bezeichnung verwenden wir für den Eintrag in der Registry.<\/p>\n Um die Einträge in der Registry an der richtigen Stelle anzulegen, erstellen wir in der Konstanten RootRegistryFolder_WORD <\/b>den Pfad für den anzulegenden Basispfad.<\/p>\n Dieser lautet in unserem Fall:<\/p>\n Die folgende Prozedur DllRegisterServer <\/b>führt mithilfe des Shell<\/b>-Objekts die notwendigen Eintragungen in der Registry durch. Dazu erstellt sie zuerst ein Objekt des Typs wscript.shell <\/b>und ruft dann mehrfach dessen Methode RegWrite <\/b>auf. Dieser übergibt sie den Pfad, den Namen des Eintrags und den gewünschten Wert sowie den Datentyp. Ist dies erfolgreich, liefert die Funktion den Wert True <\/b>zurück, anderenfalls erscheint eine entsprechende Fehlermeldung.<\/p>\n Der durch diese Funktion erstellte Eintrag in der Registry sieht beispielsweise wie in Bild 5 aus.<\/p>\n Bild 5: Registry-Einträge für das COM-Add-In<\/span><\/b><\/p>\n Die zweite Funktion namens DllUnregisterServer <\/b>enthält die Anweisungen, um die soeben vorgenommenen Einträge in die Registry wieder zu entfernen. Sie nutzt das gleiche Objekt, aber diesmal die Methode RegDelete<\/b>. Hier muss nur noch die Pfad zu den zu löschenden Registry-Einträgen angegeben werden.<\/p>\n Diese beiden Funktionen kann man übrigens auch direkt von twinBASIC aus aufrufen – wenn also einmal nur ein Registry-Eintrag nicht korrekt ist, braucht man das Projekt nicht neu zu erstellen.<\/p>\n Allerdings geht auch das Erstellen sehr schnell, sodass sich das separate Aufrufen der Funktionen in diesem Fall nicht lohnt. Lohnenswert ist dies allerdings, wenn man einmal das Schreiben oder Löschen der Registry-Werte debuggen möchte.<\/p>\n Damit kommen wir zur der Hauptklasse der Anwendung, welche die eigentliche Funktionalität enthält. Das beginnt mit den Ereignissen, die beim Öffnen von Word ausgelöst werden und die dazu führen, dass das Add-In gestartet und das Ribbon der Anwendung in Word integriert wird. Außerdem enthält die Klasse die Methoden, die durch das Betätigen der Ribbonelemente des COM-Add-Ins ausgelöst werden. Die Klasse enthält wie alle COM-Add-Ins einen eindeutigen Bezeichner, der in eckigen Klammern im Kopf des Klassenmoduls angegeben wird:<\/p>\n Direkt danach beginnt die Definition der Klasse und ihrer Elemente. Hier haben wir das Class<\/b>-Schlüsselwort und zunächst zwei Implements<\/b>-Anweisungen. Damit geben wir an, dass wir die Schnittstellen IDExtensibility2 <\/b>und IRibbonExtensibility <\/b>in dieser Klasse implementieren:<\/p>\n Das bedeutet für die aufrufende Anwendung, in diesem Fall Word<\/b>, dass sie in dieser Klasse die Implementierungen der Methoden der angegebenen Schnittstellen findet und diese aufrufen soll. Im Falle von IDTExtensibility <\/b>heißt das beispielsweise, dass beim Start von Word die Methode OnConnection <\/b>aufgerufen werden soll – mehr dazu gleich im Anschluss.<\/p>\n Vorher sehen wir uns noch die drei Variablen an, die wir hier benötigen. Die erste ist eine Objektvariable zum Speichern des Verweises auf die Word-Instanz, welche das COM-Add-In initialisiert hat.<\/p>\n Diese Variable können wir, nachdem wir sie gleich zugewiesen haben, nutzen, um vom COM-Add-In auf die Word-Instanz und das darin enthaltene Dokument zuzugreifen:<\/p>\n Außerdem legen wir noch zwei Variablen fest für die Originalsprache sowie die Zielsprache der Übersetzung. Diese erhalten als Datentyp die Enumerationen der beiden Auflistungen aus dem Modul mdlDeepL<\/b>:<\/p>\n Möchten Sie weiterlesen? Dann lösen Sie Ihr Ticket!<\/span>Hinzufügen benötigter Verweise<\/h2>\n
![\"Hinzufügen](\"..\/fileadmin\/_temp_\/2023_01\/pic_347_002.png\")
<\/p>\nWeitere Projekteinstellungen anpassen<\/h2>\n
![\"Ändern](\"..\/fileadmin\/_temp_\/2023_01\/pic_347_003.png\")
<\/p>\nModul mit DeepL-Funktionen einfügen<\/h2>\n
![\"Hinzufügen](\"..\/fileadmin\/_temp_\/2023_01\/pic_347_004.png\")
<\/p>\nCode zum Registrieren und De-Registrieren anpassen<\/h2>\n
Module DllRegistration\r\n Const AddinProjectName As String<\/span> = VBA.Compilation.CurrentProjectName\r\n Const AddinClassName As String<\/span> = \"amvWordTranslator\"\r\n Const AddinQualifiedClassName As String<\/span> = AddinProjectName & \".\" & AddinClassName\r\n Const RootRegistryFolder_WORD As String<\/span> = \"HKCU\\SOFTWARE\\Microsoft\\Office\\Word\\Addins\\\" & AddinQualifiedClassName & \"\\\"\r\n \r\n Public <\/span>Function DllRegisterServer() As Boolean<\/span>\r\n On Error GoTo<\/span> RegError\r\n Dim <\/span>wscript As Object<\/span> = CreateObject(\"wscript.shell\")\r\n wscript.RegWrite RootRegistryFolder_WORD & \"FriendlyName\", AddinProjectName, \"REG_SZ\"\r\n wscript.RegWrite RootRegistryFolder_WORD & \"Description\", AddinProjectName, \"REG_SZ\"\r\n wscript.RegWrite RootRegistryFolder_WORD & \"LoadBehavior\", 3, \"REG_DWORD\"\r\n Return True<\/span>\r\n RegError:\r\n MsgBox<\/span> \"DllRegisterServer -- An error occured trying to write to the system registry:\" & vbCrLf<\/span> & _\r\n Err.Description & \" (\" & Hex(Err.Number) & \")\"\r\n Return False<\/span>\r\n End Function\r\n \r\n Public <\/span>Function DllUnregisterServer() As Boolean<\/span>\r\n On Error GoTo<\/span> RegError\r\n Dim <\/span>wscript As Object<\/span> = CreateObject(\"wscript.shell\")\r\n wscript.RegDelete RootRegistryFolder_WORD & \"FriendlyName\"\r\n wscript.RegDelete RootRegistryFolder_WORD & \"Description\"\r\n wscript.RegDelete RootRegistryFolder_WORD & \"LoadBehavior\"\r\n wscript.RegDelete RootRegistryFolder_WORD\r\n Return True<\/span>\r\n RegError:\r\n MsgBox<\/span> \"DllUnregisterServer -- An error occured trying to delete from the system registry:\" & vbCrLf<\/span> & _\r\n Err.Description & \" (\" & Hex(Err.Number) & \")\"\r\n Return False<\/span>\r\n End Function\r\nEnd Module<\/pre>\nHKCU\\SOFTWARE\\Microsoft\\Office\\Word\\Addins\\amvWordTranslator.amvWordTranslator\\<\/pre>\n
![\"Registry-Einträge](\"..\/fileadmin\/_temp_\/2023_01\/pic_347_005.png\")
<\/p>\nDie Klasse amvWordTranslator<\/h2>\n
[ ClassId (\"F333F038-C5F7-4AA3-8684-09A024EC892C\") ]<\/pre>\n
Class<\/span> amvWordTranslator\r\n Implements IDTExtensibility2\r\n [ WithDispatchForwarding ]\r\n Implements IRibbonExtensibility<\/pre>\n Private <\/span>objWord As <\/span>Word.Application<\/pre>\n Public <\/span>intSourceLanguage As <\/span>SourceLanguage\r\n Public <\/span>intTargetLanguage As <\/span>TargetLanguage\r\n...\r\nEnd Class<\/span><\/pre>\n
\nHier geht es zur Bestellung des Jahresabonnements des Magazins Visual Basic Entwickler<\/strong>:<\/span>
\nZur Bestellung ...<\/a><\/span>
\nDanach greifen Sie sofort auf alle rund 200 Artikel<\/strong> unseres Angebots zu - auch auf diesen hier!<\/span>
\nOder haben Sie bereits Zugangsdaten? Dann loggen Sie sich gleich hier ein:<\/span><\/p>\n<\/div>\n\n\t\n\t