Virtual EIP Documentation

Version 1.5 Gold

(c) 2013 by Telford Software Solutions

http://veip.teamtelford.org/

Updated Friday 6 December 2013

Support

Any questions, comments, suggestions please send to:

Alan Telford  

You're welcome to include a small zip file (app + dict + tps files).

Updates

• • You need to buy the product before you can get updates!

  • When you purchase the product, you are advised of a separate page to access for updates.

Manual Installation

• • Hopefully all of the installation will have been handled by the install program.

  • Ensure the template <Clarion9>\accessory\template\win\Veip.tpl has been registered (path may differ)

    • If using UltraTree, then register VeipUtre.tpl, but NOT the Veip.tpl

    • If using Legacy templates, then register VeipL.tpl

  • Ensure the ABC Compliant class library files Veip.clw/Veip.Inc are in your <Clarion9>\Accessory/Libsrc\Win folder.

  • Your RED (redirection file - either <Clarion9>\Bin\Clarion90.Red has entries

  • *.TP? = <clarion9>\Accessory\Template\Win

  • *.* = <clarion9>\Accessory\Images

  • If the RED entries do not exist, then Clarion will not be able to find the VirtualEIP  template or images

Quick Start Guide

• 1. First you must populate the Global Extension template.

  2. Select the Browse procedure that will require the Virtual EIP functionality.

  3. Add the Browse Extension template to this browse. (You may also add VEIP onto a BrowseBox on a FORM template).

  4. Design a form to be used to update this browse.

  5. Add the Form Extension template to this form.

  6. Finished - now compile and run. 

Add the Global Extension Template to your Application

• 1. Ensure Clarion is started, and your application is open.

  2. Choose Application | Global Properites  | Extensions button from the pulldown menu, and press the Insert button.

1. Choose the VirtualEIPApp – Virtual EIP Global Support extension template and press the Select button.

• 1. If this is a root dll in a multi-dll application, then set 'Export VirtualEIP data defined in this DLL' to true (this checkbox is hidden if the application type is not DLL)

1. If this is a multi-dll application and data is defined in another dll, then set Virtual EIP External (Defined in another DLL) to true.

2. If you choose Disable ALL Template Code then all VirtualEIP code in the entire application is disabled.  You can turn this checkbox on again at a later stage and all your settings will be intact.

3. Choose OK to close the Global Properties window and return to your application procedure tree

Add the Procedure Extension Template to your Browse

• 1. Open the Window, and select the target listbox.  Note the equate for this listbox (usually ?Browse)

1. Close the window, then Right click on the  Browse procedure and choose Extensions.

2. Highlight the Browse on <File> control template.  This will only exist if you've populated an ABC BrowseBox control template onto your

3.  window.  

1. Press Insert, then select VirtualEIPBrowse – Virtual EIP Browse Support to add the extension template. Note that the VirtualEIPBrowse template will only show in the list if you've highlighted a browse as in the picture above.

2. You must now fill in the browse options

1. The default Browse name is BRW1.  You must ensure this is the right name.  You can find this name by selecting the Browse Extension Template, and navigating to the Classes tab. The object name is at the top of this tab.

2. Select the list box equate for this browse.  Only equates for listboxes are shown in the list, so this should be straightforward.

3. Select an option for "Insertion Point". This controls where the current row shows when inserting a new record into the listbox.

4. On the Disable Stuff tab, you can optionally enter a list of controls which will be disabled before entering EIP mode, and enabled after returning from EIP. This allows you to provide a visual clue to the user that the Browse cannot be actioned until the VEIP Form has been closed.

Note:

• • You need to add an extension to every BrowseBox that requires the VEIP functionality.  

• You can have multiple browseboxes on a single window, all with VEIP functionality.

• Use the same method to add VEIP to a BrowseBox on a FORM window. 

Tips for Designing your Form.

• 1. Open up the browse window, and choose listbox format, and make a list of all the fields which are in this listbox, and also note the Font Size of the window.

  2. Create a new form, (or modify an existing one).

  3. Populate fields onto the form in exactly the same order as they appear on the listbox

  4. E.g if Browse columns are “Name, BirthDate, State” then you must populate the fields on your form in the order ‘Name, Birthdate, State’

1. If your BrowseBox was displaying information from local data fields, then you will also need to populate these local data fields onto the form.

To ensure the FORM is correctly positioned over the list box you must make the following changes to the form

1. Go into Procedure Properties | Window Behavior and ensure that Save and Restore Window Location is turned off

2. The extension Allow FORM to be driven by Toolbar VCR Controls may conflict with Virtual EIP. Please remove if it is a problem

3. Remove the Window Resize template (if it exists).

   1. Ensure the Font Size on the Form window matches that of the parent Browse.

   2. Ensure the number of fields on the form matches the number of columns in the Browse.

   3. *** TIP *** Make sure you remove all SHEET or TAB controls from your form.

As this is a standard form, you can set up all your standard options for the form. 

• • You can use FileDrop templates, FileDropCombo templates, date calendar templates. 

  • You can use spinboxes, checkboxes (but NOT option boxes). 

  • You can set the Required attribute on required fields

  • You can set the CASE of entry fields (Uppercase, Capitalise, Default)

  • You can set Disable, Readonly, Skip for entry fields you don't wish the end user to alter.

  • You can populate field lookup buttons (remember to link these to the associated entry field on the VEIP extension)

  • Refer to the example application for more examples C:\Users\Public\Documents\SoftVelocity\Clarion9\Accessory\VirtualEIP\veipdemo.app

Add the Procedure Extension Template to your Form

1. Right click on your Form and choose Extensions

2. Press Insert, then select VirtualEIPForm – Virtual EIP Form Support to add the extension template.

3. On the General Tab, you must choose the field equates for the OK/CANCEL buttons.

1. You may optionally choose to display a small OK, Cancel, and Help button on your VEIP Form.  These buttons are automatically resized at runtime, have button text removed, and are assigned an icon: VEIP_Ok.ico, VEIP_Can.ico, or VEIP_Hlp.ico.  You may redesign these icons if you don’t like the style. They are located in the <Clarion9>\Accessory\Images folder.

2. You may choose any combination of zero to all three of the OK, Cancel, Help buttons.

3. If you do choose to display the Help button, then you must select the field equate for this button

4. On the Actions tab you choose how you want the VEIP templates to handle various key presses.

1. e.g. for the UP/DOWN keys

Set Save to True to automatically save the form (Post EVENT:Accepted to OK button) when pressing the Up/Down key

Remain Editing will cause the form to edit the next/previous record in the browse

Retain Column will cause it to remember which column you’re in.

Experiment to get the feel of these

• 1. Use the Lookup Buttons Tab, if you have any “FieldLookupButton”, or “DateLookupButton” or “DosFileLookupButton” on your form

• 1. For each button, you must choose the field equate of the button, and match it with the field equate of the related entry field.

  2. The VEIP templates then automatically position the lookup button at the end of this field.

  3. You may set PROP:Skip to true/false depending on whether you want the user to be able to activate the lookup button with the keyboard, or just the mouse.

Other Browses

Clarion (Legacy and ABC) are both supported

PowerBrowse (Legacy and ABC) are both supported. 

CCS Sql browse is also supported.

UltraTree Abc browse is supported.

Populate the VEIP browse extensions in a similar manner to standard Clarion browse.

FAQ - Frequently Asked Questions

View the FAQ

Version History

 1.5 - 5 December 2013

• Fix repositioning of form on Browse in Windows 7/8

• New install program

1.4c    5 Oct 2005

• Make compatible with C6.1

• Allow VEIPQueue update to have parameters

1.4a    15 July 2003

• Template bug fix, make work with C6 

1.4     22 August 2002

• Add class wrapper

1.3     7 August 2002

• Add "Select Columns" switch (Browse)

• Add "Use VCR Request" switch (browse)

• Improve After/Bottom Insert strategies (Browse)

• Fix XP form alignment issue (Form)

• Conditional VEIP (Form - Other Tab)

• Post Accepted to Focus() (Form - Other Tab)

1.2    22 July 2001

• Improve VEIP form window positioning

1.1     21 June 2001

• Add override color on form option

• add keycode to force lookup (Lookup buttons)

• add option to force PROP:Touched (lookup buttons)

1.0 Gold  - 30 May 2001

• • Updated documentation.

Beta 4 - 23 May 2001

• • Browse - require the LIST box equate to be specified

  • Form - allow for nudge factors

  • Form - position correctly over File Loaded browse

  • Added Support for CCS SQL Browse

  • Improved support for PowerBrowse

Beta 3 - 13 March 2001

• • Change Browse to require one VEIP extension template for every browse on the window

  • Add option for InsertionPoint - Before | After | Top | Bottom (Browse Extension)

  • Add Disable tab (Browse Extension) to automatically disable fields when using EIP.