Tenesta SFDocuments.Base

Tenesta Base inneheld ei rad metodar og eigenskapar for å forenkla administreringa og hanfsaminga av LibreOffice Base-dokument.

Denne tenesta er nært knytt til tenesta ;Document, som inneheld generiske metodar for handsaming av LibreOffice-dokument, inkludert Base-dokument. Difor utvidar tenesta Base Document-tenesta og inneheld fleire metodar som er spesifikke for Base-dokument, slik at brukarane kan:

note

Denne tenesta er tilgjengeleg frå LibreOffice 7.2 og høgare.


tip

Sjå tenesta Document for å læra meir om metodane og eigenskapane som kan brukast for å administrera LibreOffice-dokument.


Oppkall av tenester

I Basic

Tenesta Base kan kallast opp på ulike måtar. Kodesnutten nedanfor brukar metoden CreateBaseDocument i tenesta UI til å laga ei ny Base-fil.

Merk at i alle eksempla er objektet oDoc ein førekomst av tenesta Base.


    Dim ui As Object, oDoc As Object
    Set ui = CreateScriptService("UI")
    Set oDoc = ui.CreateBaseDocument("C:\Documents\MyFile.odb")
  

Base-tenesta kan også startast medan du opnar ei eksisterande basisfil som vist nedanfor:


    Set oDoc = ui.OpenBaseDocument("C:\Documents\MyFile.odb")
  

Viss eit Base-dokument er opna frå før, er det råd å starta tenesta Base direkte:


    Dim oDoc As Object
    Set oDoc = CreateScriptService("SFDocuments.Document", "MyFile.odb")
  
I Python

Eksempla ovanfor kan omsetjast til Python slik:


    from scriptforge import CreateScriptService
    ui = CreateScriptService("UI")
    doc = ui.CreateBaseDocument(r"C:\Documents\MyFile.odb")
  

    doc = ui.OpenBaseDocument(r"C:\Documents\MyFile.odb")
  

    doc = CreateScriptService("SFDocuments.Document", "MyFile.odb")
  
note

Bruk av delstrengen «SFDocuments.» i det førre eksempelet er valfritt.


Liste over metodar i tenesta Base

FormDocuments
Forms

GetDatabase
IsLoaded

OpenFormDocument


FormDocuments

Returnerer ei matrise med det fulle namnet (sti/namn) på alle skjemadokument i Base-dokumentet som ei null-basert matrise av strenger.

Syntaks:

svc.FormDocuments(): str[0..*]

Eksempel:

Kodesnutten nedanfor skriv ut namna på alle skjemadokumenta i det gjeldande Base-dokumentet.

I Basic

    Dim oDoc as Object, myForms as Object, formName as String
    Set oDoc = CreateScriptService("Document", ThisDataBaseDocument)
    Set myForms = oDoc.FormDocuments()
    For Each formName In myForms
        MsgBox formName
    Next formName
  
I Python

    bas = CreateScriptService("Basic")
    doc = CreateScriptService("Document", bas.ThisDataBaseDocument)
    myForms = oDoc.FormDocuments()
    for formName in myForms:
        bas.MsgBox(formName)
  
tip

For å læra meir om skjema-dokument, sjå hjelpesidene til tenesta Form.


Forms

Avhengig av kva parameterar som er gjevne, vil denne metoden returnere:

Syntaks:

svc.Forms(formdocument: str): str[0..*]

svc.Forms(formdocument: str, form: str = ''): svc

svc.Forms(formdocument: str, form: int): svc

Parametrar:

skjemadokument: Namnet på eit gyldig skjemadokument som ein streng som skil mellom store og små bokstavar.

skjema: Namnet eller indeksnummeret på skjemaet som er lagra i skjemadokumentet. Viss dette argument manglar, vil metoden returnere ei liste med namna på alle skjemaa som er tilgjengelege i skjemadokumentet.

note

Sjølv om det er mogleg å bruka indekstal til å referere til skjema, vert dette tilrådd brukt berre når det er eitt skjema i skjemadokumentet. Viss det er fleire skjema, bør du helst bruka skjemanamnet i staden.


Eksempel:

Den første linja i eksemplet nedanfor returnerer ei liste over alle skjemaa i skjemadokumentet "myFormDocument". Den anden linja returnerer eit eksemplar av tenesta «Form» som representerer skjemaet «myForm».

I Basic

    Dim formsList as Object : formsList = oDoc.Forms("myFormDocument")
    Dim oForm as Object : oForm = oDoc.Forms("myFormDocument", "myForm")
  
I Python

    formsList = doc.Forms("myFormDocument")
    form = doc.Forms("myFormDocument", "myForm")
  

GetDatabase

Returnerer ein førekomst av tenesta Database som tillet utføringa av SQL-kommandoar som er definerte og/eller lagra i det gjeldande Base-dokumentet.

Syntaks:

svc.GetDatabase(user: str = '', password: str = ''): svc

Parametrar:

brukar, passord: Valfrie påloggingsparameterar som strengar. Standardverdien for begge parametera er ein tom streng "".

Eksempel:

I Basic

    Dim myDoc As Object, myDatabase As Object, ui As Object
    Set ui = CreateScriptService("UI")
    Set myDoc = ui.OpenBaseDocument("C:\Documents\myDb.odb")
    ' Brukar og passord vert sett inn nedanfor om nødvendig
    Set myDatabase = myDoc.GetDatabase()
    '   … Køyr spørjingar, SQL-uttrykk, …
    myDatabase.CloseDatabase()
    myDoc.CloseDocument()
  
I Python

    ui = CreateScriptService("UI")
    myDoc = ui.OpenBaseDocument(r"C:\Documents\myDb.odb")
    myDatabase = myDoc.GetDatabase()
    '   … Køyr spørjingar, SQL-uttrykk, …
    myDatabase.CloseDatabase()
    myDoc.CloseDocument()
  

IsLoaded

Returner True (sann) viss det spesifiserte FormDocument er ope.

Syntaks:

svc.IsLoaded(formdocument: str): bool

Parametrar:

skjemadokument: Namnet på eit Skjemadokument som skal kontrollerast om det inneheld ein streng som skil mellom små og store bokstavar.

Eksempel:

I Basic

    If Not oDoc.IsLoaded("myFormDocument") Then
        oDoc.OpenFormDocument("myFormDocument")
    End If
  
I Python

    if not doc.IsLoaded("myFormDocument"):
        doc.OpenFormDocument("myFormDocument")
  

OpenFormDocument

Opnar det spesifiserte FormDocument i anten normal- eller i utformings-modus.

Viss skjemadokumentet alt er opna, vert det aktivert utan å endra modus. Metoden returnerer Sann viss skjemadokumentet kan opnast.

Syntaks:

svc.OpenFormDocument(formdocument: str, designmode: bool = False): bool

Parametrar:

skjemadokument: Namnet på eit Skjemadokument skal opnast som ein streng som skil mellom små og store bokstavar.

utformingsmodus: Viss dette argument er Sann vert FormDocument opna i utformingsmodus-

Eksempel:

I Basic

Dei fleste skjemadokumenta er lagra i rota til Base-dokumentet og kan opanast ved å bruka namnet, som i eksempelet nedanfor:


    oDoc.OpenFormDocument("FormDokumentetMitt")
  

Viss skjemadokumenta er organiserte i mapper, er det nødvendig å ta med mappenamnet for å spesifisera kva skjemadokument som skal opnast. Dette er vist i det neste eksempelet:


    oDoc.OpenFormDocument("miMappe/FormDokumentetMitt")
  
I Python

    doc.OpenFormDocument("myFormDocument")
  

    doc.OpenFormDocument("myFolder/myFormDocument")
  
warning

Alle Basic-rutinane og -identifikatorane i ScriptForge som vert innleidde med understrek «_» er reserverte for internt bruk. Dei er ikkje tenkt brukte i Basic-makroar.


Støtt oss!