Funktion Mit der CallVB-Anweisung können Sie aus einem GuiXT Script oder InputScript .NET-Funktionen aufrufen – unabhängig davon, ob diese in C#, VB.NET oder einer anderen .NET-Sprache implementiert sind. Die aufgerufene Funktion kann
  • auf die übergebenen Parameter zugreifen (Strings oder Objekte)
  • einen String oder ein Objekt zurückgeben
  • GuiXT Variablen und Langtextvariablen lesen und setzen
  • einen eigenen Screen (Windows.Forms-Technologie) mit form.ShowDialog() anzeigen
  • Methoden eines über in die SAP GUI Maske eingebundenen ActiveX-Controls aufrufen
  • Mit der analogen Anweisung das SAP GUI Scripting verwenden

Die .NET Klassenbibliothek (dll) kann lokal oder zentral, z.B. im SAP Mime Repository, zur Verfügung gestellt werden.

Voraussetzungen:

  • Komponente "GuiXT Controls" ist aktiv
  • Im GuiXT Profile ist das Verzeichnis ".NET class libraries" (guixt.ini-Parameter VBDirectory) angegeben. Es kann sich wie bei den Scriptverzeichnissen um ein lokales Verzeichnis handeln oder zentral imSAP MIME Repository liegen; z.B.

    VBDirectory  SAPMR:SAP/BC/BSP/SAP/GUIXT/VB
  • Die
  • Im GuiXT Profile ist das Verzeichnis ".NET class libraries" (guixt.ini-Parameter VBDirectory) angegeben. Es kann sich wie bei den Scriptverzeichnissen um ein lokales Verzeichnis handeln oder zentral im SAP MIME Repository liegen; z.B.

    VBDirectory  SAPMR:SAP/BC/BSP/SAP/GUIXT/VB
  • Die Schnittstellenbibliothek guinet.dll (in dem GuiXT Setup enthalten) und die aufgerufene eigene Klassenbibliothek liegen in dem VBDirectory-Verzeichnis
Beispiel CallVB msg = utilities.email.send

Die .NET Klassenbibliothek "utilities.dll" wird aus dem im GuiXT Profile angegebenen Verzeichnis ".NET class libraries", guixt.ini-Parameter VBDirectory, geladen. Es wird pro SAP GUI -Modus ein Objekt der angegebenen Klasse "email" aus "utilities.dll" angelegt. Die Funktion "send" des Objekts wird aufgerufen und ihr Rückgabewert in V[msg] gespeichert.

Format 1 CallVB progname.classname.funcname "par1" "par2 "par2" ...

Die  Funktion funcname eines pro SAP GUI Modus angelegten Objekts der Klasse classname (Klassenbibliothek progname.dll) wird aufgerufen. Die angegebenen Strings "par1", "par2",... werden an die Funktion als Parameter übergeben (Wertübergabe).

Statt der Übergabe als Positionsparameter können Sie auch den in VB definierten Parameternamen angeben. Beispiel:

CallVB utilities.email.send emailaddr:="&V[email]" cc:="&V[cclist]" subject:="&V[subject]" body:="&V[mytext]"

Format 2 CallVB varname = progname.classname.funcname "par1" "par2 "par2"

Die  Funktion funcname eines pro SAP GUI Modus angelegten Objekts der Klasse classname (Klassenbibliothek progname.dll) wird aufgerufen. Die angegebenen Strings "par1", "par2",... werden an die Funktion als Parameter übergeben (Wertübergabe). Das Resultat der Funktion wird in einen String umgewandelt und in die Variable V[varname] gestellt.

Details zum Ablauf Bei der ersten Ausführung einer CallVB-Anweisung für eine Klassenbibliothek "progname.dll"  wird diese in die VB.NET Laufzeitumgebung geladen. Dazu wird sie, falls das SAP MIME Repository im Profile als VBDirectory angegeben ist, von dort zunächst in das lokale GuiXT-Cache-Verzeichnis kopiert.

Falls Sie das SAP Web Repository oder SAP MIME Repository verwenden, bitte mit VersionNumber arbeiten.

Ebenfalls kopiert wird, falls erforderlich,  die Schnittstellenbibliothek guinet.dll.

Als nächstes wird pro SAP GUI Modus genau ein Objekt der Klasse classname angelegt und die Funktion funcname des Objekts aufgerufen.

Die Parameterübergabe an die Funktion erfolgt als Wertübergabe von Strings, ebenso wird der Rückgabewert als String in die angegebene GuiXT-Variable gestellt. Einzige Ausnahme: siehe den nachfolgenden Abschnitt über Objektreferenzen.

In der VB-Funktion können Sie lesend und schreibend auf GuiXT Variablen und Langtextvariablen zugreifen, siehe Klasse "guixt" in VB. Damit können Sie eine Referenzübergabe einer Variablen dadurch realisieren, dass Sie statt eines Wertes den Namen der Variablen an die VB-Funktion übergeben und dort mit guixt.GetVariable() und guixt.SetVariable() arbeiten.

Konvertierung der Werte Deklariert eine .NET-Funktion ihre Parameter als skalare Typen ungleich String (z. B. Integer, Decimal, Double oder Date), führt GuiXT beim Aufruf automatisch eine Konvertierung vom GuiXT-String in den Zieltyp durch. Technisch erfolgt dies innerhalb der .NET-Umgebung über die Methode CTypeDynamic.

Skalare Rückgabetypen wandelt GuiXT automatisch in einen String um.  Dabei wird "Boolean" als "-1" für True, "0" für False zurückgegeben. Für Datumswerte und Dezimalzahlen wirken sich die Regionaleinstellungen des Benutzers aus.

Empfehlungen zur Typisierung:

  • Eingabeparameter: Bei Dezimalzahlen oder Datumsangaben ist es oft sicherer, die Parameter in .NET zunächst als String entgegenzunehmen. So können Sie die Konvertierung innerhalb der Funktion selbst kontrollieren und potenzielle Fehler durch abweichende Formate vermeiden.
  • Rückgabewert: Soll ein Rückgabewert nicht nur angezeigt, sondern in GuiXT logisch weiterverarbeitet werden, sollte die .NET-Funktion diesen als String in einem festen Format (z. B. YYYYMMDD) zurückgeben. Dies verhindert Fehler durch unterschiedliche Einstellungen auf verschiedenen Client-Rechnern.

Beispiel mit automatischer Konvertierung: 

Public Function sqrt(n As Double) As Double
  Return Math.Sqrt(n)
End Function

Beispiel mit eigener Konvertierung (empfehlenswert): 

Public Function sqrt(n As String) As String
  Dim number As Double = Double.Parse(n, NumberStyles.Any,
        CultureInfo.InvariantCulture)

  Return Math.Sqrt(number).ToString(CultureInfo.InvariantCulture)

End Function

GuiXT
CallVB result = util.calculations.sqrt "2" 

Als Resultat wird "1.4142135623731" zurückgegeben.

Objektreferenzen Die Parameterübergabe von Objektreferenzen an GuiXT Variablen ist in beide Richtungen möglich. GuiXT benutzt dazu eine String-Darstellung der Objektreferenz und konvertiert automatisch zwischen der Stringdarstellung und der Objektreferenz (technisch: eine "IDispatch" Schnittstelle). Sie können also zum Beispiel in VB eine Klasse definieren, in einer VB Funktion ein Objekt der Klasse mit New anlegen und die Objektreferenz an GuiXT zurückgeben. An eine weitere VB-Funktion können Sie dann aus GuiXT die Objektreferenz als Parameter übergeben und in der Funktion auf Attribute und Methoden des Objekts zugreifen.

Beispiel:

In der VB.NET-Funktion "newcustomer" legen Sie ein Objekt der von Ihnen definierten Klasse "customer" an, setzen ein Attribut ("name") und geben die Objektreferenz an GuiXT zurück: 

Public Function newcustomer() As customer

  Dim c As New customer

  c.name = "abc GmbH"

  Return c

End Function

In einer zweiten Funktion erwarten Sie als Parameter ein Objekt der Klasse "customer" und liefern den Namen zurück:

Public Function customername(ByVal cust As customer) As String

  Return cust.name

End Function

In GuiXT rufen Sie die erste Funktion auf und stellen das Ergebnis in eine Variable. Später können Sie dann die zweite Funktion aufrufen und den Inhalt der Variablen als Objektreferenz übergeben:

GuiXT
CallVB c1 = mylib.class1.newcustomer

...

CallVB name = mylib.class1.customername "&V[c1]"


Jetzt enthält V[name] den String "abc GmbH".

Behandlung von .NET Exceptions Beim Aufruf der .NET Methode kann an verschiedenen Stellen eine Exception (Ausnahme mit Abbruch des CallVB) auftreten:
  • Die Methode wird nicht gefunden
  • Die Parameterübergabe ist nicht möglich (falsche Parameterzahl, nicht konvertierbare Werte,...)
  • Die aufgerufene Methode bricht mit einer Exception ab

In allen Fällen setzt GuiXT als Rückgabewert auf "" und erzeugt eine Fehlermeldung im "Script" Fenster, dem InputScript Trace sowie im GuiXT Script Editor Pro, setzt aber die Verarbeitung des Scripts fort.

SIe können nach CallVB mit if not Q[ok] abfragen, ob eine Exception aufgetreten ist; in der Systemvariablen V[_exception] steht dann der entsprechende Fehlertext. Hier sind einige Beispiele:


GuiXT
CallVB result = util.calculations.sqroot "2" 

if not Q[ok] 
  Message "E: &V[_exception]" title="Exception in CallVB"
  Return
endif

Nachricht: "Method 'sqroot' not found in class 'calculations' of dll C:\GuiXT\VB\util.dll"
GuiXT
CallVB result = util.calculations.sqroot "abc" 

if not Q[ok] 
  Message "E: &V[_exception]" title="Exception in CallVB"
  Return
endif

Nachricht bei Parametertype "Double":
"VB.NET Exception for parameter 'n': Die Eingabezeichenfolge hat das falsche Format. Conversion from string "abc" to type 'Double' is not valid."

Nachricht bei bei Parametertyp "String" und eigener Konvertierung:
"VB.NET Exception: Die Eingabezeichenfolge hat das falsche Format."


Sie können in der .NET Methode auch eigene Prüfungen durchführen und dann durch "Throw" eine Exception mit einem selbstdefinierten Text auslösen:
Public Function sqrt(n As String) As String
  Dim number As Double
  If Not Double.TryParse(n, NumberStyles.Any, 
    CultureInfo.InvariantCulture, number) Then
      Throw New Exception
        ("Invalid value passed to method util.sqrt: " + n)
  End If
  Return Math.Sqrt(number)
           .ToString(CultureInfo.InvariantCulture)
 End Function

GuiXT
CallVB result = util.calculations.sqrt "abc" 

if not Q[ok] 
  Message "E: &V[_exception]" title="Exception in CallVB"
  Return
endif

Nachricht:
"VB.NET Exception: Invalid value passed to method util.sqrt: abc"





Debugging Sie können mit einer "Stop" Anweisung in der VB.NET Funktion den Debugger (Visual Studio) aktivieren.

Alternativ können Sie auch in Visual Studio über "Debug -> Attach to process" dynamisch den Debugger für eine laufende SAP GUI Session aktivieren.  Dabei als Prozess "saplogon.exe" angeben.
Beispiel 2 Wir starten Excel mit einigen Demowerten:
GuiXT
// GuiXT Script

// set some demo values
Set V[region.1] "Americas"
Set V[sales.1] "2584"
 
Set V[region.2] "Europe"
Set V[sales.2] "1228"

Set V[region.3] "Asia"
Set V[sales.3] "1628"

// call excel
CallVB excel = mylib.office.StartExcel 3

In VB.NET nehmen wir in unserem Projekt am besten eine Referenz auf "Microsoft.Office.Interop.Excel" auf, damit wir typisiert (statt nur mit "Object") arbeiten können.

Function StartExcel(ByVal rows As String) As Excel.Application

  Dim oXL As Excel.Application
  Dim oWB As Excel.Workbook
  Dim oSheet As Excel.Worksheet

  oXL = CreateObject("Excel.Application")
  oXL.Visible = True

  oWB = oXL.Workbooks.Add()
  oSheet = oWB.ActiveSheet
  oSheet.Columns(1).ColumnWidth = 30
  oSheet.Columns(2).ColumnWidth = 20

  For k = 1 To CInt(rows)
    oSheet.Cells(k, 1).Value = 
             guixt.GetVariable("region." & k)
    oSheet.Cells(k, 2).Value = 
             guixt.GetVariable("sales." & k)
     Next
   
    Return oXL

End Function
 .NET und Javascript Im Tutorial Fortgeschritten: JS, .NET, WASM wird gezeigt, wie Sie .NET mit anderen Technologien (JavaScript und WASM) in GuiXT-Anwendungen integrieren können.
Tips & Tricks
Komponente GuiXT + Controls