The ActiveX Control 'OXACTIVE'

The ActiveX control oxactive.dll offers methods and objects that allow reading and editing data of the handoff file and the configuration file.

During the installation of enaio®, the control will be installed and registered automatically.

The control can be directly used in the VBScript editor through the VBScript add-on. In other environments, the ActiveX control oxactive.dll is integrated as follows:

Methods

GetProfString()

HRESULT GetProfString(BSTR bstrSec, BSTR bstrKey, BSTR bstrDefault, VARIANT* pvarReturn, BSTR bstrFile)

This function provides the functionality of the Windows API function GetPrivateProfileString.

Example:

oxhelp.GetProfString "PAGE00","#OSEXP#",-1,rvalue,osfile

If the value cannot be determined, the value of the '#OSEXP#' key in the 'Page00' section is written to the 'rvalue' variable; otherwise '-1'.

WriteProfString()

HRESULT WriteProfString(BSTR bstrSection, BSTR bstrKey, BSTR bstrValue, BSTR bstrFile)

This function provides the functionality of the Windows API function WritePrivateProfileString.

The WriteToFile() method must be called prior to the oxhelp.WriteProfString() method can be used.

ExtractString()

HRESULT ExtractString(BSTR strVal, VARIANT* pFieldName, VARIANT* pFieldValue)

This function helps split the string into two parts. As a separator, either the character '\021' or ASCII code '17' must be used.

WinExec()

HRESULT WinExec(BSTR strFile, BSTR strParams)

This function allows you start the application and pass the parameter.

Objects

The ActiveX control oxactive.dll offers the following objects:

• ASFile Object: allows access to the add-on or the event's handoff file

• RequestPages object: comprises all registers of an index data form (collection of RequestPage objects)

• RequestPage Object: a single data sheet

• ActivePage object: is a RequestPage object, that is, a reference to the active data sheet

• ASFields Object: comprises all fields of an index data form (collection of all ASField objects)

• ASField Object: a single field of a form

These objects are used to read and edit the data of the handoff file.

Example:

The value of the 'Year' field can be read with one of the two following variants:

ActivePage.ASFields.Item("Jahr").Value
RequestPages.Item("WF-Protokoll").ASFields.Item("Jahr").Value

Method a) will read the field through the ActivePage object; method b) through the RequestPages collection.

ASFile Object

The ASFile object allows for access to the add-on or the event's handoff file. This handoff file contains information on the index data form.

Properties:

L – read-only

S – write access only

L/S – read and write access

Methods:

RequestPages Object

This object allows for access to a collection of RequestPage objects.

Properties:

L – read-only

S – write access only

L/S – read and write access

Methods:

RequestPage Object

This object allows you to access a single data sheet of the index data form.

Properties:

L – read-only

S – write access only

L/S – read and write access

ASFields Object

This object represents a collection of ASField objects.

Properties:

L – read-only

S – write access only

L/S – read and write access

Methods:

ASField Object

This object allows you to access a single field of a search form.

Properties:

L – read-only

S – write access only

L/S – read and write access

Available data types:

You should use the internal names for field names, especially when it comes to object definitions containing several languages. Internal names are enclosed in percent signs.

ActivePage.ASFields.Item("%internalname%").Value = 'newValue'
ResultCode = 1
WriteToFile()

Examples of Use in VBScript

If, in enaio® client, the aforementioned objects are used through an event or the VBScript add-on, neither the ASFile object nor the CoxHelp object need to be created explicitly. Furthermore, the 'Filename' property of the ASFile object will be set automatically.

Example 1

Output the names of all data sheets:

for b = 0 to RequestPages.Count-1
MsgBox(RequestPages.Item(b).Name)
Next

Example 2

Output all field names of the currently active data sheet as well as change the content of a field for an event:

for b = 0 to ActivePage.ASFields.Count-1
MsgBox(ActivePage.ASFields.Item(b).Name)
Next
ActivePage.ASFields.Item(1).Value = 'neuer Wert'
ResultCode = 1
WriteToFile()

Example 3

Output the name of the add-on field as well as its content in the data sheet and then change the content of the add-on field:

MsgBox (AddonFields.Item(0).Name + ' = ' + AddonFields.Item(0).Value)
AddonFields.Item(0).Value = 'neuer Wert'
WriteToFile()

Example 4

Highlight a data sheet's field on a page control in color and activate the respective page and output an error message in the form of a tooltip for the 'OnClickItem' or 'BeforeValidate' event:

ActivePage.ASFields("PageCtrl").CtrlPages(2).Fields.Item(2).IsErrorField = true
ErrorMessage = "Fehlerhafte Eingabe, bitte korrigieren."
ResultCode = -1
WriteToFile()

Example 5

Distinguish whether a query has been performed in expert mode or not by reading the #OSEXP# key of the handoff file:

oxhelp.GetProfString "PAGE00","#OSEXP#",-1,rvalue,osfile
if ( rvalue = "1") then
  ‘Code für Expertenmodus
else
  ‘Code für nicht-Expertenmodus
end if