{"id":55000428,"date":"2024-06-01T00:00:00","date_gmt":"2024-08-07T10:11:25","guid":{"rendered":"http:\/\/access-im-unternehmen.aix-dev.de\/aiu\/?p=428"},"modified":"-0001-11-30T00:00:00","modified_gmt":"-0001-11-30T00:00:00","slug":"Word_Dokument_mit_Ribbon_und_VBAFunktionen","status":"publish","type":"post","link":"https:\/\/vbentwickler.de\/Word_Dokument_mit_Ribbon_und_VBAFunktionen\/","title":{"rendered":"Word: Dokument mit Ribbon und VBA-Funktionen"},"content":{"rendered":"

\"\"Nicht jeder, der seine Word-Dokumente mit ein paar zusätzlichen VBA-Funktionen ausstatten möchte, will direkt ein COM-Add-In dafür programmieren. Das ist auch nicht nötig, denn wir können solche Funktionen auch einfach zu einem Word-Dokument hinzufügen und die Funktionen in einem integrierten Ribbon verfügbar machen. Wie das gelingt, zeigen wir an einem einfachen Beispiel. Dabei wollen wir das aktuelle Dokument als PDF-Dokument in das gleiche Verzeichnis wie das Dokument exportieren. Einem zweiten Ribbonbefehl fügen wir noch einen Schritt hinzu, der das frisch erstellte PDF-Dokument direkt in die Zwischenablage kopiert, damit es beispielsweise gleich in eine E-Mail eingefügt werden kann.<\/b><\/p>\n

Wenn Du eine VBA-Funktion programmiert hast, die Du dauerhaft in einem Word-Dokument verfügbar machen willst, gibt es verschiedene Möglichkeiten. Die VBA-Funktion zum Dokument hinzuzufügen, ist schnell erledigt: Du öffnest per Alt + F11 <\/b>den VBA-Editor, wechselst dort zum VBA-Projekt dieses Word-Dokuments und öffnest das VBA-Modul ThisDocument<\/b>.<\/p>\n

Hier können wir direkt eine Prozedur wie in Bild 1 hinzufügen und ausführen.<\/p>\n

\"Anlegen<\/p>\n

Bild 1: Anlegen einer VBA-Prozedur für das aktuelle Dokument<\/span><\/b><\/p>\n

Nun möchtest Du nicht immer in den VBA-Editor wechseln, um die Funktion aufzurufen, sondern diese gegebenenfalls direkt vom Ribbon aus oder über ein Kontextmenü starten. Das Anlegen eines entsprechenden Ribbon-Eintrags ist nicht besonders aufwendig und dieser kann auch mit dem aktuellen Dokument gespeichert werden.<\/p>\n

Ein Kontextmenü können wir nur mit VBA anlegen, aber auch dies schauen wir uns später an.<\/p>\n

Zunächst wollen wir die Funktion per Ribbonbefehl verfügbar machen. Dazu verwenden wir ein separates Tool, mit dem wir das Dokument öffnen. Also müssen wir das Dokument zunächst schließen.<\/p>\n

Beim Schließen erscheint jedoch der Hinweis, dass der enthaltene VBA-Code nur gespeichert werden kann, wenn wir das Dokument mit dem Typ Word-Dokument mit Makros (.dotm) <\/b>speichern, was wir direkt erledigen.<\/p>\n

Ribbon-Eintrag hinzufügen<\/h2>\n

Den Ribbon-Befehl wollen wir in einem eigenen Tab unterbringen, das die Beschriftung Mein Dokument <\/b>erhalten soll. Darin fügen wir eine Gruppe ein, die schließlich eine Schaltfläche zum Aufrufen unseres noch zu erstellenden VBA-Befehls enthält. <\/p>\n

Um dem Dokument die dafür notwendige Ribbon-Definition hinzuzufügen, nehmen wir ein Tool namens Office RibbonX Editor <\/b>zu Hilfe, das wir hier herunterladen können (sollte der Link nicht mehr verfügbar sein, hilft eine Suche nach dem Produktnamen):<\/p>\n

https:\/\/github.com\/fernandreu\/office-ribbonx-editor\/releases\/tag\/v1.9.0<\/pre>\n
Nach der Installation öffnen wir das Tool und öffnen das soeben angelegte Word-Dokument damit. Dieses erscheint nun in der linken Liste.<\/p>\n
Mit einem Rechtsklick zeigen wir das Kontextmenü an, aus dem wir den Eintrag Office 2010+ Custom UI-Abschnitt einfügen <\/b>auswählen (siehe Bild 2). Dies fügt einen neuen Untereintrag namens customUI14.xml <\/b>zum Dokument hinzu.<\/p>\n
\"Einfügen<\/p>\n
Bild 2: Einfügen eines Custom UI-Abschnitts<\/span><\/b><\/p>\n
Ein Doppelklick zeigt im rechten Bereich den Inhalt dieses Abschnitts an, den wir nun mit dem gewünschten XML-Code füllen:<\/p>\n
<customUI xmlns=\"http:\/\/schemas.microsoft.com\/    office\/2009\/07\/customui\">\r\n   <ribbon>\r\n     <tabs>\r\n       <tab id=\"tab\" label=\"Mein Dokument\">\r\n         <group id=\"grp\" label=\"PDF\">\r\n           <button id=\"btnExportPDF\" label=\"PDF exportieren\" \r\n               size=\"large\" image=\"PDF\"               onAction=\"ExportPDF\"\/>\r\n         <\/group>\r\n       <\/tab>\r\n     <\/tabs>\r\n   <\/ribbon>\r\n<\/customUI><\/pre>\n
Damit auch noch ein hübsches Icon angezeigt wird, fügen wir dieses über den Kontextmenübefehl wie in Bild 3 hinzu.<\/p>\n
\"Einfügen<\/p>\n
Bild 3: Einfügen des Icons und des XML-Codes<\/span><\/b><\/p>\n
Den Namen, der nun unter dem Eintrag customUI14.xml <\/b>für die Ribbondefinition angezeigt wird, fügen wir für das Attribut image <\/b>des button<\/b>-Elements ein.<\/p>\n
Um uns noch ein wenig die Arbeit zu erleichtern, klicken wir nun auf die Schaltfläche VBA-Methoden generieren <\/b>in diesem Tool und kopieren den Inhalt aus dem nun erscheinenden Fenster Methodenbetrachter<\/b> (siehe Bild 4).<\/p>\n
\"Ermitteln<\/p>\n
Bild 4: Ermitteln des Codes für die Ribbon-Schaltfläche<\/span><\/b><\/p>\n
VBA-Funktion anpassen<\/h2>\n
Damit können wir dieses Tool schließen und das Word-Dokument erneut öffnen.<\/p>\n
Hier fügen wir nun den kopierten Code in die Klasse des aktuellen Dokuments ein und fügen noch eine Zeile hinzu, die eine Testmeldung ausgibt:<\/p>\n
Sub <\/span>ExportPDF(control As <\/span>IRibbonControl)\r\n     MsgBox<\/span> \"Steuerlemenet ''\" & control.ID _\r\n         & \"'' wurde angeklickt.\"\r\nEnd Sub<\/span><\/pre>\n
Wechseln wir dann zurück zum Word-Dokument, sehen wir im Ribbon das neue Tab-Element und können die Schaltfläche betätigen (siehe Bild 5).<\/p>\n
\"Der<\/p>\n
Bild 5: Der Klick auf die Ribbon-Schaltfläche funktioniert bereits.<\/span><\/b><\/p>\n
Funktion zum Exportieren als PDF hinzufügen<\/h2>\n
Wir wollten dem Dokument eine Funktion hinzufügen, mit dem wir dieses als PDF-Dokument speichern können. Dazu passen wir die durch die Ribbonschaltfläche ausgelöste Prozedur wie folgt an:<\/p>\n
Sub <\/span>ExportPDF(control As <\/span>IRibbonControl)\r\n      Dim <\/span>doc As <\/span>Word.Document\r\n      Dim <\/span>strDateipfad As String<\/span>\r\n      Set<\/span> doc = ActiveDocument\r\n      strDateipfad = doc.Path & \"\\\" _\r\n          & Replace<\/span>(doc.Name, \".docm\", \".pdf\")\r\n      doc.ExportAsFixedFormat _\r\n          OutputFileName:=strDateipfad, _\r\n         ExportFormat:=wdExportFormatPDF\r\n      Set<\/span> doc = Nothing\r\nEnd Sub<\/span><\/pre>\n
Die Prozedur referenziert das aktuelle Dokument und legt den Pfad für die zu erstellende PDF-Datei auf den Ordner des aktuellen Dokuments plus den Namen fest, wobei im Namen die Dateiendung .dotm <\/b>durch .pdf <\/b>ersetzt wird.<\/p>\n
Klicken wir nun auf die Schaltfläche, erstellen wir ein Dokument gleichen Namens im PDF-Format, das die Dateiendung .pdf <\/b>enthält.<\/p>\n
Funktion zum zusätzlichen Speichern in der Zwischenablage hinzufügen<\/h2>\n
Wenn wir zusätzlich noch eine Schaltfläche hinzufügen wollen, welche das erstellte PDF-Dokument automatisch in die Zwischenablage kopiert, können wir dies in wenigen Schritten erledigen.<\/p>\n
Dazu schließen wir das Word-Dokument wieder und öffnen es erneut mit dem Tool Office RibbonX Editor<\/b>. Hier fügen wir ein neues Icon namens clipboard <\/b>hinzu und ergänzen den XML-Code im einzigen group<\/b>-Element um ein weiteres button<\/b>-Element:<\/p>\n
...\r\n<group id=\"grp\" label=\"PDF\">\r\n     ...\r\n     <button id=\"btnExportPDFAndAddToClipboard\"         label=\"PDF in Zwischenablage\" size=\"large\"         image=\"clipboard\"         onAction=\"ExportPDFAndAddToClipboard\"\/>\r\n<\/group>\r\n...<\/pre>\n
Dies sieht nach dem Schließen und dem erneuten Öffnen des Word-Dokuments in Word wie in Bild 6 aus.<\/p>\n
\"Weitere<\/p>\n
Bild 6: Weitere Ribbon-Schaltfläche<\/span><\/b><\/p>\n
Sub <\/span>ExportPDFAndAddToClipboard(control As <\/span>IRibbonControl)\r\n     ''... wie in Prozedur \"ExportPDF\"\r\n     If <\/span>CopyFileToClipboard(strDateipfad) = True<\/span> Then<\/span>\r\n         MsgBox<\/span> \"PDF erstellt und in Zwischenablage \" _\r\n             & \"kopiert.\", vbOKOnly + vbInformation, _\r\n             \"PDF in Zwischenablage\"\r\n     Else<\/span>\r\n         MsgBox<\/span> \"Kopieren in Zwischenablage nicht \" _\r\n             & \"erfolgreich.\", vbOKOnly + vbExclamation, _\r\n             \"PDF in Zwischenablage\"\r\n     End If<\/span>\r\nEnd Sub<\/span><\/pre>\n
Die dort verwendete Funktion finden wir in VBA: Dateien in Zwischenablage kopieren (32\/64-Bit) <\/b>(www.vbentwickler.de\/427<\/b>). Wir haben diese im VBA-Projekt des Word-Dokuments im Modul mdlClipboardFiles <\/b>eingefügt.<\/p>\n
Nun können wir das aktuelle Word-Dokument in eine PDF-Datei speichern und diese direkt automatisch in die Zwischenablage einfügen.<\/p>\n
Zusammenfassung und Ausblick<\/h2>\n
Dieser Artikel zeigt, wie wir ein Word-Dokument um ein Ribbon mit benutzerdefinierten Befehlen erweitern können.<\/p>\n
Diese Befehle lösen außerdem benutzerdefinierte Funktionen aus, mit denen wir in diesem Fall das aktuelle Word-Dokument in eine PDF-Datei speichern und diese gegebenenfalls direkt in die Zwischenablage einfügen.<\/p>\n
Aufbauend auf dieser Lösung kannst Du nun beliebige Vorgänge, die Du automatisieren möchtest, in Dein VBA-Projekt einfügen und über zusätzliche Ribbon-Schaltflächen verfügbar machen.<\/p>\n
Wenn Du Ideen für solche Funktionen hast, schreibe Deine Anregungen einfach an support@minhorst.com <\/b>– wir sehen, was wir daraus machen können.<\/p>\n
Downloads zu diesem Beitrag<\/h2>\n
Enthaltene Beispieldateien:<\/p>\n
DokumentMitVBAUndRibbon.docm<\/p>\n
Download<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"
Nicht jeder, der seine Word-Dokumente mit ein paar zusätzlichen VBA-Funktionen ausstatten möchte, will direkt ein COM-Add-In dafür programmieren. Das ist auch nicht nötig, denn wir können solche Funktionen auch einfach zu einem Word-Dokument hinzufügen und die Funktionen in einem integrierten Ribbon verfügbar machen. Wie das gelingt, zeigen wir an einem einfachen Beispiel. Dabei wollen wir das aktuelle Dokument als PDF-Dokument in das gleiche Verzeichnis wie das Dokument exportieren. Einem zweiten Ribbonbefehl fügen wir noch einen Schritt hinzu, der das frisch erstellte PDF-Dokument direkt in die Zwischenablage kopiert, damit es beispielsweise gleich in eine E-Mail eingefügt werden kann.<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"om_disable_all_campaigns":false,"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"_uf_show_specific_survey":0,"_uf_disable_surveys":false,"footnotes":""},"categories":[662024,66032024,44000028],"tags":[],"yst_prominent_words":[],"class_list":["post-55000428","post","type-post","status-publish","format-standard","hentry","category-662024","category-66032024","category-Word_programmieren"],"aioseo_notices":[],"aioseo_head":"\n\t\t\n\t\n\t\n\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t