Directives 

*Deprecated*
VBX support is discontinued as of PxPlus v7. Execution of this directive will result in an Error #99: Feature not supported.

Formats

Where:

Description

Use the CUSTOM_VBX directive to load and define a given VBX custom control object. You must use the same logical ID number (assigned in Format 1) for all subsequent references to your custom VBX.

Note:
You can use VBX's in both Windows and UNIX systems when running in graphics mode of PxPlus. There is no text mode support since VBX's are Windows programs that require a graphical Windows device.

TCB(80) Status Codes

Whenever an error is detected in the VBX interface logic, PxPlus returns the VBX status or error code in TCB(80). The chart below lists the status codes.

Format 1

Define VBX, Logical ID
  
CUSTOM_VBX id,@(col,ln,wth,ht),name$,control$[,fileopt]

Use this format to define or create a VBX custom control object and assign it a unique logical ID:

0020 custom_vbx 100, @(10,10,10,10),"MHCD200.VBX","MhCardDeck"

When you create the VBX custom control object, you can set default properties. Use the TBL="property=value" option. The last character in the list sets the delimiter for the rest. 

Format 2

Define Event
  
CUSTOM_VBX DEFCTL id,ctl_val,event$[,ERR=stmtref]

Use the CUSTOM_VBX DEFCTL format to define the CTL values for events:

0030 custom_vbx defctl 100,101,"Click"

Format 3

List Event Names
  
CUSTOM_VBX DEFCTL id,*,list$[,ERR=stmtref]

It is recommended that you refer to your proprietary VBX documentation for information on VBX events and properties. However, you can also obtain a list of VBX events by using PxPlus to create a custom VBX on the screen and then using the CUSTOM_VBX DEFCTL format:

0030 custom_vbx defctl 100,*,A$

The string variable receives a list of events (comma-separated and in numeric order).

Format 4

Add Item to List
  
CUSTOM_VBX LOAD id,index,val$[,ERR=stmtref]

Use the CUSTOM_VBX LOAD format to add an item to a custom VBX list:

0130 custom_vbx load 150,6,"abc"

Format 5

Remove Item from List
  
CUSTOM_VBX LOAD id,index,*[,ERR=stmtref]

Use this CUSTOM_VBX LOAD format to remove an item from a custom VBX list. Note the asterisk in place of a value to indicate that you want an item removed.

Example:

To remove item 86 from the custom VBX whose id is 15000:

0190 custom_vbx load 15000,86,*

Format 6

Read Property
  
CUSTOM_VBX READ id,property$,var$[,array_element][,ERR=stmtref]

Use the CUSTOM_VBX READ format to read the current value of a property:

custom_vbx read 100,"Suit",RND(4) 

Format 7

List Properties
  
CUSTOM_VBX READ id,*,list$[,ERR=stmtref]

It is recommended that you refer to the proprietary VBX documentation for each product for information on VBX events and properties. However, you can also obtain a list of event Properties by using PxPlus to create a custom VBX on the screen and then using the CUSTOM_VBX READ format. The string variable receives the list (comma-separated and in numeric order). If you then issue a CUSTOM_VBX READ id,"",X$ (with a null value in place of the asterisk), you will receive a string of characters indicating property types. Lowercase values indicate arrays. The property types are listed as follows:

Format 8

Write Property

CUSTOM_VBX WRITE id,property$,val$[,array_element][,ERR=stmtref]

Use the CUSTOM_VBX WRITE format to update or write a property:

0080 custom_vbx write 100,"Value",RND(13)+1 
0090 custom_vbx write 100,"Suit",RND(4) 

Format 9

Disable/Enable
  
CUSTOM_VBX {DISABLE | ENABLE} id[,ERR=stmtref]

Use the CUSTOM_VBX DISABLE format to gray out a custom VBX so that it will be visible but inaccessible, to users. To reactivate it, use CUSTOM_VBX ENABLE.

0150 custom_vbx disable 100

Format 10

Set Focus
  
CUSTOM_VBX GOTO id[,ERR=stmtref]

Use the CUSTOM_VBX GOTO format to set the focus on a custom VBX:

0130 custom_vbx goto 100

Format 11

Remove VBX
  
CUSTOM_VBX REMOVE id[,ERR=stmtref]

Use the CUSTOM_VBX REMOVE format to remove or delete a custom VBX:

0150 custom_vbx remove 100

Format 12

Hide/Show VBX
  
CUSTOM_VBX {HIDE | SHOW} id[,ERR=stmtref]

Use the CUSTOM_VBX HIDE format to prevent the display of a custom VBX:

0150 custom_vbx hide 100

Use the CUSTOM_VBX SHOW format to restore the display.

Examples

This simple "Shuffle the Deck" program uses the Microhelp Card Deck VBX. It will shuffle the deck whenever the mouse is clicked on the card displayed on the screen.

0010 print 'CS'
0020 custom_vbx 100,@(10,10,10,10),"MHCD200.VBX","MhCardDeck"
0030 custom_vbx defctl 100,101,"Click"
0040 obtain (0,siz=1)'ME',A$,'MN',
0050 if ctl=4 then end
0060 if ctl<>101 then goto 0040
0070 for I=1 to 10
0080 custom_vbx write 100,"Value",rnd(13)+1
0090 custom_vbx write 100,"Suit",rnd(4)
0100 wait .05
0110 next
0120 goto 0040

This program randomly updates the two properties "Value" (card 1-13) and "Suit"(0-3) with a short delay between updates. Note that the event is defined as CTL 101 whenever the mouse is clicked on the card.