Das ActiveX-Control 'OXACTIVE'

Über das ActiveX-Control oxactive.dll stehen Ihnen Methoden und Objekte zur Verfügung, mit denen Sie Daten aus der Übergabedatei und aus Konfigurationsdateien leicht auslesen und ändern können.

Das Control wird bei der Installation von enaio® automatisch installiert und registriert.

Das Control können Sie direkt über das VBScript-AddOn im VBScript-Editor benutzen. Aus anderen Umgebungen können Sie das ActiveX-Control oxactive.dll folgendermaßen einbinden:

Methoden

GetProfString()

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

Diese Funktion stellt die Funktionalität der Windows-API Funktion GetPrivateProfileString zur Verfügung.

Beispiel:

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

Falls der Wert ermittelt werden kann, wird der Wert des Schlüssels '#OSEXP#' des Abschnitts 'PAGE00' in die Variable 'rvalue' geschrieben, andernfalls '-1'.

WriteProfString()

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

Diese Funktion stellt Ihnen die Funktionalität der Windows-API Funktion WritePrivateProfileString zur Verfügung.

Bevor die Methode oxhelp.WriteProfString() verwendet werden kann, rufen Sie die Methode WriteToFile() auf.

ExtractString()

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

Mit dieser Funktion teilen Sie einen String in zwei Hälften. Das Trennzeichen muss entweder das Zeichen '\021' oder ASCII-Code '17' sein.

WinExec()

HRESULT WinExec(BSTR strFile, BSTR strParams)

Über diese Funktion können Sie Anwendungen starten und diesen Parameter übergeben.

Objekte

Folgende Objekte stellt das ActiveX-Control oxactive.dll zur Verfügung:

• ASFile-Objekt: bietet Zugriff auf die AddOn- bzw. Event-Übergabedatei

• RequestPages-Objekt: umfasst alle Register einer Indexdatenmaske (Kollektion von RequestPage-Objekten)

• RequestPage-Objekt: ein einzelnes Datenblatt

• ActivePage-Objekt: hierbei handelt es sich um ein spezielles RequestPage-Objekt, nämlich einen Verweis auf das aktive Datenblatt

• ASFields-Objekt: umfasst alle Felder einer Indexdatenmaske (Kollektion aller ASField-Objekte)

• ASField-Objekt: ein einzelnes Feld einer Maske

Über diese Objekte lesen Sie Daten der Übergabedatei und verändern diese.

Beispiel:

Sie können den Wert des Felds 'Jahr' über eine der beiden folgenden Varianten auslesen:

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

Bei a) wird das Feld über das ActivePage-Objekt ausgelesen, bei b) über die RequestPages-Kollektion.

ASFile-Objekt

Das ASFile-Objekt bietet Ihnen Zugriff auf die AddOn- bzw. Event-Übergabedatei. Diese Übergabedatei enthält Informationen zur Indexdatenmaske.

Eigenschaften:

L – nur Lesezugriff

S – nur Schreibzugriff

L/S – Lese- und Schreibzugriff

Methoden:

RequestPages-Objekt

Über dieses Objekt erhalten Sie Zugriff auf eine Kollektion von RequestPage-Objekten.

Eigenschaften:

L – nur Lesezugriff

S – nur Schreibzugriff

L/S – Lese- und Schreibzugriff

Methoden:

RequestPage-Objekt

Dieses Objekt erlaubt Ihnen Zugriff auf ein einzelnes Datenblatt der Indexdatenmaske.

Eigenschaften:

L – nur Lesezugriff

S – nur Schreibzugriff

L/S – Lese- und Schreibzugriff

ASFields-Objekt

Dieses Objekt stellt eine Kollektion von ASField-Objekten dar.

Eigenschaften:

L – nur Lesezugriff

S – nur Schreibzugriff

L/S – Lese- und Schreibzugriff

Methoden:

ASField-Objekt

Über dieses Objekt erhalten Sie Zugriff auf ein einzelnes Feld in einer Anfragemaske.

Eigenschaften:

L – nur Lesezugriff

S – nur Schreibzugriff

L/S – Lese- und Schreibzugriff

Mögliche Datentypen sind:

Für Feldbezeichnungen sollten Sie die internen Namen verwenden, insbesondere bei Objektdefinitionen mit mehreren Sprachen. Interne Namen werden in Prozentzeichen geklammert angegeben.

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

Anwendungsbeispiele in VBScript

Werden die oben beschriebenen Objekte in enaio® client durch einen Event oder vom VBScript-AddOn verwendet, brauchen Sie das ASFile-Objekt und das CoxHelp-Objekt nicht explizit erstellen. Auch die Eigenschaft 'Filename' des ASFile-Objekts wird automatisch gesetzt.

Beispiel 1

Ausgabe der Namen aller Datenblätter:

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

Beispiel 2

Ausgabe aller Feldnamen des gerade aktiven Datenblattes, sowie Änderung eines Feldinhaltes für einen 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()

Beispiel 3

Ausgabe des Namens des AddOn-Felds, sowie dessen Inhalt im Datenblatt und anschließende Änderung des Inhalts des AddOn-Felds:

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

Beispiel 4

Farbliches Markieren eines Datenblatt-Felds auf einem Pagecontrol mit Aktivierung der entsprechenden Seite und Ausgabe einer Fehlermeldung als Tooltip für das Event 'OnClickItem' oder 'BeforeValidate':

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

Beispiel 5

Unterscheiden, ob eine Abfrage im Expertenmodus durchgeführt wurde oder nicht durch Auslesen des Schlüssels #OSEXP# der Übergabedatei:

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