Miten kirjoitan VBScript-koodin M-Filesia varten?

VBScriptissä lause loppuu rivinvaihtoon eikä mihinkään erilliseen lopetusmerkkiin. Seuraava esimerkki sisältää kaksi lausetta:

Dim szPropertyName
szPropertyName = PropertyDef.Name

Jos haluat jakaa lauseen eri riveille, voit käyttää alaviivaa (_) osoittamassa, että lause jatkuu seuraavalla rivillä:

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

Lisää koodiin aina selventäviä kommentteja, jotta muutkin koodia lukevat ymmärtäisivät, mistä siinä on kyse. Voit lisätä koodiin kommentin käyttämällä '-merkkiä:

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

Hyvä periaate on lisätä kommentti kaikkien sellaisten koodirivien yläpuolelle, joiden merkityksen ymmärtämisessä lukijalla voi olla vaikeuksia.

Muuttujat määritellään käyttäen avainsanaa Dim:

Dim szCurrentTitleProp

Muuttujille määritetään arvot yhtäsuuruusmerkillä (=). Sinun tulisi aina määritellä muuttujat, ennen kuin määrität niille uusia arvoja:

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

Option Explicit -lauseella voit pakottaa käyttämään muuttujamäärittelyä. Jos yrität käyttää määrittelemätöntä muuttujaa komentosarjassa, jossa on käytössä Option Explicit, komentosarja ei toimi. Esimerkiksi seuraava komentosarja ei toimi, koska muuttujaa szValue ei ole määritelty, ennen kuin sille on määritelty arvo:

Option Explicit
szValue = PropertyValue.GetValueAsUnlocalizedText

M-Files-komentosarjoja tehdessäsi sinulla on käytettävissä joukkoa ennalta määriteltyjä muuttujia. Voit käyttää esimerkiksi muuttujaa PropertyValue ominaisuuden arvon hakemiseen. Katso täydellinen luettelo ennalta määritellyistä muuttujista kohdasta Käytettävissä olevat VBScript-muuttujat.

Voit käyttää vakioita sellaisten arvojen tallentamiseen, joiden on pysyttävä vakioina kautta koko komentosarjan:

Const iMaxNumberOfItems = 50

Huomaa, että sinun on määritettävä vakiolle literaaliarvo. Et voi käyttää muuttujaa, toista vakiota tai funktiota vakion alustamiseen.

Muuttujille määritetään objektit lauseella Set. Voit luoda uuden instanssin M-Files APIn objektista ja määrittää sen muuttujaan seuraavasti:

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

Objektit ovat komponentteja, joilla on omat ominaisuutensa ja metodinsa. Metodit ovat tietylle objektille kuuluvia funktioita, joita voidaan käyttää objektin kontekstissa. Ominaisuuksia taas käytetään objektin arvojen näyttämiseen tai määrittämiseen. Objektin ominaisuuksissa ja metodeissa käytetään pistenotaatiota:

oTitleSearch.Set oTitleExpression, MFConditionTypeEqual, oTitleTypedValue

Metodin argumentit, kuten oTitleExpression, MFConditionTypeEqual ja oTitleTypedValue edellä olevassa esimerkissä, luetellaan metodin jälkeen erotettuna pilkuilla. Parametrit välitetään joko arvona tai viittauksena. Jos metodi käyttää parametria arvona, se kopioi argumenttina välitetyn arvon, ja näin ollen alkuperäinen arvo jää muuttumattomaksi. Jos metodi taas käyttää parametria viittauksena, metodin argumenttiin mahdollisesti aiheuttamat muutokset vaikuttavat myös alkuperäiseen viittaukseen. Jos tarkoitus on käyttää parametrin oletusarvoa, tulisi käyttää arvoa Nothing.

Voit yhdistää vähintään kaksi merkkijonoa käyttämällä &-operaattoria:

' 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

Edellä olevassa esimerkissä muuttujaan szName tallennettu tarjouksen otsikko on tulos seuraavien komentosarjojen yhdistämisestä:

• merkkijonoliteraali Proposal #
• muuttujaan szNumber tallennettu tarjousnumero
• toinen merkkijonoliteraali /
• asiakkaan nimi, joka on tallennettu szCustomer-muuttujaan

Tuloksena saatava tarjouksen otsikko voi siis olla esimerkiksi Proposal #5577 / ESTT.

Voit lisätä merkkijonoosi rivinvaihdon yhdistämällä VbCrLF-vakion merkkijonoilla:

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

Jos sinun on esimerkiksi tarkistettava ominaisuuden arvo VBScriptillä, käyttäjälle on näytettävä virheilmoitus, kun hän on antanut virheellisen arvon. Voit tuottaa virheen VBScriptissä käyttämällä Raise-metodia ja Err-objektia:

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

Metodi käyttää virhenumeroa ja kuvausta parametreina. M-Filesin komentosarjoissa käytetään MFScriptCancel-muuttujaa, koska se tallentaa M-Filesin virhenumeron.

If-lauseita käytetään lauseryhmän suorittamiseen, jos If-lause saa arvon tosi:

If Len( szValue ) < 10 Then

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

End If

if-lohkon on päätyttävä End If-lauseeseen. Kaikki If- ja End If-lauseiden välissä olevat lauseet suoritetaan, jos If- ja Then-lauseiden välissä oleva ehto saa arvon tosi. Voit käyttää And-operaattoria määritelläksesi useita ehtoja, joiden kaikkien arvon on oltava tosi if-lohkon suorittamiseksi. Or-operaattorilla voit määritellä useita operaattoreita, joista yhden on oltava tosi, jotta if-lohko suoritetaan. Voit käyttää ehdon määrittelyyn seuraavia vertailuoperaattoreita:

• == tarkistaa, onko kahden operandin arvo sama vai ei: jos on, ehto saa arvon tosi.
• <> tarkistaa, onko kahden operandin arvo sama vai ei: jos ei ole, ehto saa arvon tosi.
• > tarkistaa, onko vasemmanpuoleisen operandin arvo suurempi kuin oikeanpuoleisen operandin: jos on, ehto saa arvon tosi.
• < tarkistaa, onko vasemmanpuoleisen operandin arvo pienempi kuin oikeanpuoleisen operandin: jos on, ehto saa arvon tosi.
• >= tarkistaa, onko vasemmanpuoleisen operandin arvo suurempi tai yhtä suuri kuin oikeanpuoleisen operandin: jos on, ehto saa arvon tosi.
• <= tarkistaa, onko vasemmanpuoleisen operandin arvo pienempi tai yhtä suuri kuin oikeanpuoleisen operandin: jos on, ehto saa arvon tosi.

Voit myös määrittää If-lauseen toiseen If-lauseeseen tai esimerkiksi Else-lauseeseen sisäkkäiseksi tai luoda komentosarjaan syvemmän haarautumislogiikan käyttämällä ElseIf-lausetta.

Voit käyttää alirutiinia määritelläksesi koodin osan käytettäväksi useita kertoja viittauksena koodissasi:

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

Voit myös määritellä funktion käyttämään useita kertoja koodin osaa, joka palauttaa jonkin arvon:

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

Voit kutsua alirutiinin tai funktion komentosarjastasi yksinkertaisesti viittaamalla siihen nimellä:

Closefile()
IsOdd( 5 )