{"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":"<p><img loading=\"lazy\" decoding=\"async\" src=\"http:\/\/vg08.met.vgwort.de\/na\/8ebbb25be3a74b689124ff61faaaacf7\" width=\"1\" height=\"1\" alt=\"\"><b>Nicht jeder, der seine Word-Dokumente mit ein paar zus&auml;tzlichen VBA-Funktionen ausstatten m&ouml;chte, will direkt ein COM-Add-In daf&uuml;r programmieren. Das ist auch nicht n&ouml;tig, denn wir k&ouml;nnen solche Funktionen auch einfach zu einem Word-Dokument hinzuf&uuml;gen und die Funktionen in einem integrierten Ribbon verf&uuml;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&uuml;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&uuml;gt werden kann.<\/b><\/p>\n<p>Wenn Du eine VBA-Funktion programmiert hast, die Du dauerhaft in einem Word-Dokument verf&uuml;gbar machen willst, gibt es verschiedene M&ouml;glichkeiten. Die VBA-Funktion zum Dokument hinzuzuf&uuml;gen, ist schnell erledigt: Du &ouml;ffnest per <b>Alt + F11 <\/b>den VBA-Editor, wechselst dort zum VBA-Projekt dieses Word-Dokuments und &ouml;ffnest das VBA-Modul <b>ThisDocument<\/b>.<\/p>\n<p>Hier k&ouml;nnen wir direkt eine Prozedur wie in Bild 1 hinzuf&uuml;gen und ausf&uuml;hren.<\/p>\n<p class=\"image\"><img decoding=\"async\" src=\"..\/fileadmin\/_temp_\/2024_03\/pic_428_001.png\" alt=\"Anlegen einer VBA-Prozedur f&uuml;r das aktuelle Dokument\" width=\"549,6265\" height=\"209,5644\" \/><\/p>\n<p><b><span style=\"color:darkgrey;\">Bild 1: Anlegen einer VBA-Prozedur f&uuml;r das aktuelle Dokument<\/span><\/b><\/p>\n<p>Nun m&ouml;chtest Du nicht immer in den VBA-Editor wechseln, um die Funktion aufzurufen, sondern diese gegebenenfalls direkt vom Ribbon aus oder &uuml;ber ein Kontextmen&uuml; starten. Das Anlegen eines entsprechenden Ribbon-Eintrags ist nicht besonders aufwendig und dieser kann auch mit dem aktuellen Dokument gespeichert werden.<\/p>\n<p>Ein Kontextmen&uuml; k&ouml;nnen wir nur mit VBA anlegen, aber auch dies schauen wir uns sp&auml;ter an.<\/p>\n<p>Zun&auml;chst wollen wir die Funktion per Ribbonbefehl verf&uuml;gbar machen. Dazu verwenden wir ein separates Tool, mit dem wir das Dokument &ouml;ffnen. Also m&uuml;ssen wir das Dokument zun&auml;chst schlie&szlig;en.<\/p>\n<p>Beim Schlie&szlig;en erscheint jedoch der Hinweis, dass der enthaltene VBA-Code nur gespeichert werden kann, wenn wir das Dokument mit dem Typ <b>Word-Dokument mit Makros (.dotm) <\/b>speichern, was wir direkt erledigen.<\/p>\n<h2>Ribbon-Eintrag hinzuf&uuml;gen<\/h2>\n<p>Den Ribbon-Befehl wollen wir in einem eigenen Tab unterbringen, das die Beschriftung <b>Mein Dokument <\/b>erhalten soll. Darin f&uuml;gen wir eine Gruppe ein, die schlie&szlig;lich eine Schaltfl&auml;che zum Aufrufen unseres noch zu erstellenden VBA-Befehls enth&auml;lt. <\/p>\n<p>Um dem Dokument die daf&uuml;r notwendige Ribbon-Definition hinzuzuf&uuml;gen, nehmen wir ein Tool namens <b>Office RibbonX Editor <\/b>zu Hilfe, das wir hier herunterladen k&ouml;nnen (sollte der Link nicht mehr verf&uuml;gbar sein, hilft eine Suche nach dem Produktnamen):<\/p>\n<pre>https:\/\/github.com\/fernandreu\/office-ribbonx-editor\/releases\/tag\/v1.9.0<\/pre>\n<p>Nach der Installation &ouml;ffnen wir das Tool und &ouml;ffnen das soeben angelegte Word-Dokument damit. Dieses erscheint nun in der linken Liste.<\/p>\n<p>Mit einem Rechtsklick zeigen wir das Kontextmen&uuml; an, aus dem wir den Eintrag <b>Office 2010+ Custom UI-Abschnitt einf&uuml;gen <\/b>ausw&auml;hlen (siehe Bild 2). Dies f&uuml;gt einen neuen Untereintrag namens <b>customUI14.xml <\/b>zum Dokument hinzu.<\/p>\n<p class=\"image\"><img decoding=\"async\" src=\"..\/fileadmin\/_temp_\/2024_03\/pic_428_002.png\" alt=\"Einf&uuml;gen eines Custom UI-Abschnitts\" width=\"424,6267\" height=\"237,6002\" \/><\/p>\n<p><b><span style=\"color:darkgrey;\">Bild 2: Einf&uuml;gen eines Custom UI-Abschnitts<\/span><\/b><\/p>\n<p>Ein Doppelklick zeigt im rechten Bereich den Inhalt dieses Abschnitts an, den wir nun mit dem gew&uuml;nschten XML-Code f&uuml;llen:<\/p>\n<pre>&lt;customUI xmlns=\"http:\/\/schemas.microsoft.com\/    office\/2009\/07\/customui\"&gt;\r\n   &lt;ribbon&gt;\r\n     &lt;tabs&gt;\r\n       &lt;tab id=\"tab\" label=\"Mein Dokument\"&gt;\r\n         &lt;group id=\"grp\" label=\"PDF\"&gt;\r\n           &lt;button id=\"btnExportPDF\" label=\"PDF exportieren\" \r\n               size=\"large\" image=\"PDF\"               onAction=\"ExportPDF\"\/&gt;\r\n         &lt;\/group&gt;\r\n       &lt;\/tab&gt;\r\n     &lt;\/tabs&gt;\r\n   &lt;\/ribbon&gt;\r\n&lt;\/customUI&gt;<\/pre>\n<p>Damit auch noch ein h&uuml;bsches Icon angezeigt wird, f&uuml;gen wir dieses &uuml;ber den Kontextmen&uuml;befehl wie in Bild 3 hinzu.<\/p>\n<p class=\"image\"><img decoding=\"async\" src=\"..\/fileadmin\/_temp_\/2024_03\/pic_428_003.png\" alt=\"Einf&uuml;gen des Icons und des XML-Codes\" width=\"700\" height=\"257,6834\" \/><\/p>\n<p><b><span style=\"color:darkgrey;\">Bild 3: Einf&uuml;gen des Icons und des XML-Codes<\/span><\/b><\/p>\n<p>Den Namen, der nun unter dem Eintrag <b>customUI14.xml <\/b>f&uuml;r die Ribbondefinition angezeigt wird, f&uuml;gen wir f&uuml;r das Attribut <b>image <\/b>des <b>button<\/b>-Elements ein.<\/p>\n<p>Um uns noch ein wenig die Arbeit zu erleichtern, klicken wir nun auf die Schaltfl&auml;che <b>VBA-Methoden generieren <\/b>in diesem Tool und kopieren den Inhalt aus dem nun erscheinenden Fenster <b>Methodenbetrachter<\/b> (siehe Bild 4).<\/p>\n<p class=\"image\"><img decoding=\"async\" src=\"..\/fileadmin\/_temp_\/2024_03\/pic_428_004.png\" alt=\"Ermitteln des Codes f&uuml;r die Ribbon-Schaltfl&auml;che\" width=\"424,6267\" height=\"167,7419\" \/><\/p>\n<p><b><span style=\"color:darkgrey;\">Bild 4: Ermitteln des Codes f&uuml;r die Ribbon-Schaltfl&auml;che<\/span><\/b><\/p>\n<h2>VBA-Funktion anpassen<\/h2>\n<p>Damit k&ouml;nnen wir dieses Tool schlie&szlig;en und das Word-Dokument erneut &ouml;ffnen.<\/p>\n<p>Hier f&uuml;gen wir nun den kopierten Code in die Klasse des aktuellen Dokuments ein und f&uuml;gen noch eine Zeile hinzu, die eine Testmeldung ausgibt:<\/p>\n<pre><span style=\"color:blue;\">Sub <\/span>ExportPDF(control<span style=\"color:blue;\"> As <\/span>IRibbonControl)\r\n     <span style=\"color:blue;\">MsgBox<\/span> \"Steuerlemenet ''\" & control.ID _\r\n         & \"'' wurde angeklickt.\"\r\n<span style=\"color:blue;\">End Sub<\/span><\/pre>\n<p>Wechseln wir dann zur&uuml;ck zum Word-Dokument, sehen wir im Ribbon das neue Tab-Element und k&ouml;nnen die Schaltfl&auml;che bet&auml;tigen (siehe Bild 5).<\/p>\n<p class=\"image\"><img decoding=\"async\" src=\"..\/fileadmin\/_temp_\/2024_03\/pic_428_006.png\" alt=\"Der Klick auf die Ribbon-Schaltfl&auml;che funktioniert bereits.\" width=\"700\" height=\"189,4291\"\/><\/p>\n<p><b><span style=\"color:darkgrey;\">Bild 5: Der Klick auf die Ribbon-Schaltfl&auml;che funktioniert bereits.<\/span><\/b><\/p>\n<h2>Funktion zum Exportieren als PDF hinzuf&uuml;gen<\/h2>\n<p>Wir wollten dem Dokument eine Funktion hinzuf&uuml;gen, mit dem wir dieses als PDF-Dokument speichern k&ouml;nnen. Dazu passen wir die durch die Ribbonschaltfl&auml;che ausgel&ouml;ste Prozedur wie folgt an:<\/p>\n<pre><span style=\"color:blue;\">Sub <\/span>ExportPDF(control<span style=\"color:blue;\"> As <\/span>IRibbonControl)\r\n      <span style=\"color:blue;\">Dim <\/span>doc<span style=\"color:blue;\"> As <\/span>Word.Document\r\n      <span style=\"color:blue;\">Dim <\/span>strDateipfad<span style=\"color:blue;\"> As String<\/span>\r\n      <span style=\"color:blue;\">Set<\/span> doc = ActiveDocument\r\n      strDateipfad = doc.Path & \"\\\" _\r\n          & <span style=\"color:blue;\">Replace<\/span>(doc.Name, \".docm\", \".pdf\")\r\n      doc.ExportAsFixedFormat _\r\n          OutputFileName:=strDateipfad, _\r\n         ExportFormat:=wdExportFormatPDF\r\n      <span style=\"color:blue;\">Set<\/span> doc = Nothing\r\n<span style=\"color:blue;\">End Sub<\/span><\/pre>\n<p>Die Prozedur referenziert das aktuelle Dokument und legt den Pfad f&uuml;r die zu erstellende PDF-Datei auf den Ordner des aktuellen Dokuments plus den Namen fest, wobei im Namen die Dateiendung <b>.dotm <\/b>durch <b>.pdf <\/b>ersetzt wird.<\/p>\n<p>Klicken wir nun auf die Schaltfl&auml;che, erstellen wir ein Dokument gleichen Namens im PDF-Format, das die Dateiendung <b>.pdf <\/b>enth&auml;lt.<\/p>\n<h2>Funktion zum zus&auml;tzlichen Speichern in der Zwischenablage hinzuf&uuml;gen<\/h2>\n<p>Wenn wir zus&auml;tzlich noch eine Schaltfl&auml;che hinzuf&uuml;gen wollen, welche das erstellte PDF-Dokument automatisch in die Zwischenablage kopiert, k&ouml;nnen wir dies in wenigen Schritten erledigen.<\/p>\n<p>Dazu schlie&szlig;en wir das Word-Dokument wieder und &ouml;ffnen es erneut mit dem Tool <b>Office RibbonX Editor<\/b>. Hier f&uuml;gen wir ein neues Icon namens <b>clipboard <\/b>hinzu und erg&auml;nzen den XML-Code im einzigen <b>group<\/b>-Element um ein weiteres <b>button<\/b>-Element:<\/p>\n<pre>...\r\n&lt;group id=\"grp\" label=\"PDF\"&gt;\r\n     ...\r\n     &lt;button id=\"btnExportPDFAndAddToClipboard\"         label=\"PDF in Zwischenablage\" size=\"large\"         image=\"clipboard\"         onAction=\"ExportPDFAndAddToClipboard\"\/&gt;\r\n&lt;\/group&gt;\r\n...<\/pre>\n<p>Dies sieht nach dem Schlie&szlig;en und dem erneuten &Ouml;ffnen des Word-Dokuments in Word wie in Bild 6 aus.<\/p>\n<p class=\"image\"><img decoding=\"async\" src=\"..\/fileadmin\/_temp_\/2024_03\/pic_428_005.png\" alt=\"Weitere Ribbon-Schaltfl&auml;che\" width=\"424,6267\" height=\"221,0526\" \/><\/p>\n<p><b><span style=\"color:darkgrey;\">Bild 6: Weitere Ribbon-Schaltfl&auml;che<\/span><\/b><\/p>\n<pre><span style=\"color:blue;\">Sub <\/span>ExportPDFAndAddToClipboard(control<span style=\"color:blue;\"> As <\/span>IRibbonControl)\r\n     ''... wie in Prozedur \"ExportPDF\"\r\n     <span style=\"color:blue;\">If <\/span>CopyFileToClipboard(strDateipfad) = <span style=\"color:blue;\">True<\/span><span style=\"color:blue;\"> Then<\/span>\r\n         <span style=\"color:blue;\">MsgBox<\/span> \"PDF erstellt und in Zwischenablage \" _\r\n             & \"kopiert.\", vbOKOnly + vbInformation, _\r\n             \"PDF in Zwischenablage\"\r\n     <span style=\"color:blue;\">Else<\/span>\r\n         <span style=\"color:blue;\">MsgBox<\/span> \"Kopieren in Zwischenablage nicht \" _\r\n             & \"erfolgreich.\", vbOKOnly + vbExclamation, _\r\n             \"PDF in Zwischenablage\"\r\n     <span style=\"color:blue;\">End If<\/span>\r\n<span style=\"color:blue;\">End Sub<\/span><\/pre>\n<p>Die dort verwendete Funktion finden wir in <b>VBA: Dateien in Zwischenablage kopieren (32\/64-Bit) <\/b>(<b>www.vbentwickler.de\/427<\/b>). Wir haben diese im VBA-Projekt des Word-Dokuments im Modul <b>mdlClipboardFiles <\/b>eingef&uuml;gt.<\/p>\n<p>Nun k&ouml;nnen wir das aktuelle Word-Dokument in eine PDF-Datei speichern und diese direkt automatisch in die Zwischenablage einf&uuml;gen.<\/p>\n<h2>Zusammenfassung und Ausblick<\/h2>\n<p>Dieser Artikel zeigt, wie wir ein Word-Dokument um ein Ribbon mit benutzerdefinierten Befehlen erweitern k&ouml;nnen.<\/p>\n<p>Diese Befehle l&ouml;sen au&szlig;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&uuml;gen.<\/p>\n<p>Aufbauend auf dieser L&ouml;sung kannst Du nun beliebige Vorg&auml;nge, die Du automatisieren m&ouml;chtest, in Dein VBA-Projekt einf&uuml;gen und &uuml;ber zus&auml;tzliche Ribbon-Schaltfl&auml;chen verf&uuml;gbar machen.<\/p>\n<p>Wenn Du Ideen f&uuml;r solche Funktionen hast, schreibe Deine Anregungen einfach an <b>support@minhorst.com <\/b>&#8211; wir sehen, was wir daraus machen k&ouml;nnen.<\/p>\n<h2>Downloads zu diesem Beitrag<\/h2>\n<p>Enthaltene Beispieldateien:<\/p>\n<p>DokumentMitVBAUndRibbon.docm<\/p>\n<p><a href=\"..\/fileadmin\/beispiele\/9C187FB9-0324-4A3A-9640-68E139695C51\/vbe_428.zip\">Download<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Nicht jeder, der seine Word-Dokumente mit ein paar zus&auml;tzlichen VBA-Funktionen ausstatten m&ouml;chte, will direkt ein COM-Add-In daf&uuml;r programmieren. Das ist auch nicht n&ouml;tig, denn wir k&ouml;nnen solche Funktionen auch einfach zu einem Word-Dokument hinzuf&uuml;gen und die Funktionen in einem integrierten Ribbon verf&uuml;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&uuml;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&uuml;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":[],"_links":{"self":[{"href":"https:\/\/vbentwickler.de\/data\/wp\/v2\/posts\/55000428","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/vbentwickler.de\/data\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/vbentwickler.de\/data\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/vbentwickler.de\/data\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/vbentwickler.de\/data\/wp\/v2\/comments?post=55000428"}],"version-history":[{"count":0,"href":"https:\/\/vbentwickler.de\/data\/wp\/v2\/posts\/55000428\/revisions"}],"wp:attachment":[{"href":"https:\/\/vbentwickler.de\/data\/wp\/v2\/media?parent=55000428"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/vbentwickler.de\/data\/wp\/v2\/categories?post=55000428"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/vbentwickler.de\/data\/wp\/v2\/tags?post=55000428"},{"taxonomy":"yst_prominent_words","embeddable":true,"href":"https:\/\/vbentwickler.de\/data\/wp\/v2\/yst_prominent_words?post=55000428"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}