Wie schreibt man einen VBScript-Code für M-Files Zwecke?

In VBScript beendet ein Zeilensprung eine Anweisung und es gibt deshalb kein bestimmtes Zeichen zur Beendigung einer Anweisung. Das nachfolgende Beispiel enthält zwei Anweisungen:

Dim szPropertyName
szPropertyName = PropertyDef.Name

Falls Sie eine Anweisung in zwei Linien darstellen wollen, müssen Sie einen Unterstrich verwenden (_), um anzugeben, das die Anweisung auf der folgenden Zeile fortgesetzt wird:

Err.Raise MFScriptCancel, _
    "The document vault already contains an object with the same title. Please choose another title."

Sie sollten immer alles kommentieren, was im Code ausgeführt wird, damit Außenstehende, die Ihren Code lesen, verstehen, welchen Zweck er verfolgt. Sie können dabei Ihrem Code einen Kommentar hinzufügen, indem Sie das ' Zeichen verwenden:

' Get the title of the object.
Dim szCurrentTitle
szCurrentTitle = oCurrentTitleProp.GetValueAsUnlocalizedText

Es ist dabei ratsam, einen Kommentar über der Codezeile anzubringen, die Ihres Erachtens für den Leser nicht unmittelbar verständlich ist.

Variablen werden durch Verwendung des Dim Schlüsselworts deklariert:

Dim szCurrentTitleProp

Werte werden Variablen durch Verwendung des Gleichheitszeichens (=) zugewiesen. Sie sollten Ihre Variablen immer festlegen, bevor Sie ihnen neue Werte zuweisen:

Dim szCurrentTitleProp
szCurrentTitleProp = PropertyValues.SearchForProperty( iTitleProperty ).GetValueAsUnlocalizedText

Sie können dazu die Option Explicit Anweisung verwenden, um eine ausdrückliche Festlegung von allen Variablen zu erzwingen. Falls Sie versuchen, eine nicht deklarierte Variable zu verwenden, wenn Option Explicit in Ihrem Skript aktiviert ist, funktioniert das Skript nicht. Das folgende Script funktioniert beispielsweise nicht, wenn die Variable szValue nicht festgelegt wurde, bevor ihr ein Wert zugewiesen wird:

Option Explicit
szValue = PropertyValue.GetValueAsUnlocalizedText

Falls Sie in M-Files skripten, steht Ihnen eine Anzahl von vordefinierten Variablen zur Verfügung. Die Variablen PropertyValue können zum Beispiel dazu verwendet werden, um den Wert einer Eigenschaft festzulegen. Siehe Verfügbare VBScript-Variablen für eine vollständige Liste von vordefinierten Variablen.

Sie können Konstanten verwenden, um Werte zu speichern, die im Skript konstant eingehalten werden müssen.

Const iMaxNumberOfItems = 50

Beachten Sie, dass Sie einer Konstante einen Buchstabenwert zuweisen müssen. Sie können keine Variable, andere Konstante oder Funktion verwenden, um eine Konstante zu initialisieren.

Objekte werden Variablen durch Verwendung der Set Anweisung zugewiesen. Sie können eine neue Instanz eines M-Files API-Objekts erstellen und dieses auf folgende Art und Weise einer Variablen zuweisen:

Dim oTitleSearch
Set oTitleSearch = CreateObject( "MFilesAPI.SearchCondition" )

Objekte sind Komponenten, die ihre eigenen Eigenschaften und Methoden aufweisen. Methoden sind Funktionen, die zu einem spezifischen Objekt gehören und im Kontext mit diesem Objekt verwendet werden können. Andererseits dienen die Eigenschaften dazu, die Werte eines Objekts anzuzeigen oder festzulegen. Sie können auf die Eigenschaften und Methoden eines Objekts zugreifen, indem Sie die Punktnotation verwenden:

oTitleSearch.Set oTitleExpression, MFConditionTypeEqual, oTitleTypedValue

Methodenargumente wie oTitleExpression, MFConditionTypeEqual, und oTitleTypedValue im oben genannten Beispiel werden nach der Methode aufgelistet und durch Komma getrennt. Parameter werden entweder durch Wert oder Referenz weitergegeben. Falls eine Methode einen Parameter anhand eines Werts übernimmt, kopiert die Methode den Wert als Argument, weshalb der Originalwert unverändert bleibt. Falls andererseits eine Methode einen Parameter durch Referenz übernimmt, schlagen sich alle Änderungen, die die Methode auf das Argument ausüben kann auch in der Originalreferenz nieder. Der Wert Nothing sollte verwendet werden, wenn der standardmäßige Parameterwert nicht benutzt werden kann.

Sie können zwei oder mehre Zeichenfolgen zu einer verknüpfen, indem Sie den & Operator verwenden:

' Get proposal number.
Dim szNumber
szNumber = PropertyValues.SearchForProperty( 1156 ).TypedValue.DisplayValue

' Get customer.
Dim szCustomer
szCustomer = PropertyValues.SearchForProperty( 1288 ).TypedValue.DisplayValue

' Create proposal title.
Dim szName
szName = "Proposal #" & szNumber & " / " & szCustomer

In den oben genannten Beispielen, ist der vorgeschlagene Titel, der in der Variable szName gespeichert wird, das Resultat einer Verknüpfung der folgenden Zeichenfolgen:

• Zeichenfolge aus Buchstaben Proposal #
• die vorgeschlagene Nummer, die in der szNumber Variablen gespeichert ist
• eine andere Zeichenfolge aus Buchstaben /
• den in der szCustomer Variablen gespeicherten Kundennamen

Der resultierende Angebotstitel könnte beispielsweise Proposal #5577 / ESTT lauten.

Sie können der Zeichenfolge einen Zeilenumbruch hinzufügen, indem Sie die VbCrLF Konstante mit Ihren Zeichenfolgen verknüpfen:

Err.Raise MFScriptCancel, _
    "The document vault already contains an object with the same title." & VbCrLF & "Please choose another title."

Falls Sie einen Eigenschaftswert mit VBScript validieren müssen, ist es notwendig, dass dem Benutzer eine Fehlermeldung angezeigt wird, wenn der Wert, den der Endbenutzer eingibt, ungültig ist. Sie können eine Fehlermeldung in VBScript ausgeben, indem Sie die Raise Methode des Err Objekts verwenden:

Err.Raise MFScriptCancel, "The property """ & szPropertyName & """ must have a value of at least 10 characters."

Die Methode übernimmt die Fehlernummer und Beschreibung als Parameter. Für M-Files Skriptzwecke wird die MFScriptCancel Variable verwendet, da sie die M-Files Fehlernummer speichert.

If Anweisungen werden dazu verwendet, eine Gruppe von Anweisungen auszuführen, falls die Bedingung, die in der If Anweisung festgelegt wurde, wahr ist:

If Len( szValue ) < 10 Then

    Err.Raise MFScriptCancel, "The property """ & szPropertyName & """ must have a value of at least 10 characters."

End If

Der „If“ Block muss mit einer End If Anweisung beendet werden. Alle Anweisungen zwischen If und End If werden ausgeführt falls die Bedingung, die zwischen If und Then festgelegt ist, als wahr gilt. Sie können den And Operator verwenden, um zahlreiche Bedingungen festzulegen, die alle erfüllt sein müssen, damit der Block ausgeführt werden kann oder den Or Operator verwenden, um zahlreiche Operatoren festzulegen, von denen einer wahr sein muss, damit der Block ausgeführt werden kann. Sie können folgende Vergleichsoperatoren benutzen, um die Bedingung festzulegen:

• == prüft, ob der Wert der zwei Operanden gleich ist oder nicht. Falls ja, ist die Bedingung wahr.
• <> prüft, ob der Wert der zwei Operanden gleich ist oder nicht. Falls nein, ist die Bedingung wahr.
• > prüft, ob der Wert des linken Operanden größer ist als der Wert des rechten Operanden. Falls ja, ist die Bedingung wahr.
• < prüft, ob der Wert des linken Operanden kleiner ist wie der Wert des rechten Operanden. Falls ja, ist die Bedingung wahr.
• >= prüft, ob der Wert des linken Operanden größer oder gleich ist wie der Wert des rechten Operanden. Falls ja, ist die Bedingung "wahr"
• <= prüft, ob der Wert des linken Operanden kleiner oder gleich ist wie der Wert des rechten Operanden. Falls ja, dann ist die Bedingung "wahr"

Sie können auch eine If Anweisung innerhalb einer anderen If, sagen wir einer Else Anweisung verschachteln, oder die ElseIf Anweisung benutzen, um eine tiefere logische Verzweigung in Ihrem Skript zu erreichen.

Sie können eine Unterroutine dazu verwenden, um einen Codeabschnitt zu definieren, der in Ihrem Code durch Referenz mehrmals verwendet wird:

Sub CloseFile()
    oMyFile.Close
    Set oMyFile = Nothing
End Sub

Oder Sie können eine Funktion definieren, um mehrmals einen Codeabschnitt zu verwenden, der einen bestimmten Wert ausgeben soll:

Function IsOdd( iValue )
    If iValue MOD 2 = 0 Then ' Even value.
        IsOdd = False
    Else ' Odd value.
        IsOdd = True
    End If
End Function

Um eine Unterroutine oder Funktion in Ihrem Skript aufzurufen, einfach den Namen bezeichnen:

Closefile()
IsOdd( 5 )