ScriptForge-biblioteket
ScriptForge-biblioteker bygger opp en utvidbar samling av makroskriptressurser for Collabora Office som kan startes fra grunnleggende makroer eller Python-skript.
• Basic macros require to load ScriptForge library using the following statement:
GlobalScope.BasicLibraries.loadLibrary("ScriptForge")
• Python scripts require an import from scriptforge module:
from scriptforge import CreateScriptService
Aktiverer ScriptForge-tjenester
De beskrevne modulene og klassene kalles fra brukerskript som "Tjenester". En generisk konstruktør av disse tjenestene er designet for dette formålet for hvert språk:
GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")
Set oSvc = CreateScriptService("servicename"[, arg0, arg1, ...])
' ...
oSvc.Dispose()
from scriptforge import CreateScriptService
svc = CreateScriptService('servicename'[, arg0, arg1, ...])
# ...
svc.Dispose()
Metoden Kasser er tilgjengelig i alle tjenester og bør anropes for å frigjøre ressurser etter bruk.
Tjenester levert av ScriptForge-biblioteket
Gir en samling metoder for å manipulere og transformere matriser med én dimensjon (vektorer) og matriser med to dimensjoner (matriser). Dette inkluderer settoperasjoner, sortering, import til og eksport fra tekstfiler.
Matriser med mer enn to dimensjoner kan ikke brukes med metodene i denne tjenesten, det eneste unntaket er CountDims-metoden som godtar matriser med et hvilket som helst antall dimensjoner.
Tjenesten Base gir en rekke metoder og egenskaper for å forenkle administrasjon og håndtering av Collabora Office Base-dokumenter.
Denne tjenesten er nært knyttet til Dokument-tjenesten, som gir generiske metoder for håndtering av Collabora Office-dokumenter, inkludert basisdokumenter. Derfor utvider Base-tjenesten Dokument-tjenesten og gir ytterligere metoder som er spesifikke for basisdokumenter, slik at brukere kan:
-
Få tilgang til databasen i et basisdokument.
-
Åpne skjemadokumenter som er lagret i et basisdokument.
-
Sjekk om et skjemadokument fra et basisdokument er lastet inn.
Tjenesten ScriptForge.Basic foreslår en samling av Collabora Office Basic-metoder som skal utføres i en Python-kontekst. Grunnleggende tjenestemetoder gjengir den nøyaktige syntaksen og oppførselen til grunnleggende innebygde funksjoner.
Det delte biblioteket SFDocuments gir en rekke metoder og egenskaper for å forenkle administrasjon og håndtering av Collabora Office-dokumenter.
Tjenesten SFDocuments.Calc er en underklasse av SFDocuments.Document tjeneste. Alle metoder og egenskaper definert for Dokument-tjenesten kan også nås ved å bruke en Calc-tjenesteforekomst.
Tjenesten Calc er fokusert på:
-
Håndtering av ark i et Calc-dokument (kopiere, sette inn, flytte osv.)
-
Utveksling av data mellom grunnleggende datastrukturer og Calc-områder
-
Kopiering og import av enorme mengder data
Tjenesten Chart gir et sett med egenskaper og metoder for å håndtere diagrammer i Calc-dokumenter. Med denne tjenesten er det mulig å:
-
Få tilgang til kartobjekter i Calc-dokumenter og manipuler egenskapene deres.
-
Opprett og sett inn nye diagrammer i et Calc-dokument.
-
Eksporter diagrammer som bildefiler.
Tjenesten Database gir tilgang til databaser enten innebygd eller beskrevet i basisdokumenter. Denne tjenesten tilbyr metoder for å:
-
Få tilgang til data i databasetabeller.
-
Kjør SELECT-spørringer og utfør aggregerte funksjoner.
-
Kjør SQL-handlingssetninger som INSERT, UPDATE, DELETE osv.
The Dialog service contributes to the management of dialogs created with the Basic Dialog Editor. Each instance of the current class represents a single dialog box displayed to the user.
The DialogControl service manages the controls belonging to a dialog defined with the Basic Dialog Editor. Each instance of the current service represents a single control within a dialog box.
Fokuset er satt på å få og stille inn verdiene som vises av kontrollene i dialogboksen. Formatering er tilgjengelig via egenskapene XControlModel og XControlView.
Merk at innholdet i den unike DialogControl.Value egenskapen varierer i henhold til kontrolltypen.
En spesiell oppmerksomhet er gitt til kontroller av typen trekontroll. Det er lett å befolke et tre, enten gren for gren, eller med et sett med grener på en gang. Fylling av en trekontroll kan utføres statisk eller dynamisk.
En ordbok er en samling av nøkkelelementpar
The SFDocuments library provides methods and properties to facilitate the management and manipulation of LibreOffice documents.
Metoder som kan brukes for alle typer dokumenter (tekstdokumenter, ark, presentasjoner osv.) leveres av SFDocuments.Document-tjenesten. Noen eksempler er:
Tjenesten Unntak er en samling metoder for å hjelpe til med kodefeilsøking i Basic- og Python-skript og i feilhåndtering i Basic-skript.
I Grunnleggende skript, når en kjøretidsfeil oppstår, hjelper metodene og egenskapene til Exception-tjenesten å identifisere feilkonteksten og tillate å håndtere den.
Tjenesten FileSystem inkluderer rutiner for å håndtere filer og mapper. Deretter følger noen eksempler på funksjonene som tilbys av denne tjenesten:
-
Kontroller om det finnes en fil eller mappe.
-
Opprett og slett mapper og filer.
-
Start dialogbokser for å åpne/lagre filer.
-
Få tilgang til listen over filer i en mappe osv.
Tjenesten Form gir metoder og egenskaper for å administrere skjemaer i Collabora Office-dokumenter. Denne tjenesten støtter skjemaer i Base-, Calc- og Writer-dokumenter og lar deg:
-
Åpne og aktiver skjemaer.
-
Naviger gjennom poster som vises i skjemaet.
-
Få tilgang til kontrollene inne i skjemaet.
-
Få tilgang til underskjemaer til et overordnet skjema.
Tjenesten FormControl gir tilgang til kontrollene som tilhører et skjema, et underskjema eller en tabellkontroll i et FormDocument. Hver forekomst av FormControl-tjenesten refererer til en enkelt kontroll i skjemaet. Denne tjenesten lar brukere:
-
Hent og angi egenskapene til kontrollen representert av 1FormControl2-forekomsten.
-
Få tilgang til gjeldende verdi som vises av kontrollen.
-
Sett fokus på ønsket kontroll.
Denne tjenesten gir en rekke metoder knyttet til oversettelse av strenger med minimal innvirkning på programmets kildekode. Metodene som tilbys av L10N-tjenesten kan hovedsakelig brukes til å:
Tjenesten Plattform gir en samling egenskaper om gjeldende utførelsesmiljø og kontekst, for eksempel:
-
Maskinvareplattformen (arkitektur, CPU-antall, maskintype osv.)
-
Operativsysteminformasjon (OS-type, utgivelse, versjon osv.)
-
The Collabora Office versjon
-
Det gjeldende brukernavnet
Tjenesten PopupMenu kan brukes til å lage popup-menyer som kan assosieres med hendelser eller utføres av skript. Denne tjenesten gir følgende funksjoner:
-
Oppretting av popup-menyer med egendefinerte oppføringer, avmerkingsbokser og radioknapper.
-
Dekorasjon av menyelementer med ikoner og verktøytips.
Hovedformålet med modulen Tjenester er å gi tilgang til metoden CreateScriptService, som kan kalles inn brukerskript for å instansiere tjenester som er implementert ved hjelp av ScriptForge-rammeverket.
Tjenesten Økt samler ulike generelle metoder for:
Tjenesten String gir en samling metoder for strengbehandling. Disse metodene kan brukes til å:
-
Validere innholdet i strenger
-
Formater strenger ved å trimme, rettferdiggjøre eller pakke inn innholdet
-
Bruk regulære uttrykk for å søke og erstatte delstrenger
-
Bruk hash-algoritmer på strenger, etc.
Tjenesten TextStream brukes til å lese sekvensielt fra og skrive til filer som er åpnet eller opprettet med ScriptForge.FileSystem-tjenesten.
Metodene OpenTextFile og CreateTextFile fra FileSystem-tjenesten returnerer en forekomst av TextStream-tjenesten.
Tjenesten Timer måler hvor lang tid det tar å kjøre brukerskript.
En Timer måler varigheter. Som kan være:
-
Startet, for å indikere når du skal begynne å måle tid.
-
Suspendert, for å pause måling av kjøretid.
-
Gjenopptatt, for å fortsette å spore kjøretid etter at timeren er suspendert.
-
Startet på nytt, noe som vil avbryte tidligere målinger og starte Timeren på null.
UI (User Interface)-tjenesten forenkler identifiseringen og manipuleringen av de forskjellige vinduene som utgjør hele Collabora Office-applikasjonen:
-
Vindus-valg
-
Flytting og endring av størrelse for vinduer
-
Statuslinjeinnstillinger
-
Visning av en flytende fremdriftslinje
-
Oppretting av nye vinduer
-
Tilgang til de underliggende "dokumentene"
Merk: Andre ScriptForge ikke beskrevne moduler er reservert for intern bruk. Innholdet deres kan endres uten varsel.
Alle ScriptForge Grunnleggende rutiner eller identifikatorer som er prefikset med et understrekingstegn "_" er reservert for intern bruk. De er ikke ment å brukes i grunnleggende makroer eller Python-skript.
