Tenesta ScriptForge.Dictionary

Ei ordliste er ei samling av n√łkkelelementpar

N√łklar og element kan hentast, teljast, oppdaterast og mykje meir.

Tipsikon

Dictionary-tenesta liknar p√• det innebygde LibreOffice Basic Collection-objektet, men med fleire funksjonar. For eksempel har ikkje Collection-objekta henting av n√łklar. Dessutan har Dictionary tilleggsfunksjonar som √• byta ut n√łklar, teste om ein spesifikk n√łkkel finst fr√• f√łr og √• konvertera Dictionary til eit matrise-objekt eller ein JSON-streng.


Oppkall av tenester

I Basic

Eksempelet nedf√łre opprettar myDict som ei tom ordbok.


    GlobalScope.BasicLibraries.loadLibrary("ScriptForge")
    Dim myDict As Variant
    myDict = CreateScriptService("Dictionary")
  

Det vert tilrådd å frigje ressursar etter bruk:


     Set myDict = myDict.Dispose()
  
I Python

Eksemplet nedanfor lagar eit tomt eksemplar av tenesta Dictionary og brukar metoden Python native update for å fylla det med innhaldet i eit Python dict-objekt .


    dico = dict('A' = 1, 'B' = 2, 'C' = 3)
    # Initialiser myDict som eit tomt ordliste-objekt
    myDict = CreateScriptService('Dictionary')
    # Les dico-verdiane inn i myDict
    myDict.update(dico)
    myDict['D'] = 4
    print(myDict)   # {'A': 1, 'B': 2, 'C': 3, 'D': 4}
    propval = myDict.ConvertToPropertyValues()
  

Det er mogleg √• laga eit eksemplar av tenest Dictionary med Python-objektet dict som argument som vist i det f√łlgjande eksempelet.


    dico = dict('A' = 1, 'B' = 2, 'C' = 3)
    # Initialiser myDict med innhaldet frå dico
    myDict = CreateScriptService('Dictionary', dico)
    myDict['D'] = 4
    print(myDict) # {'A': 1, 'B': 2, 'C': 3, 'D': 4}
    propval = myDict.ConvertToPropertyValues()
  
note

Fordi Python har innebygd ordbokst√łtte, er dei fleste metodane i tenesta Dictionary berre tilgjengeleg for Basic-skript. Unnatak er ConvertToPropertyValues og ImportFromPropertyValues som vert st√łtta i b√•de Basic og Python.


Eigenskapar

Namn

Skriveverna

Type

Beskriving

Count

Ja

Long

Talet p√• oppf√łringar i ordboka

Items

Ja

Matrise med variantar

Lista over elementa som ei eindimensjonal matrise

Keys

Ja

Matrise av strengar

Lista over n√łklar som ei eindimensjonal matrise


Tipsikon

Eigenskapane Keys og Items returnerer deira respektive indhald i ei identisk rekkjef√łlgje. Rekkef√łlgja er ikkje relatert til rekkjef√łlgja sett ved opprettinga.


Eksempel:

Det neste eksempelet brukar eigenskapen Keys for g√• gjennom alle n√łklane i myDict fleire gonger.


    Dim a As Variant, b As String
    a = myDict.Keys
    For Each b In a
        MsgBox(myDict.Item(b))
    Next b
    

Metodar

Add
ConvertToArray
ConvertToJson
ConvertToPropertyValues

Exists
ImportFromJson
ImportFromPropertyValues
Item

Remove
RemoveAll
ReplaceItem
ReplaceKey


Add

Legg eit nytt n√łkkelelementpar til ordboka. Returnerer Sann viss det lukkast.

Syntaks:

dict.Add(key: str, item: any): bool

Parametrar:

n√łkkel: Strengverdi som vert brukt for √• identifisera elementet. N√łkkelen skil ikkje mellom store og sm√• bokstavar.

element: Kva verdi som helst, også ei matrise, eit Basic-objekt, eit UNO-objekt, ei ordbok og så vidare.

Eksempel:


      Dim NewValue As Variant
      myDict.Add("NewKey", NewValue)
    
warning

Kvar n√łkkel m√• vera unik i den same ordlista. Viss n√łkkelen finst fr√• f√łr i ordlista, vert det sett opp ein DUPLICATEKEYERROR. N√łklar som er laga av mellomromsteikn, vil setja opp feilen INVALIDKEYERROR.


ConvertToArray

Lagrar innhaldet i ordboka i ei to-kolonnars, null-basert matrise. N√łklane er lagra i den f√łrste kolonnen og elementa i den andre kolonnen.

Viss ordboka er tom, vil denne metoden returnere ei tom matrise.

Syntaks:

dict.ConvertToArray(): any[0..*, 0..1]

Eksempel:


      Dim myDict as Variant
      myDict = CreateScriptService("Dictionary")
      myDict.Add("a", 1)
      myDict.Add("b", 2)
      myDict.Add("c", 3)
      Dim arr as Variant
      arr = myDict.ConvertToArray()
      '(("a", 1), ("b", 2), ("c", 3))
    

ConvertToJson

Konverterer innhaldet i ordboka til tekst i JSON (JavaScript Object Notation).

Avgrensingar

Denne metoden har st√łtte for desse datatypane: String, Boolean, numbers, Null og Empty. Matriser som inneheld element av desse er ogs√• tillatne, kva dimensjon dei m√•tte ha. Datoar vert konverterte til strengar som vert brukte i matrisene. Andre datatypar vert konverterte til det dei er representert med i strengen ved hjelp av tenesta SF_String.Represent.

Syntaks:

dict.ConvertToJson(indent: str = ""): str

Parametrar:

Innrykk: Når Indent er eit positivt tal eller ein tekst, vert JSON-matriseelement og objektelement skrivne ut med dette innrykket. Ein negativ verdi for Indent vil leggja til nye linjer utan innrykk. Standardverdien er ein tom streng "" som vel den mest kompakte representasjonen. Bruk av eit positivt heiltal for Indent vil setja inn så mange innrykk på nivået som talet seier. NårIndent er ein streng, for eksempel Chr(9 eller Tab(1), vert tabulator-teiknet brukt for innrykk på kvart nivå.

Eksempel:


      myDict.Add("p0", 12.5)
      myDict.Add("p1", "a string àé""ê")
      myDict.Add("p2", DateSerial(2020,9,28))
      myDict.Add("p3", True)
      myDict.Add("p4", Array(1,2,3))
      MsgBox myDict.ConvertToJson()    
      '{"p0": 12.5, "p1": "a string \u00e0\u00e9\"\u00ea", "p2": "2020-09-28", "p3": true, "p4": [1, 2, 3]}
    

ConvertToPropertyValues

Lagrar innhaldet i ordlista i ei matrise med PropertyValues.

Kvar oppf√łring er ein com.sun.star.beans.PropertyValue. N√łkkelen er lagra i Name, elementet i Value.

Viss eitt av elementa har ein type Data, vert denne konvertert til ein com.sun.star.util.DateTime-struktur. Viss eitt av elementa er ei tom matrise, vert det konvertert til Null. Sluttmatrisa er tom når ordboka er tom.

Syntaks:

dict.ConvertToPropertyValues(): obj[0..*]

Eksempel:

I Basic

    Dim myDict as Variant
    myDict = CreateScriptService("Dictionary")
    ' Legg nokre eigenskapar til i ordboka
    myDict.Add("Color", "Blue")
    myDict.Add("Width", 20)
    ' Konverterer til ei matrise av objekta PropertyValue
    Dim prop as Variant
    prop = myDict.ConvertToPropertyValues()
  
I Python

Merk i eksempelet nedanfor at ei Python-ordliste må sendast vidare som det andre argumentet i metoden CreateScriptService.


    myDict = dict()
    myDict["Color"] = "Blue"
    myDict["Width"] = 30
    sfDic = CreateScriptService("Dictionary", myDict)
    prop = sfDic.ConvertToPropertyValues()
  
tip

Many services and methods in the UNO library take in parameters represented using the PropertyValue struct, which is part of the LibreOffice API.


Exists

Bestemmer om det finst ein n√łkkel i ordboka.

Syntaks:

dict.Exists(key: str): bool

Parametrar:

n√łkkel: N√łkkelen som skal sl√•ast opp i ordboka.

Eksempel:


    Dim myDict as Variant
    myDict = CreateScriptService("Dictionary")
    ' Legg nokre eigenskapar til i ordboka
    myDict.Add("Color", "Blue")
    myDict.Add("Width", 20)
    '(...)
    If Not myDict.Exists("Size") Then
       MsgBox "You have to provide a Size value"
    End If
  

ImportFromJson

Legg til innhaldet av ein streng i JSON (JavaScript Object Notation) til i den gjeldande ordboka. Returnnerer Sann viss dette lukkast.

Avgrensingar

JSON-strengen kan innehalda tal, tekst, boolske verdiar, nullverdiar og matriser som inneheld desse typane. Han kan ikkje innehald JSON-objekt, altså underordlister.

Det vert gjort eit fors√łk p√• √• omforma tekst til dato viss elementet passa med eitt av desse m√łnstera: √Ö√Ö√Ö√Ö-MM-DD, TT:MM:SS eller √Ö√Ö√Ö√Ö-MM-DD TT:MM:SS.

Syntaks:

dict.ImportFromJson(inputstr: str, overwrite: bool = False): bool

Parametrar:

inputStr: Strengen som skal importerast.

overskriv: N√•r denne er Sann, kan det finnast oppf√łringar med det same namnet i ordlista. Verdiane vert i tilfelle overskrive. N√•r denne er Usann (standard), vil like verdiar setja opp ein feil. Hugs at ordboksn√łklane ikkje skil mellom store og sm√• bokstavar i JSON-strengar.

Eksempel:


    Dim s As String
    s = "{'firstName': 'John','lastName': 'Smith','isAlive': true,'age': 66, 'birth':  '1954-09-28 20:15:00'" _
        & ",'address': {'streetAddress': '21 2nd Street','city': 'New York','state': 'NY','postalCode': '10021-3100'}" _
        & ",'phoneNumbers': [{'type': 'home','number': '212 555-1234'},{'type': 'office','number': '646 555-4567'}]" _
        & ",'children': ['Q','M','G','T'],'spouse': null}"
    s = Replace(s, "'", """")
    myDict.ImportFromJson(s, OverWrite := True)
    ' (Under)-ordb√łkene ¬ęAddresse¬Ľ og ¬ęTelefonnummer¬Ľ (0) og (1) vert importerte som tomme strengar.
  

ImportFromPropertyValues

Set inn innhaldet fr√• ei matrise med PropertyValue-objekta i den gjeldande ordlista. Namna i PropertyValue vert brukte som n√łklar i ordlista, medan ¬ęVerdiar¬Ľ inneheld dei tilsvarande verdiane. Returnerer Sann viss vellukka.

Syntaks:

dict.ImportFromPropertyValues(propertyvalues: obj[0..*], overwrite: bool = False): bool

Parametrar:

propertyvalues: A zero-based 1-dimensional array containing com.sun.star.beans.PropertyValue objects. This parameter may also be a single PropertyValue object not contained in an Array.

overwrite: N√•r denne er Sann, kan det finnast oppf√łringar med det same namnet i ordlista. Verdiane vert i tilfelle overskrivne. N√•r denne er Usann (standard), vil like verdiar setja opp ein feil. Hugs at ordboksn√łklane ikkje skil mellom store og sm√• bokstavar, medan grupper av eigenskapsverdiar i Python gjer det.

Eksempel:

Eksempla nedanfor lagar f√łrst ei matrise med to PropertyValue-objekt og deretter konverterer ho til ei ordliste.

I Basic

    Dim vProp As New com.sun.star.beans.PropertyValue
    Dim arrProp : arrProp = Array()
    vProp.Name = "Color"
    vProp.Value = "Blue"
    arrProp = SF_Array.Append(arrProp, vProp)
    vProp.Name = "Date"
    vProp.Value = CDateToUnoDateTime(Now)
    arrProp = SF_Array.Append(arrProp, vProp)
    myDict = CreateScriptService("Dictionary")
    myDict.ImportFromPropertyValues(arrProp, Overwrite := True)
    Dim keys : keys = myDict.Keys
    For Each k In keys
        MsgBox k & " - " & myDict.Item(k)
    Next k
  
I Python

    from scriptforge import CreateScriptService
    from datetime import datetime
    import uno
    bas = CreateScriptService("Basic")
    arrProp = list()
    vProp = uno.createUnoStruct("com.sun.star.beans.PropertyValue")
    vProp.Name = "Color"
    vProp.Value = "Blue"
    arrProp.append(vProp)
    vProp = uno.createUnoStruct("com.sun.star.beans.PropertyValue")
    vProp.Name = "Date"
    vProp.Value = bas.CDateToUnoDateTime(datetime.now())
    arrProp.append(vProp)
    myDict = CreateScriptService("Dictionary")
    myDict.ImportFromPropertyValues(arrProp, overwrite=True)
    for k in myDict.keys():
        bas.MsgBox("{} - {}".format(k, myDict[k]))
  

Item

Hentar ei ordbokoppf√łring som finst fr√• f√łr basert p√• n√łkkelen. Returnerer verdien av elementet viss vellukka, elles vert Empty returnert.

Syntaks:

dict.Item(key: str): any

Parametrar:

key: Not case-sensitive. If it does not exist, Empty value is returned.

Eksempel:

Det neste eksempelet g√•r gjennom alle n√łklane i ordboka fleire gongar og brukar metoden Item til √• f√• tilgang til verdiane.


    Dim myDict as Variant, k as Variant, allKeys as Variant
    myDict = CreateScriptService("Dictionary")
    myDict.Add("key1", 100)
    myDict.Add("key2", 200)
    myDict.Add("key3", 300)
    allKeys = myDict.Keys
    For Each k in allKeys
       MsgBox(myDict.Item(k))
    Next k
  

Remove

Fjernar ei eksisterande ordboksoppf√łring basert p√• n√łkkelen. Returnerer Sann vis det lukkast.

Syntaks:

dict.Remove(key: str): bool

Parametrar:

key: Skil ikkje mellom små og store bokstavar. Må finnast i ordboka, elles vert det sett ein UNKNOWNKEYERROR.

Eksempel:


    myDict.Add("key1", 100)
    myDict.Add("key2", 200)
    myDict.Add("key3", 300)
    MsgBox(myDict.Count) ' 3
    myDict.Remove("key2")
    MsgBox(myDict.Count) ' 2
  

RemoveAll

Fjernar alle oppf√łringane i ordboka.. Returnerer Sann viss det lukkast.

Syntaks:

dict.RemoveAll(): bool

Eksempel:


    myDict.Add("key1", 100)
    myDict.Add("key2", 200)
    myDict.Add("key3", 300)
    MsgBox(myDict.Count) ' 3
    myDict.RemoveAll()
    MsgBox(myDict.Count) ' 0
  

ReplaceItem

Fjernar ein eksisterande elementverdi basert p√• n√łkkelen. Returnerer Sann vis det lukkast.

Syntaks:

dict.ReplaceItem(key: str, value: any): bool

Parametrar:

key: Strengverdi som representerer n√łkkelen som verdien skal erstattast med. Skil ikkje mellom store og sm√• bokstavar. Viss n√łkkelen ikkje finst i ordlista, vert det sett opp ein UNKNOWNKEYERROR-feil.

value: Den nye verdien for elementet det vert referert til med Key-parameteren.

Eksempel:


    myDict.Add("a", 1)
    MsgBox(myDict.Item("a")) ' 1
    myDict.ReplaceItem("a", 100)
    MsgBox(myDict.Item("a")) ' 100
  

ReplaceKey

Erstattar ein eksisterande n√łkkel i ordlista med ein ny n√łkkel. Elementverdien vert ikkje endra. Returnerer Sann viss det lukkast.

Syntaks:

dict.ReplaceKey(key: str, value: str): bool

Parametrar:

key: Strengverdi som representerer n√łkkelen som verdien skal erstattast med. Skil ikkje mellom store og sm√• bokstavar. Viss n√łkkelen ikkje finst i ordlista, oppst√•r det ein UNKNOWNKEYERROR-feil.

value: Strengverdi for den nye n√łkkelen. Skil ikkje mellom store og sm√• bokstavar. Viss n√łkkelen finst fr√• f√łr i ordlista, oppst√•r det ein DUPLICATEKEYERROR-feil.

Eksempel:


    myDict.Add("oldKey", 100)
    MsgBox(myDict.Item("oldKey")) ' 100
    myDict.ReplaceKey("oldKey", "newKey")
    MsgBox(myDict.Item("newKey")) ' 100
  
warning

Alle ScriptForge Basic-rutinane og -identifikatorane som vert innleidde med understrek ¬ę_¬Ľ er reserverte for internt bruk. Dei er ikkje meint brukte i Basic-makroar.


St√łtt oss!