Office Manager Entwickler-Support

Das Benutzermenü mit eigenen Befehlen erweitern

Mit Hilfe der Datei "usermenu.ini" können Sie den Benutzermenüs eigene Befehle hinzufügen. Dies stellt eine einfache Möglich dar, das Dokumenten-Management-System an eigene Anforderungen anzupassen (Customizing). Die so erstellten Befehle sind allgemeingültig und unabhängig von der Dokumentmarkierung im Archiv.

Alternativ können auch dokumenttypspezifische Erweiterungen vorgenommen werden. Dies ist erforderlich, wenn die Funktion nur für bestimmte Dokumenttypen, wie beispielsweise Adobe Acrobat oder Excel gültig ist.

Konfigurationsdatei usermenu.ini

Die Datei "usermenu.ini" wird im Verzeichnis der gemeinsamen Dateien abgelegt, sie hat folgenden Aufbau:

; Kommentare werden in einer INI-Datei mit Semikolon eingeleitet
[Befehlsname 1]
RibbonBar=Name der Ribbon-Toolbar
FileMustExists=optionaler Name einer erforderlichen Datei
Position=Position im Menü
BeginGroupOnBar=bei 1 wird auf der Toolbar eine Trennlinie gezeichnet
Caption=Text des Menüeintrags
Glyph=Menüsymbol
Hint=Kurzhilfe
HelpContext=Nummer der Onlinehilfe
MacroCmd=auszuführender OmAPI-Makrobefehl
; veraltet, nur für klassische Menüs bis zur Version 14.0 relevant:
Parent=Name des klassischen Hauptmenüs
BeginGroupInMenu=bei 1 wird im Menü vor dem Befehl eine Linie gezeichnet
ShowOnToolbar=bei 1 erscheint der Befehl auch auf der Symbolleiste


[Befehlsname 2]
...

Beschreibung der INI-Schlüssel

[BefehlsName]

Jeder Menübefehl wird in einer eigenen Sektion definiert, die Sektion beginnt mit dem Befehlsnamen in eckigen Klammern. Der Name kann beliebig gewählt werden, er muss aber eindeutig sein und darf weder Leer- noch Sonderzeichen enthalten. Die empfohlene Syntax ist: "usrM" gefolgt vom englischen Namen des Hauptmenüs und einem englischen Namen des Befehls. Beispielsweise "[usrMStartOpenTestPdf]" für einen Befehl auf der Menüseite Start, welcher das Dokument "test.pdf" öffnet.

Eine komplette Sektion kann mit einem Semikolon vor dem Befehlsnamen auskommentiert werden: "[;usrMStartExample]".

RibbonBar

Name der Ribbon-Symbolleiste, auf welcher der Mausschalter dargestellt wird. Gültige Namen sind u. a.:

  • Toolbar_QuickAccess_Ribbon (Symbolleiste für den Schnellzugriff)
  • ToolbarStartSearch_Ribbon (Registerseite Start, Gruppe Suchen)
  • ToolbarStartUse_Ribbon (Start | Verwenden)
  • ToolbarDocNew_Ribbon (Erstellen | Dokument)
  • ToolbarDocScan_Ribbon (Erstellen | Scannen)
  • ToolbarDocImport_Ribbon(Erstellen | Importieren)
  • ToolbarEditDoc_Ribbon (Bearbeiten | Dokument)
  • ToolbarEditClipboard_Ribbon (Bearbeiten | Zwischenablage)
  • ToolbarAutoCAD_Ribbon (CAD | AutoCAD)
  • ToolbarMegaCAD_Ribbon (CAD | MegaCAD)
  • ToolbarViewGridSource_Ribbon (Ansicht | Anzeigen)
  • ToolbarViewGrid_Ribbon (Ansicht | Tabelle)
  • ToolbarViewCustomize_Ribbon (Ansicht | Anpassen)
  • ToolbarHelpDirect_Ribbon (Hilfe | Kurzhilfe)
  • ToolbarHelpDocu_Ribbon (Hilfe | Dokumentation)
  • ToolbarHelpWeb_Ribbon (Hilfe | Internet)
  • ToolbarAdmin_Ribbon (Administrator | Administration)
  • ToolbarAdminScript_Ribbon (Administrator | Skript)
  • ToolbarAdminDebug_Ribbon (Administrator | Entwickler)
  • ToolbarContactCreate (Kontakt | Erstellen)
  • ToolbarContactEdit (Kontakt | Bearbeiten)
  • ToolbarContactSearch (Kontakt | Suchen)
  • ToolbarTodoCreate_Ribbon (Aufgabe | Erstellen)
  • ToolbarTodoEdit_Ribbon (Aufgabe | Bearbeiten)
  • ToolbarTodoDoc_Ribbon (Aufgabe | Suchen)
  • ToolbarTodoNavigation (Aufgabe | Navigieren)
  • ToolbarTodoArrange (Aufgabe | Anordnen)
  • ToolbarTodoView (Aufgabe | Ansicht)
  • ToolbarNavigatorView_Ribbon (Navigator | Ansicht)
  • ToolbarNavigatortEdit_Ribbon (Navigator | Bearbeiten)

Eine vollständige Liste der Symbolleisten finden Sie in der Datei "Benutzereinstellungen\FormOmMain.dxb". Suchen Sie mit einem Editor nach "Name=Toolbar".

Befehle in ein lokales Popupmenü (rechte Maustaste) eintragen:

  • PopupTvDocument (lokales Menü der Dokumententabelle)
  • PopupTvTodo (lokales Menü der Dokumententabelle)
  • PopupBtnSearch (lokales Menü des Mausschalters Suchen)
  • PopupProjectNav (lokales Menü des Projektnavigators)
FileMustExists

Optionale Angabe eines Dateinamens. Falls angegeben, wird der Menüeintrag nur erstellt, wenn die genannte Datei vorhanden ist. Dies ist beispielsweise sinnvoll, wenn mit dem neuen Befehl ein Hilfedokument geöffnet werden soll. Ist das Dokument auf einem Rechner nicht vorhanden, dann wird der Befehl auf diesem nicht eingeblendet.

Position

Gibt die Position im Menü an: 0=an letzter Position, 1=an erster Position. 2=an zweiter usw. Um Index-Fehler zu vermeiden, sollte 0 oder 1 verwendet werden.

BeginGroupOnBar

0 oder 1. Bei 1 wird auf der Toolbar eine Trennlinie gezeichnet.

Caption

Der Text des Menüeintrages. Dieser sollte dem Anwender kurz und eindeutig die Funktion beschreiben.

Glyph

Dateiname des Menüsymbols. Geben Sie bitte den Namen einer Bitmap (*.bmp) mit 32x32 Pixel für das Ribbon-Menü an. Wenn Sie die Datei ohne vollständigen Pfad angeben, dann wird sie im Verzeichnis der gemeinsamen Dateien erwartet.
Besser: Index des programminternen Menüsymbols (0 bis n), zum Beispiel 25 für Hilfe, 68 für PDF-Dateien; 126 oder 146 für Befehle.

Hint

Die Kurzhilfe wird eingeblendet, wenn die Maus auf dem Menüeintrag oder dem Toolbar-Symbol ruht. Das Programm kann zwischen einer Maus- und Statusleisten-Version unterscheiden. Geben Sie entweder nur einen Hilfetext ein oder trennen Sie beide Versionen mit dem |-Zeichen:
Erscheint an der Maus|Steht in der Statusbar

HelpContext

Nummer der zugeordneten Direkthilfe. In der Regel geben Sie 0 ein, keine Direkthilfe.

MacroCmd

Das OmAPI-Makro, welches bei Auswahl des Befehls ausgeführt wird. Mit Hilfe der Makrofunktion ScriptControl können auch Visual Basic-Skripte und JScript aufgerufen werden.

Folgende Schlüssel sind nur für die Darstellung in klassischen Menüs bis zur Version 14.0 relevant:

Parent

Name des Haupt- oder Untermenüs, in welchem der Befehl dargestellt wird. Gültige Namen sind u. a.:

  • MainMenuFile (Menü Datei)
  • MainMenuDocument (Dokument)
  • MainMenuEdit (Bearbeiten)
  • MainMenuSearch (Suchen)
  • MainMenuView (Ansicht)
  • MainMenuHelp (Hilfe)
  • MainMenuAdmin (Administrator)
  • MFileSubDB (Datei | Datenbank)
  • MDocSubNew (Dokument | Neu)
  • MainMenuOptions (Ansicht | Optionen)
  • Popupmenüs wie bei "RibbonBar"

Eine vollständige Liste finden Sie in der Datei "Benutzereinstellungen\FormOmMain-Menu.dxb". Die Menünamen stehen dort jeweils hinter dem Text "FormOmMain.BarManager.SubItem_". Die Datei ist nur vorhanden, wenn Office Manager bis Version 14.0 mindestens einmal mit klassichen Menüs beendet wurde.

BeginGroupInMenu

Nur für die Darstellung in klassischen Menüs bis Version 14.0 relevant. 0 oder 1. Bei 1 wird vor dem neuen Befehl eine Gruppierungs-Linie im Menü gezeichnet.

ShowOnToolbar

0 oder 1. Bei 0 erscheint der Befehl nur im Menü, bei 1 zusätzlich auf der Toolbar für benutzerdefinierte Befehle.

 

Häufiger Fehler

Die Meldung "Komponente mit dem Namen "usr…" existiert bereits" bedeutet, dass zwei Sektionen mit demselben Namen vorhanden sind. Benennen Sie eine bitte um.

Beispiel

Beispieldatei usermenu.ini mit folgenden benutzerdefinierten Befehlen:

  • usrMHelpSubWebOpenFAQ: öffnet eine Internetseite,
  • usrMSearchPathG: sucht im Dokumentenarchiv,
  • usrMFileOpenTestPDF: öffnet eine PDF-Datei, wenn diese vorhanden ist,
  • usrMFileVBHelloWorld: "Hello Word" als VBScript,
  • usrPopupTvDocumentTest: ein eigener Befehl im lokalen Menü der Dokumententabelle.

Hinweis

Office Manager DMS liest die usermenu.ini beim Programmstart ein, nach einer Änderungen ist ein Neustart erforderlich.