Menüband per XML anpassen

Transkript

1 Menüband per XML anpassen So statten Sie Datenbanken mit eigener Menübandsteuerung aus Die Informationen aus diesem Beitrag helfen Ihnen das Grundkonzept von Menübandanpassungen kennenzulernen den Aufbau der Tabelle»USysRibbons«und Callback-Routinen zu verstehen individuelle Anpassungen schnell umzusetzen Seit Access 2010 haben Sie zwar einige Möglichkeiten, das Menüband an Ihre eigenen Anforderungen anzupassen, aber diese Änderungen werden nur lokal gespeichert. Sie können sie nicht mit der Datenbank an andere Anwen - der weitergeben. Zu diesem Zweck müssen Sie XML-Defi - nitionen einsetzen, die im Detail definieren, was genau im Menüband zu ändern ist. Wenn Sie das Grundkonzept ein - mal verstanden und sich ein wenig mit XML aus ein an der - ge setzt haben, ist das viel einfacher, als Sie vielleicht den ken. Dieser Beitrag liefert alle notwendigen Grundlagen und zeigt an praktischen Beispielen die Möglichkeiten für Ihre eigene Benutzeroberfläche. von Heinz-Josef Bomanns Das Grundkonzept der Menübandanpassungen per XML... Die Basis:»USysRibbons«und XML-Definitionen... XML-Definitionen komfortabel erfassen und bearbeiten... Was Sie über XML-Definitionen wissen müssen... Bezeichner für Symbole einfacher finden... Die Zuordnung: Einstellungen für Datenbank, Formulare und Berichte... Die Steuerung: VBA-Callback-Routinen nutzen... Auf Beispieldatenbank unter der Beitragsnummer /02 /02 /04 /06 /11 /12 /15 Der Access-Berater Sommer

2 02 Menüband per XML anpassen Das Grundkonzept der Menübandanpassungen per XML Tabellen, Zuordnungen und VBA- Callbacks Damit Sie die Benutzeroberfläche an anpassen können, müssen Sie in drei Bereichen tätig werden: In einer Tabelle»USysRibbons«sind unter einer eindeutigen Bezeichnung XML-Definitionen gespeichert, die festlegen, was im Menüband geändert werden soll. In den Einstellungen der Datenbank, eines Formulars oder eines Berichtes wird über die eindeutige Bezeichnung festgelegt, welche XML-Definition für die Benutzeroberfläche der kompletten Datenbank oder nur für ein Formular oder einen Bericht verwendet werden soll. Gesteuert durch Attribute der XML-Definitionen können VBA- und Callback-Routinen in einem VBA-Projekt auf - ge rufen werden, die Reaktionen erlauben auf Mausklicks, Modifikationen des Symbols, der Beschriftung und der Sicht - barkeit von Elementen vor der Anzeige oder komplexe Steu - erungs vorgänge mit allem, was in VBA möglich ist. Die Basis:»USysRibbons«und XML-Definitionen Systemtabelle»USysRibbons«einrichten Erste wichtige Voraussetzung ist eine spezielle Tabelle»USys- Ribbons«für die Speicherung der XML-Definitionen, die Sie folgendermaßen anlegen: 1. Klicken Sie auf dem Register»Erstellen«auf das Symbol TABELLENENTWURF. Felder einrichten 2. Richten Sie folgende Felder ein: 032 Sommer 2016 Der Access-Berater

3 Menüband per XML anpassen 03 ID: Datentyp»AutoWert«, Primärschlüssel RibbonName: Datentyp»Text«, Länge 255 RibbonXML: Datentyp»Memo«3. Speichern Sie die Tabelle unter dem Namen»USysRibbons«und verlassen Sie den Tabellenentwurf wieder. Diese Tabelle speichert beliebig viele XML-Definitionen unter eindeutigen Namen Da»USys«-Tabellen von Access wie Systemtabellen behandelt werden und somit standardmäßig ausgeblendet sind, muss ihre Anzeige explizit eingeschaltet werden: 1. Klicken Sie mit der rechten Maustaste auf die Titelleiste des Navigationsbereiches und wählen Sie NAVIGATIONSOPTIONEN im Kontextmenü an. 2. Aktivieren Sie im Bereich»Anzeigeoptionen«die Option SYSTEMOBJEKTE ANZEIGEN. 3. Übernehmen Sie die Änderungen mit einem Klick auf OK. Systemobjekte immer anzeigen lassen Der Access-Berater Sommer

4 04 Menüband per XML anpassen Um Systemtabellen wie»usysribbons«mit Access bearbei - ten zu können, muss diese Option eingeschaltet sein XML-Definitionen komfortabel erfassen und bearbeiten Damit Sie komplexe XML-Definitionen nicht mühsam in der Datenblattansicht oder der Zoombox erfassen und bearbeiten müs sen, haben wir einen kleinen Editor entwickelt, den Sie in der Beispieldatenbank zu diesem Beitrag finden (Download auf unter der Beitragsnummer ). Übertragen Sie das Formular»USysRibbons-Editor«in die Datenbank, in der Sie Benutzeroberflächenanpassungen per XML-Definitionen entwickeln wollen, und öffnen Sie es per Doppelklick. Tabelle automatisch anlegen Wenn die Tabelle»USysRibbons«noch nicht in der Datenbank vorhanden ist, wird sie automatisch angelegt. Dem Formular ist standardmäßig keine Datenbasis zugeordnet, es versucht stattdessen, sich die Tabelle»USysRibbons«beim Laden mit folgender Anweisung selbst zuzuordnen: 034 Sommer 2016 Der Access-Berater

5 Menüband per XML anpassen 05 On Error Resume Next Me.RecordSource = "USysRibbons" Bei vorhandener Tabelle»USysRibbons«funktioniert das problemlos. Wenn ein Laufzeitfehler auftritt, weil die Tabelle noch nicht vorhanden ist, wird die Tabelle per SQL/DDL angelegt und anschließend als Datenbasis zugeordnet: Laufzeitfehler abfangen If Err <> 0 Then 'Nicht gefunden strsql = "CREATE TABLE USysRibbons( " & _ "RibbonName Text(255) CONSTRAINT PrimaryKey PRIMARY KEY, " & _ "RibbonXML MEMO);" Err = 0 DoCmd.RunSQL strsql, False If Err <> 0 Then Beep MsgBox "Tabelle 'USysRibbons' wurde nicht gefunden " & _ "und konnte auch nicht angelegt werden - bitte manuell erstellen...", _ vbokonly + vbcritical, "USysRibbon-Editor:" Else 'Alles Ok... Me.RecordSource = "USysRibbons" End If Das Formular verfügt über das Textfeld RIBBONNAME für die Bezeichnung der jeweiligen XML-Definition sowie über ein Memofeld RIBBONXML für die dazugehörende XML-Defini - tion. Im Formular können Sie wie gewohnt mit den Navigationsschaltflächen blättern und Ihre XML-Definitionen bequem im Memofeld bearbeiten. Bedienung des»usysribbon«-editors Für den schnellen Zugriff auf eine bestimmte XML-Definition gibt es ein Kombinationsfeld ANZEIGEN im Formularkopf, das alle vorhandenen XML-Definitionen auflistet und das Formular nach einer Auswahl auf die gewünschte Definition positioniert. Der Access-Berater Sommer

6 06 Menüband per XML anpassen Mit dem»usysribbons«-editor können Sie Ihre XML-Definitio - nen komfortabel in einem geräumigen Formular bearbeiten Was Sie über XML-Definitionen wissen müssen Zweite wichtige Voraussetzung für eine Anpassung der Benut zer - oberfläche sind einige XML-Grundlagen. Der Umfang der für die Anpassung verwendeten XML-Tags und -Attribute ist überschau - bar: Im Folgenden finden Sie dazu zahlreiche Beispiele, die Sie anpassen und als Basis für eigene Projekte heranziehen können. Schnellkurs in Benutzer- oberflächen- XML XML ist vom Aufbau mit HTML vergleichbar: <customui xmlns=" 2006/01/customui"> <ribbon startfromscratch="false"> <tabs> <tab id="mycustomtab" label="mein erstes Register" visible="true"> 036 Sommer 2016 Der Access-Berater

7 Menüband per XML anpassen 07 <group id="mycustomgroup" label="meine erste Gruppe"> <control idmso="fileopendatabase" label="andere Datenbank öffnen" /> </group> </tab> </tabs> </ribbon> </customui> Es gibt immer ein öffnendes und ein schließendes Tag wie»"<tab>"«und»"</tab>"«, zwischen denen sich die Definitionen für eine Registerkarte befinden. Wahlweise kann die Definition aber auch einfach per»"/>"«wie z. B. bei einer Definition für eine Schaltfläche abgeschlossen werden:»<button id="btntest"... />«. Jedes Element muss eine eindeutige ID haben, die über ein gleichnamiges Attribut»"id=Name"«anzugeben ist. Weitere Attribute wie»"label=..."«,»"imagemso=..."«,»"visible=..."«oder»"enabled=..."«legen Beschriftungen, Symbole, Sichtbarkeit oder den Status»Akiviert/Deaktiviert«eines Elementes fest. XML-Tags verstehen Die Attribute sind fest definiert und müssen in korrekter Schreibweise angegeben werden!»"label=..."«führt z. B. zu einer Feh - lermeldung. Viele dieser Attribute können auch dynamisch über eine Callback-Funktion gesetzt werden. Wenn Sie z. B. eine mehrsprachige Datenbank mit Beschriftungen in unterschiedlichen Sprachen einsetzen, können Sie mit»getlabel="ribbonget La - bel"«den Namen einer Callback-Funktion»RibbonGetLabel()«für die Ermittlung der sprachspezifischen Beschriftung definieren. Nun zur Erläuterung unserer Beispieldefinition: <customui xmlns=" 2006/01/customui"> Mit dieser Zeile wird jede XML-Definition für die Modifikation des Menübandes eingeleitet. Die URL adressiert das Schema, ist immer gleich und dient der Verifizierung der Definitionen. Definition einleiten Der Access-Berater Sommer

8 08 Menüband per XML anpassen <ribbon startfromscratch="false"> Dieser Eintrag leitet Modifikationen am Menüband ein, wobei startfromscratch="false" festlegt, dass das aktuelle Menüband beibehalten wird. Mit startfromscratch="true" wird das aktuelle Menüband komplett durch Ihr eigenes Menü - band ersetzt. <tabs> Registerkarten einbinden Mit diesem einleitenden Tag beginnt eine Anpassung der Register (=»Tabs«) des Menübandes. <tab id="mycustomtab" label="mein erstes Register" visible="true"> Ein solches Tag spezifiziert ein neues Register (=»Tab«) mit der ein deutigen ID»"MyCustomTab"«und der Bezeichnung ge mäß Attribut»label«.»Visible«legt fest, dass das Register direkt sichtbar ist. <group id="mycustomgroup" label="meine erste Gruppe"> Gruppen einrichten Hier wird im aktuellen Register eine neue Gruppe (=»group«) mit der eindeutigen ID»"MyCustomGroup"«und der Bezeichnung gemäß Attribut»label«spezifiziert. Auf»visible«verzichten wir hier, da Gruppen standardmäßig immer sichtbar sind. <control idmso="fileopendatabase" label="andere Datenbank öffnen" /> Button einbauen Mit dem»control«-tag richten Sie eine Schaltfläche ein, die z. B. eine mit»idmso«spezifizierte, eingebaute Access-Funktion, hier DATEI ÖFFNEN, aufruft. Die Bezeichner für die einzelnen 038 Sommer 2016 Der Access-Berater

9 Menüband per XML anpassen 09 Funktionen können Sie über die ACCESS-OPTIONEN im Bereich»Anpassen«in Erfahrung bringen: Wenn Sie den Mauszeiger über einem Eintrag der linken Liste stehen lassen, wird eine Quick Info angezeigt, die in Klammern den Bezeichner enthält, wie z. B.»(FileBackupDatabase)«für die Funktion DATENBANK SICHERN. Den»idMso«-Bezeichner jeder Access-Funktion können Sie den QuickInfos der Einträge dieser Liste entnehmen Alternativ können Sie bei einem Klick statt einer eingebauten Funktion auch eine eigene VBA-Routine aufrufen: VBA-Code aufrufen <control idmso="fileopendatabase" label="andere Datenbank öffnen" onaction="datenbankoeffnen" /> Access sucht dann bei einem Klick auf die Schaltfläche in allen Modulen nach einer als»public«deklarierten Prozedur mit dem angegebenen Namen, hier»datenbankoeffnen«. Der Access-Berater Sommer

10 10 Menüband per XML anpassen </group> </tab> </tabs> </ribbon> </customui> Jedes Tag muss am Ende der Definition wie oben gezeigt wieder geschlossen werden; andernfalls wird die Anpassung beim Öffnen der Datenbank aufgrund von Syntaxfehlern nicht eingebunden. Fehlermeldungen anzeigen lassen Probleme mit XML-Definitionen ignoriert Access standardmä - ßig. Im schlimmsten Fall suchen Sie ohne konkreten Hinweis stundenlang nach der Ursache. Sie müssen explizit festlegen, dass bei Fehlern in den XML- Definitionen eine Fehlermeldung angezeigt werden soll: 1. Wechseln Sie in die ACCESS-OPTIONEN und dort in den Bereich»Client einstellungen«bzw.»erweitert«. Hier legen Sie fest, dass Access XML-Fehler melden soll 040 Sommer 2016 Der Access-Berater

11 Menüband per XML anpassen Aktivieren Sie im Abschnitt»Allgemein«die Option FEHLER VON BENUTZEROBERFLÄCHEN IN ADD-INS ANZEIGEN. 3. Übernehmen Sie die Änderung mit einem Klick auf OK. Wenn eine Ihrer XML-Definitionen einen Fehler enthält, macht Access Sie darauf beim Öffnen der Datenbank aufmerksam und teilt Ihnen Details zur Lokalisierung des Fehlers mit. Bei Ungereimtheiten in Ihren XML-Definitionen zeigt Access eine solche Fehlermeldungen an Bezeichner für Symbole einfacher finden Bei Schaltflächen und sonstigen Elementen müssen Sie häufig für die Festlegung des Symbols einen Bezeichner»imageMso=«wie im folgenden Beispiel angeben: <button id="btnopenformartikel" getlabel="getlabelsub" size="normal" imagemso="createform" onaction="mycommands" /> Mit der»office 2007 Icons Gallery«( en-us/download/details.aspx?id=11675) stellt Microsoft eine Excel-2007-Arbeitsmappe zur Verfügung, mit der Sie die Bezeichner für das»imagemso«-attribut schnell und einfach ermitteln können. Dazu werden auf dem Register»Entwicklertools«Galerien eingerichtet, die die verfügbaren Symbole anzeigen: Symbolgalerien nutzen Der Access-Berater Sommer

12 12 Menüband per XML anpassen Mit der»icons Gallery«sind passende Symbolen für Ihre Benut - zeroberflächenanpassung schnell gefunden Die Zuordnung: Einstellungen für Datenbank, Formulare und Berichte XML-Definitionen über spezielle Eigenschaften zuweisen Praktisches Beispiel Sie können XML-Definitionen verwenden, um die komplette Benutzeroberfläche anzupassen, aber es ist auch möglich, Anpassungen nur für bestimmte Formulare und Berichte vorzuneh - men. Um eine XML-Definition der Datenbank zuzuordnen, rufen Sie die Optionen auf und wechseln in den Bereich»Aktuelle Datenbank«. Im Abschnitt»Menüband- und Symbolleisten op - tionen«bzw.»multifunktionsleisten- und Symbolleistenoptionen«können Sie unter NAME DES MENÜBANDES bzw. NAME DER MULTIFUNKTIONSLEISTE den Namen der zu verwendenden XML-Definition einstellen. Diese wird mit dem Öffnen der Datenbank aktiviert und mit dem Schließen wieder deaktiviert. In der Beispieldatenbank finden Sie die XML-Definition»Ersetzen«, die das demonstriert. Wenn Sie diese Definition für die Datenbank zuordnen und neu öffnen, werden auf dem Register»Datei«bzw. unter der Office-Schaltfläche verschiedene Funk - tionen ausgeblendet, sodass nur noch die Funktionen DATENBANK ÖFFNEN, DATENBANK SCHLIEßEN und DRUCKEN verfügbar sind. 042 Sommer 2016 Der Access-Berater

13 Menüband per XML anpassen 13 Hier legen Sie fest, welche XML-Definition für die Benutzeroberflächenanpassung der Datenbank zuständig ist Außerdem sind die Register»Externe Daten«und»Daten bank - tools«ausgeblendet: <!-- Zunächst alle Standard-Elemente ausblenden --> <control idmso="filenewdatabase" visible="false"/> <control idmso="sourcecontrolcreatedatabasefromproject" visible="false"/> <control idmso="fileopendatabase" visible="false"/> <control idmso="filesave" visible="false"/> <control idmso="convertdatabaseformat" visible="false"/> <control idmso="filesaveasmenuaccess" visible="false"/> <control idmso="filemanagemenu" visible="false"/> <control idmso="filesendasattachment" visible="false"/> <control idmso="menupublish" visible="false"/> <control idmso="fileservermenu" visible="false"/> <control idmso="fileclosedatabase" visible="false"/> <!-- Dann nur die erlaubten Elemente einblenden --> <control idmso="fileprintmenu" visible="true"/> <control idmso="fileopendatabase" visible="true"/> <control idmso="fileclosedatabase" visible="true"/> Der Access-Berater Sommer

14 14 Menüband per XML anpassen Benutzeroberflächenanpassung für Formulare und Berichte Praktisches Beispiel Weiterhin es ist nicht mehr möglich, Makros, Module oder Klassenmodule anzulegen. Per XML-Definition wird ein Klick auf das Symbol MAKRO auf eine eigene Hinweisrou tine umgeleitet und die Sym bole Modul und KLASSENMODUL werden deaktiviert. Die gleiche Eigenschaft finden Sie auch bei Formularen und Berichten. Die hier gewählten An - Per XML-Definition lassen sich beispielsweise Funktionen und Register ausblenden und Klicks auf bestimmte Symbole auf eigene VBA-Routinen umleiten passungen werden mit dem Öffnen des Formulars/Berichtes aktiviert und mit dem Schließen wieder deaktiviert, sind also nur verfügbar, solange das Formular/der Bericht geöffnet ist. In der Beispieldatenbank finden Sie das Formular»Kunden«, mit dem diese Technik demonstriert wird. Diesem Formular ist die XML-Definition»Sicherheitsabfrage«zugeordnet. Sie sorgt dafür, dass bei einem Klick auf NEUER DATENSATZ und DATENSATZ LÖSCHEN eine zusätzliche Sicherheitsabfrage angezeigt wird: <commands> <command idmso="delete" onaction="secondchance" /> <command idmso="recordsdeleterecord" onaction="secondchance" /> <command idmso="gotonewrecord" onaction="secondchance" /> </commands> 044 Sommer 2016 Der Access-Berater

15 Menüband per XML anpassen 15 Durch die Umleitung von Funktionen auf eigene VBA-Routinen können Sie zum Beispiel die Bedienung Ihrer Datenbanken sicherer gestalten Wenn Sie Änderungen oder Kor - rek turen an der Tabelle»USysRibbons«vornehmen und diese Än - de rungen ak ti vieren möch ten, muss die Datenbank geschlos sen und wieder geöffnet werden! Änderungen aktivieren Die Steuerung: VBA-Callback-Routinen nutzen Sie haben gesehen, dass beispielsweise mit dem»onaction«- Attribut als Ziel eines Mausklicks eine VBA-Prozedur oder mit einem»getlabel="getlabelsub"«eine Callback-Funktion spezifiziert wird. Diese VBA-Routinen müssen alle in einem globalen Modul abgelegt und als»public«deklariert werden, damit die Ribbon-Schnittstelle sie findet. Grundsätzlich ist eine Callback-Funktion wie folgt deklariert: Die Verbindung zwischen Benutzeroberfläche und VBA-Code Public Sub Get<Data>(ByVal Ctrl As IribbonControl, ByRef returnvalue As Variant)»<Data>«steht für die abzufragende Information wie zum Beispiel»Label«,»Visible«,»Screentip«und so weiter. Mit Der Access-Berater Sommer

16 16 Menüband per XML anpassen»ctrl.id«erhalten Sie eine Referenz auf das aufrufende Element können also z. B. in»getimage«die Symbole für Ihre Elemente abhän gig von der ID liefern: Public Sub GetImage(Ctrl As IRibbonControl, ByRef returnvalue As Variant) Select Case Ctrl.ID Case "btntest" returnvalue = "FileOpen" Case "mnutest" returnvalue = "FileBackUpSqlDatabase" Case Else returnvalue = "HappyFace" End Select End Sub Am einfachsten verwenden Sie eine»select Case«-Konstruktion für die Unterscheidung der IDs. Es sollte zudem immer ein»case Else«vorhanden sein, das einen auffälligen Standard - wert liefert, wie hier das Smiley oder bei»getlabel«,»get - Screen tip«und»getsupertip«drei Fragezeichen»???«. So kön nen Sie sofort erkennen, wenn Sie in Ihrer Definition eine Zu ordnung vergessen haben. Rückgabewert festlegen»returnvalue«weisen Sie immer die zurückzuliefernde Informa - tion, also beispielsweise eine Bezeichnung, einen»imagemso«- Bezeichner oder»true/false«zu. Es handelt sich hier um einen»byref«deklarierten Parameter, den die Ribbon-Schnittstelle bereitstellt. Wichtig zu beachten: In der VBA-Entwicklungsumgebung muss über EXTRAS-VERWEISE eine Referenz auf»microsoft Office 16.0/15.0/14.0/12.0 Object Library«gesetzt werden, damit spe - zielle Objekte wie»iribboncontrol«aufgelöst werden können! 046 Sommer 2016 Der Access-Berater