Creating Custom Menu-Driven Events

The oyezfrms.cfg file [ OyezForms v12.00+ ]

This text-editable file enables you to add a custom tab to the OyezForms ribbon bar. The path to this file can be controlled by the following registry value:

Key: HKEY_CURRENT_USER\Software\Oyez\Oyez Legal Forms\Macro

String: AppPath

If present, OyezForms will use this path to read/store the app-level macro, and oyezfrms.cfg files.
Should end with a .bas file extension, e.g.: p:\oyez\appmacro\oyezapp.bas.
Path can be shared, or split, between users as required.
oyezfrms.cfg is created alongside the bas file.

The following oyezfrms.cfg content will create a 'ACME Software' custom tab in the ribbon bar with 2 user buttons.

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;; ;;; This configuration file allows menu items to added to the bottom of the Help ;;; and Tools Menus ;;; ;;; This is a sample/starter file - remove the single ;'s to uncomment as required. ;;; ;;; [ToolMenu] Number = number of menu items to added to bottom of Tools Menu ;;; ( maximum of 8 items ) ;;; ;;; [ToolMenu?] Tool menu item details ;;; caption = text to appear on menu entry ;;; program = path to an external executable to be called ;;; parameters = command line for program ;;; URL = url to be opened in browser window. If parameters = 1, Internet Explorer will be used. ;;; title = wording for internal browser window title bar ;;; ;;; program takes precedence over URL ;;; if 'program' and 'URL' are both empty, the Application Macro "CustomAction" event will be called with ;;; the long integer value contained in "parameters" as an input. ;;; ;;; Enabling "CustomImages" will create a file "UserTool.bmp" which can be edited to change the appearance ;;; of the custom toolbar buttons. ;;; "UserToolLG.bmp" can be edited to customise ribbon UI buttons ;;; [Enable] ;;; enable display custom tab, defined below. ( 0 disables ) ToolsMenu=1 ;;; displays any modifications to the <app folder>\UserToolLG.bmp file. ( 0 disables ) CustomImages=1 [ToolMenu] ;;; Set number of menu items to be added the custom tab Number=2 ;;; Category and Panel Title can be set for Ribbon UI Category= "ACME Software" ;;;appears under tab panel Title="ACME Forms Management" [ToolMenu1] ;;; first button title ( equates to 'T1' icon in UserToolLG.bmp ) caption="&Upload Active Form's Fields Information" ;;; this integer value is handed through to Application_CustomAction() app-level macro event as action parameter parameters=7 [ToolMenu2] caption="&Upload Live Library List" parameters=13

Capturing button clicks in app-level macros

You can capture user clicks defined by [ToolMenu1] and [ToolMenu2], above, with the following app-level macro code:

Public Sub Application_CustomAction(App As OyezLegalFormsApp, action As Integer) Select Case action Case 7 'identify user click from parameter in oyezfrms.cfg file 'first button click Set obj = CreateObject("yourCOMserver.yourCOMclass") case 13 'second button click End Select End Sub

Customising Ribbon Bar Icons.

The <app. folder>\UserToolLG.bmp file can be directly edited to customise the appearance of icons on the ribbon bar. 'T' signifies icons that will appear under your custom tab, 'H' signifies icons that will appear in the help panel.

Right-click on the image above and select save to replenish your source file.