{"id":55000468,"date":"2025-06-01T00:00:00","date_gmt":"2025-08-27T13:46:23","guid":{"rendered":"http:\/\/access-im-unternehmen.aix-dev.de\/aiu\/?p=468"},"modified":"-0001-11-30T00:00:00","modified_gmt":"-0001-11-30T00:00:00","slug":"BackstageBereich_von_Office_erweitern","status":"publish","type":"post","link":"https:\/\/vbentwickler.de\/BackstageBereich_von_Office_erweitern\/","title":{"rendered":"Backstage-Bereich von Office erweitern"},"content":{"rendered":"

Wenn man eine der Office-Anwendungen um ein selbst programmiertes COM-Add-In erweitern möchte, kann man den Backstage-Bereich nutzen, um eventuell notwendige Optionen für dieses COM-Add-In dort abzubilden. Wir würden dann einen eigenen Reiter auf der linken Seite des Backstage-Bereichs platzieren, über den wir einen eigenen Bereich anzeigen können. Diesem wiederum können wir verschiedene Steuerelemente für die Anzeige und Eingabe von Optionen hinzufügen. Dieser Artikel zeigt, wie wir ein einfaches COM-Add-In mit twinBASIC erstellen und dieses mit der Definition einer Backstage-Erweiterung ausstatten und wie diese Erweiterung beim Starten der Anwendung angezeigt wird.<\/b><\/p>\n

Mit twinBASIC<\/b>, der Entwicklungsumgebung von Wayne Philips, lassen sich einfach COM-Add-Ins erstellen, mit denen wir auch den Backstage-Bereich anpassen können.<\/p>\n

twinBASIC <\/b>in der jeweils aktuellen Version kannst Du hier herunterladen:<\/p>\n

https:\/\/github.com\/twinbasic\/twinbasic\/releases<\/pre>\n
Nach dem Kopieren der enthaltenen Dateien in einen beliebigen Ordner können wir twinBASIC mit einem Doppelklick auf die .exe<\/b>-Datei starten. Wir landen dann im Startbildschirm, wo wir auf der Seite Samples den Eintrag Sample 5. MyCOMAddin <\/b>auswählen (siehe Bild 1).<\/p>\n
\"Erstellen<\/p>\n
Bild 1: Erstellen eines COM-Add-Ins auf Basis des Beispiels<\/span><\/b><\/p>\n
Im nächsten Dialog können wir bereits den Projektnamen festlegen (siehe Bild 2). Die übrigen Optionen behalten wir bei.<\/p>\n
\"Festlegen<\/p>\n
Bild 2: Festlegen des Projektnamens<\/span><\/b><\/p>\n
Damit haben wir bereits ein COM-Add-In-Projekt angelegt, das wir nun direkt testen können. Dazu schließen wir alle eventuell geöffneten Access- und Excel-Anwendungen, denn für dieses ist die Demo ausgelegt. <\/p>\n
Danach betätigen wir den Menübefehl File|Build <\/b>(siehe Bild 3). Dies erstellt, nachdem wir den Speicherort für die Projektdatei angegeben haben, das COM-Add-In.<\/p>\n
\"Projekt<\/p>\n
Bild 3: Projekt erstellen<\/span><\/b><\/p>\n
Das bedeutet, dass die DLL für das COM-Add-In erstellt und in die Registry eingetragen wird. Diese Registry-Einträge werden beim Start der Office-Anwendungen ausgelesen und sorgen dafür, dass die im COM-Add-In angegebenen Ereignisprozeduren ausgeführt werden, sodass das COM-Add-In bereits beim nächsten Start ausführbereit ist.<\/p>\n
Erster Test in Excel<\/h2>\n
Starten wir nun Excel und öffnen ein Workbook, sehen wir im Ribbon einen neuen Registerreiter namens twinBASIC Test<\/b>, der eine Schaltfläche namens Hello World <\/b>enthält. Klicken wir diese an, wird die provisorische Methode zum Anzeigen einer Meldung ausgeführt (siehe Bild 4).<\/p>\n
\"Die<\/p>\n
Bild 4: Die Funktion des neuen COM-Add-Ins ist nun direkt in der jeweiligen Office-Anwendung verfügbar.<\/span><\/b><\/p>\n
Zielanwendung definieren<\/h2>\n
In twinBASIC finden wir im PROJECT EXPLORER<\/b> unter Sources zwei Module. Das Modul DllRegistration <\/b>enthält den Code, der das COM-Add-In für die gewünschten Office-Anwendungen installiert. Im oberen Bereich werden verschiedene Konstanten definieren mit den Pfaden der Registry, in denen die Registry-Informationen beim Registrieren eingetragen werden sollen (siehe Listing 1). Wichtig: Hier muss für AddinClassName <\/b>der Name der soeben umbenannten Klasse eingetragen werden, also Backstage<\/b>.<\/p>\n
Const AddinProjectName As String<\/span> = VBA.Compilation.CurrentProjectName\r\nConst AddinClassName As String<\/span> = \"Backstage\"\r\nConst AddinQualifiedClassName As String<\/span> = AddinProjectName & \".\" & AddinClassName\r\nConst RootRegistryFolder_ACCESS As String<\/span> = \"HKCU\\SOFTWARE\\Microsoft\\Office\\Access\\Addins\\\" & AddinQualifiedClassName & \"\\\"\r\nConst RootRegistryFolder_EXCEL As String<\/span> = \"HKCU\\SOFTWARE\\Microsoft\\Office\\Excel\\Addins\\\" & AddinQualifiedClassName & \"\\\"\r\nConst RootRegistryFolder_WORD As String<\/span> = \"HKCU\\SOFTWARE\\Microsoft\\Office\\Word\\Addins\\\" & AddinQualifiedClassName & \"\\\"\r\nConst RootRegistryFolder_OUTLOOK As String<\/span> = \"HKCU\\SOFTWARE\\Microsoft\\Office\\Outlook\\Addins\\\" & AddinQualifiedClassName & \"\\\"\r\nConst RootRegistryFolder_POWERPOINT As String<\/span> = \"HKCU\\SOFTWARE\\Microsoft\\Office\\Powerpoint\\Addins\\\" _\r\n         & AddinQualifiedClassName & \"\\\"<\/pre>\n
Listing 1: Konstanten für das Registrieren des COM-Add-Ins für die jeweilige Office-Anwendung<\/span><\/b><\/p>\n
Die Funktion DllRegisterServer <\/b>erledigt das Eintragen der notwendigen Informationen in der Registry (siehe Listing 2).<\/p>\n
Public Function <\/span>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_ACCESS & \"FriendlyName\", AddinProjectName, \"REG_SZ\"\r\n     wscript.RegWrite RootRegistryFolder_ACCESS & \"Description\", AddinProjectName, \"REG_SZ\"\r\n     wscript.RegWrite RootRegistryFolder_ACCESS & \"LoadBehavior\", 3, \"REG_DWORD\"\r\n     \r\n     wscript.RegWrite RootRegistryFolder_EXCEL & \"FriendlyName\", AddinProjectName, \"REG_SZ\"\r\n     wscript.RegWrite RootRegistryFolder_EXCEL & \"Description\", AddinProjectName, \"REG_SZ\"\r\n     wscript.RegWrite RootRegistryFolder_EXCEL & \"LoadBehavior\", 3, \"REG_DWORD\"\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     \r\n     wscript.RegWrite RootRegistryFolder_OUTLOOK & \"FriendlyName\", AddinProjectName, \"REG_SZ\"\r\n     wscript.RegWrite RootRegistryFolder_OUTLOOK & \"Description\", AddinProjectName, \"REG_SZ\"\r\n     wscript.RegWrite RootRegistryFolder_OUTLOOK & \"LoadBehavior\", 3, \"REG_DWORD\"\r\n     \r\n     wscript.RegWrite RootRegistryFolder_POWERPOINT & \"FriendlyName\", AddinProjectName, \"REG_SZ\"\r\n     wscript.RegWrite RootRegistryFolder_POWERPOINT & \"Description\", AddinProjectName, \"REG_SZ\"\r\n     wscript.RegWrite RootRegistryFolder_POWERPOINT & \"LoadBehavior\", 3, \"REG_DWORD\"\r\n     Return True<\/span>\r\nRegError:\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\nEnd Function<\/span><\/pre>\n
Listing 2: Funktion zum Eintragen der COM-Add-In-Informationen in die Registry<\/span><\/b><\/p>\n
Wir haben hier zu Beispielzwecken einmal die Eintragungen für alle fünf Office-Anwendungen eingetragen, also für Access, Excel, Outlook, Word und PowerPoint. Es werden jeweils vier Einträge für den entsprechenden Registry-Zweig angelegt.<\/p>\n
In Bild 5 sehen wir diese Einträge für Word. Unter AddIns <\/b>befinden sich alle aktuell registrieren Add-Ins, hier auch das von uns hinzugefügte COM-Add-In namens amvBackstage<\/b>.<\/p>\n
\"Eintrag<\/p>\n
Bild 5: Eintrag für ein COM-Add-In für Word<\/span><\/b><\/p>\n
Je nachdem, für welche Anwendung Du ein COM-Add-In mit einer Anpassung des Backstage-Bereichs hinzufügen möchtest, kannst Du einen oder mehrere der fünf Konstanten und Anweisungen zum Eintragen in die Registry beibehalten, die Übrigen können auskommentiert werden.<\/p>\n
Registrierung aufheben<\/h2>\n
Wenn das COM-Add-In aus der Registrierung entfernt werden und somit nicht mehr beim Start der jeweiligen Office-Anwendungen aufgerufen werden soll, müssen wir die Funktion DllUnregisterServer <\/b>ausführen (siehe Listing 3).<\/p>\n
Public Function <\/span>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_ACCESS & \"FriendlyName\"\r\n     wscript.RegDelete RootRegistryFolder_ACCESS & \"Description\"\r\n     wscript.RegDelete RootRegistryFolder_ACCESS & \"LoadBehavior\"\r\n     wscript.RegDelete RootRegistryFolder_ACCESS\r\n     wscript.RegDelete RootRegistryFolder_EXCEL & \"FriendlyName\"\r\n     wscript.RegDelete RootRegistryFolder_EXCEL & \"Description\"\r\n     wscript.RegDelete RootRegistryFolder_EXCEL & \"LoadBehavior\"\r\n     wscript.RegDelete RootRegistryFolder_EXCEL\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     \r\n     wscript.RegDelete RootRegistryFolder_OUTLOOK & \"FriendlyName\"\r\n     wscript.RegDelete RootRegistryFolder_OUTLOOK & \"Description\"\r\n     wscript.RegDelete RootRegistryFolder_OUTLOOK & \"LoadBehavior\"\r\n     wscript.RegDelete RootRegistryFolder_OUTLOOK\r\n     \r\n     wscript.RegDelete RootRegistryFolder_POWERPOINT & \"FriendlyName\"\r\n     wscript.RegDelete RootRegistryFolder_POWERPOINT & \"Description\"\r\n     wscript.RegDelete RootRegistryFolder_POWERPOINT & \"LoadBehavior\"\r\n     wscript.RegDelete RootRegistryFolder_POWERPOINT\r\n     \r\n     Return True<\/span>    \r\nRegError:\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\nEnd Function<\/span><\/pre>\n
Listing 3: Funktion zum Entfernen der Einträge für das COM-Add-In aus der Registry<\/span><\/b><\/p>\n
Auch hier sind wieder die Anweisungen für das Entfernen der Registry-Einträge für alle fünf Office-Anwendungen enthalten. Wenn nur Registrierungen für bestimmte Office-Anwendungen hinterlegt wurden, können wir auch die entsprechenden Anweisungen zum Entfernen der Registry-Einträge entfernen.<\/p>\n
Die beiden Funktionen DllRegisterServer<\/b> und DllUnregisterServer <\/b>werden übrigens nicht nur aufgerufen, wenn wir in twinBASIC den Befehl File|Build <\/b>ausführen. Auch wenn die wir so erstellte DLL später mit dem Befehl Regsvr32.exe <\/b>registrieren, werden diese ausgeführt. Das Gleiche gilt für das Aufhaben der Registrierung, wobei wir Regsvr32.exe <\/b>dann noch den Parameter \/u <\/b>übergeben müssen.<\/p>\n
Klasse des COM-Add-Ins anpassen<\/h2>\n
Damit kommen wir zum eigentlichen Teil des COM-Add-Ins, den wir mit der Definition einer Backstage-Erweiterung ausstatten wollen. Diese finden wir im Modul, das im Demo-Projekt MyCOMAddin.twin <\/b>heißt. Dieses benennen wir erst einmal um, zum Beispiel in Backstage.twin<\/b>. Dazu darf das Modul aktuell nicht geöffnet sein. Danach öffnen wir das Modul Backstage.twin <\/b>und ändern auch dort noch den eigentlichen Klassennamen von MyCOMAddIn <\/b>auf Backstage<\/b> (siehe Bild 6).<\/p>\n
\"Umbenennen<\/p>\n
Bild 6: Umbenennen der Hauptklasse des COM-Add-Ins<\/span><\/b><\/p>\n
Nun beginnen wir mit der eigentlichen Erstellung der Backstage<\/b>-Anpassung.<\/p>\n
Backstage für das COM-Add-In anzeigen<\/h2>\n
Im Modul Backstage.twin <\/b>finden wir nun folgende Bestandteile:<\/p>\n