LibreOffice 25.2 Hjælp
Tjenesten UI (User Interface = brugerflade) forenkler identifikationen og håndteringen af de forskellige vinduer, der udgør hele LibreOffice-programet.
Windows selection (vinduesudvælgelse)
Flytning og størrelsesændring af vinduer
Statuslinjens indstillinger
Visning af en flydende fremdriftslinje
Oprettelse af nye vinduer
Adgang til de underliggende "dokumenter"
Tjenesten UI er startpunktet til åbning af, oprettelse af og tilgang til indholdet i nye eller eksisterende dokumenter fra et bruger-script.
Et vindue kan udpeges på forskellige måder:
en fuld sti og filnavn
den sidste komponent i det fulde filnavn eller endda kun den sidste komponent uden dens suffiks
vinduets titel
ved nye dokumenter, noget som ligner "Unavngivet 1"
et af specialvinduerne "BASICIDE" (Basic IDE) og "WELCOMESCREEN" (velkomstskærm)
Vinduets navn bruger både Store og små bogstaver.
Metoderne CreateDocument (Opret_dokument), CreateBaseDocument (Opret_basedokument), GetDocument (Hent_dokument), OpenBaseDocument (Åbn_basedokument) og OpenDocument (Åbn_dokument), beskrevet nedenfor, genererere dokumentobjekter. Når et vindue indeholder et dokument, repræsenterer en forekomst af klassen Document dette dokument. Et modeksempel: Basic IDEen er ikke et dokument men et vindue i vor terminologi. Derudover har et dokument en type: Calc, Impress, Writer, ...
De specifikke egenskaber og metoder, der kan anvendes på dokumenter er implementeret i en dokument-klasse.
Implementeringen af objektklassen document udføres i det tilknyttede bibliotek SFDocuments. Se dets tjeneste "Document" (dokument).
Før brug af tjenesten UI skal biblioteket ScriptForge være indlæst eller importeret:
    Dim ui As Variant
    GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")
    Set ui = CreateScriptService("UI")
  
    from scriptforge import CreateScriptService
    ui = CreateScriptService("UI")
  | Navn | Skrivebeskyttet | Type | Beskrivelse | 
|---|---|---|---|
| ActiveWindow | Ja | String | et gyldigt og unikt WindowName (vinduesnavn) til det aktuelt aktive vindue. Når vinduet ikke kan identificeres, returneres en nul-længde streng. | 
| Height | Ja | Integer | Returns the height of the active window in pixels. | 
| Width | Ja | Integer | Returns the width of the active window in pixels. | 
| X | Ja | Integer | Returns the X coordinate of the active window, which is the distance to the left edge of the screen in pixels. | 
| Y | Ja | Integer | Returns the Y coordinate of the active window, which is the distance to the top edge of the screen in pixels. This value does not consider window decorations added by your operating system, so even when the window is maximized this value may not be zero. | 
| Navn | Værdi | Beskrivelse | 
|---|---|---|
| MACROEXECALWAYS | 2 | Makroer udføres altid | 
| MACROEXECNEVER | 1 | Makroer udføres aldrig | 
| MACROEXECNORMAL | 0 | Makro-udførelse afhænger af brugerindstillinger | 
Eksemplet herunder viser et MsgBox (Beskedfelt) med navnene på alle aktuelt åbne dokumenter.
     Dim openDocs As Object, strDocs As String
     Set openDocs = ui.Documents()
     strDocs = openDocs(0)
     For i = 1 To UBound(openDocs)
         strDocs = strDocs & Chr(10) & openDocs(i)
     Next i
     MsgBox strDocs
   
     ui = CreateScriptService("UI")
     bas = CreateScriptService("Basic")
     openDocs = ui.Documents()
     strDocs = "\n".join(openDocs)
     bas.MsgBox(strDocs)
   | Liste over metoder i tjenesten UI (brugerflade) | ||
|---|---|---|
| 
           Activate | ||
Bemærk undtagelsesvis, at metoder, der er mærket med (*), ikke kan anvendes i Base-dokumenter.
Gør det bestemte vindue aktivt. Metoden returnerer True (sand), hvis det givne vindue bliver fundet og kan aktiveres. Der er ikke nogen ændring i den aktuelle brugerflade, vis intet vindue matcher udvælgelsen.
svc.Activate(windowname: str): bool
vinduesnavn: se definitionerne ovenfor.
      ui.Activate("C:\Documents\My file.odt")
    
      ui.Activate(r"C:\Documents\My file.odt")
    Opretter og gemmer et nyt LibreOffice Base-dokument, der indlejrer en tom datafbase af den givne type. Metoder returnerer en forekomst af tjenesten Document.
svc.CreateBaseDocument(filename: str, embeddeddatabase: str = 'HSQLDB', registrationname: str = '', opt calcfilename: str): svc
filename : Identifies the file to create. It must follow the SF_FileSystem.FileNaming notation. If the file already exists, it is overwritten without warning.
Indlejret_database: Enten "HSQLDB" (standard), "FIREBIRD" eller "CALC".
registreringsnavn: Navnett, der bruges til at gemme den nye database i databasens register. Ved = "" (standard), sker der ingen registrering. Hvis navnet allerede eksisterer, overskrives det uden advarsel.
calc-filnavn : Kun når embeddeddatabase (indlejret_database) = "CALC", repræsenterer calcfilename filen , der indeholder tabellerne, som Calc-regneark. Filen skal findes, eller sættes der et fejlflag.
      Dim myBase As Object, myCalcBase As Object
      Set myBase = ui.CreateBaseDocument("C:\Databases\MyBaseFile.odb", "FIREBIRD")
      Set myCalcBase = ui.CreateBaseDocument("C:\Databases\MyCalcBaseFile.odb", _
          "CALC", , "C:\Databases\MyCalcFile.ods")
   
     myBase = ui.CreateBaseDocument(r"C:\Databases\MyBaseFile.odb", "FIREBIRD")
     myCalcBase = ui.CreateBaseDocument(r"C:\Databases\MyCalcBaseFile.odb", \
         "CALC", calcfilename = r"C:\Databases\MyCalcFile.ods")
   Create a new LibreOffice document of a given type or based on a given template. The method returns an instance of the document class or one of its subclasses (Calc, Writer).
svc.CreateDocument(documenttype: str = '', templatefile: str = '', hidden: bool = False): svc
dokumenttype : "Calc", "Writer", osv. Hvis den mangler, skal argumentet templatefile (skabelonfil) være tilstede.
skabelonfil: Det fulde FileName (filnavn) på den skabelon, det nye dokument skal bygges på. Hvis filen ikke eksisterer, ignoreres argumentet. Tjenesten FileSystem (filsystem) service sørger for egenskaberne TemplatesFolder (Skabelonmappe) og UserTemplatesFolder (Bruger_skabelonmappe), der hjælper med at bygge argumentet.
skjult: hvis True (sand), åbner du det nye dokument i baggrunden (standard = False (falsk)). Skal bruges med forsigtighed: aktivering eller lukning senere hen kan kun ske fra programmet.
I begge ekseempler herunder opretter det første kald af metoden CreateDocument wet tomt Calc-dokument, mens det andet opretter et dokument fra en skabelonfil.
      Dim myDoc1 As Object, myDoc2 As Object, FSO As Object
      Set myDoc1 = ui.CreateDocument("Calc")
      Set FSO = CreateScriptService("FileSystem")
      Set myDoc2 = ui.CreateDocument(, FSO.BuildPath(FSO.TemplatesFolder, "personal/CV.ott"))
   
     myDoc1 = ui.CreateDocument("Calc")
     fs = CreateScriptService("FileSystem")
     myDoc2 = ui.CreateDocument(templatefile = fs.BuildPath(fs.TemplatesFolder, "personal/CV.ott"))
   The list of the currently open documents. Special windows are ignored. This list consists of a zero-based one dimensional array either of filenames - using ScriptForge.FileSystem.FileNaming notation - or of window titles for unsaved documents.
svc.Documents(): str[1..*]
In both examples below, the method may return an empty array if there are no documents open.
      Dim docList As Variant
      docList = ui.Documents
   
     docList = ui.Documents()
   Returns an instance of the Document class or one of its subclasses (Calc, Writer, Base, FormDocument) referring to either a given window or the active document.
svc.GetDocument(windowname: str = ''): svc
svc.GetDocument(windowname: uno): svc
windowname (vinduenavn): Se definitionerne ovenfor. Hvis dette argument mangler, bruges det aktive vindue. UNO-objekter af typerne com.sun.star.lang.XComponent eller com.sun.star.comp.dba.ODatabaseDocument accepteres også. På denne måde opretter videregivelse af ThisComponent (denne_komponent) eller ThisDatabaseDocument (dette_database-dokument) som argument et nyt SFDocuments.Document (SF-dokumenter.dokument), en ny Base (database) eller en ny Calc service (Calc-tjeneste).
      Dim myDoc As Object
      Set myDoc = ui.GetDocument("C:\Documents\My file.odt")
      Set myBase = ui.GetDocument(ThisDatabaseDocument)
   
     from scriptforge import CreateScriptService
     bas = CreateScriptService("Basic")
     myDoc = ui.GetDocument(r"C:\Documents\My file.odt")
     myDoc = ui.GetDocument(bas.ThisComponent)
   For at tilgå navnet på det aktuelt aktive vindue, henviser du til egenskaben ActiveWindow.
Maksimerer det aktive vindue eller det givne vindue.
svc.Maximize(windowname: str)
vinduesnavn: se definitionerne ovenfor. Hvis dette argument mangler, maksimeres det aktive vindue.
      ui.Maximize("Untitled 1")
   
     ui.Maximize("Untitled 1")
   Minimerer det aktive vindue eller det givne vindue.
svc.Minimize(windowname: str)
vinduesnavn: se definitionerne ovenfor. Hvis dette argument mangler, minimeres det aktive vindue.
     ui.Minimize()
   
     ui.Minimize()
   Open an existing LibreOffice Base document. The method returns a Base object.
svc.OpenBaseDocument(filename: str = '', registrationname: str = '', macroexecution: int = 0): svc
filnavn: Identificerer filen, der skal åbnes. Det skal følge notationen SF_FileSystem.FileNaming.
registreringsnavn: Navnet, der bruges til at finde databasen i databaseregistret. Det ignoreres, hvis FileName <> "".
macroexecution: 0 = behaviour is defined by the user configuration, 1 = macros are not executable, 2 = macros are executable. Default is 0.
      Dim myBase As Object
      Set myBase = ui.OpenBaseDocument("C:\Documents\myDB.odb", MacroExecution := ui.MACROEXECALWAYS)
   
     myBase = ui.OpenBaseDocument(r"C:\Documents\myDB.odb", macroexecution = ui.MACROEXECALWAYS)
   To improve code readability you can use predefined constants for the macroexecution argument, as in the examples above.
Opens an existing LibreOffice document with the given options. Returns a document object or one of its subclasses. The method returns Nothing (in BASIC) or None (in Python) if the opening failed, even when the failure is caused by a user decision.
svc.Opendocument(filename: str, password: str = '', readonly: bool = False, hidden: bool = False, macroexecution: int = 0, filtername: str = '', filteroptions: str = ''): svc
filnavn: Identificerer filen, der skal åbnes. Det skal følge FileNaming-notation i tjenesten FileSystem .
adgangskode: Til brug, når dokumentet er beskyttet. Hvis den er forkert eller mangler, når dokumentet er beskyttet, bliver brugeren bedt om at indtaste en adgangskode.
skrivebeskyttet: Standard = False (falsk).
skjult: hvis True (sand), åbner du dokumentet i baggrunden (standard = False (falsk)). Bør bruges med forsigtighed: aktivering eller lukning kan kun ske fra programmet.
macroexecution: 0 = behaviour is defined by the user configuration, 1 = macros are not executable, 2 = macros are executable. Default is 0.
filternavn: Navnet på et filter, der skal bruges til at indlæse dokumentet. Hvis det findes, skal filtret findes.
filter-indstillinger: En valgfri indstillings-streng, der er associeret med filteret.
      Dim myDoc As Object, FSO As Object
      Set myDoc = ui.OpenDocument("C:\Documents\myFile.odt", ReadOnly := True)
   
     myDoc = ui.OpenDocument(r"C:\Documents\myFile.odt", readonly = True)
   Ændrer størrelse på og/eller flytter det aktive vindue. Manglende og negative argumenter ignoreres. Hvis vinduet er minimeret eller maksimeret, gendanner kald af Resize (Justér størrelse) uden argumenter det.
svc.Resize(left: int = -1, top: int = -1, width: int = -1, height: int = -1)
venstre, øverst: Afstande fra det øverste-venstre hjørne fra den øverste og den venstre kan af skærmen i pixler.
bredde, højde: Vinduets nye dimensioner i pixler.
I de følgende de følgende eksempler ændres vinduets width (bredde) og height (højde), mens top (øverst) og left (venstre) efterlades uændrede.
      ui.Resize(Width := 500, Height := 500)
   
     ui.Resize(width = 500, height = 500)
   For at ændre størrelse på et vindue, der ikke er aktivt, aktiverer du det først med metoden Activate (Aktiver).
Kører en UNO-kommando i det aktuelle vindue. Nogle få typiske kommandoer er: Gem, Gem som, Eksportér til PDF, Fortryd, Kopiér, Indsæt, og så videre.
Kommandoer kan køres med eller uden argumenter. Argumenter valideres ikke, før kommandoen køres. Hvis kommandoen eller dens argumenter er ugyldige, sker der intet.
Se en komplet liste over UNO-kommandoer, der kan køres i LibreOffice på Wikisiden Udvikling/Forsendelseskommandoer.
svc.RunCommand(command: str, [args: any])
kommando: Streng med Stort-og-småt, der indeholder UNO-kommandoens navn. Medtagelse af forstavelsen ".uno:" i kommandoen er valgfri. Selve kommandoen tjekkes ikke for korrekthed. Hvis der ikke sker noget efter kommandokaldet, er kommandoen er sandsynligvis forkert.
args: For hvert argument, der skal videregives til kommandoen, angiver du et par, der indeholder argumentets navn og værdi.
Det følgende eksempel kører kommandoen .uno:About i det aktuelle vindue.
    Set ui = CreateScriptService("UI")
    ui.RunCommand("About")
  Herunder er der et eksempel, der kører UNO-kommandoen .uno:BasicIDEAppear og videregiver de argumenter, der er nødvendige for at åbne Basic IDEet på en angiven linje i modulet.
    ' Argumenter videregivet til kommandoen:
    ' Document  = "LibreOffice Macros & Dialogs"
    ' LibName = "ScriptForge"
    ' Name = "SF_Session"
    ' Line = 600
    ui.RunCommand(".uno:BasicIDEAppear", "Document", "LibreOffice Macros & Dialogs", _ 
                  "LibName", "ScriptForge", "Name", "SF_Session", "Line", 600)
  Bemærk, at kald af kommandoen BasicIDEAppear uden argumenter kun åbner .
    ui = CreateScriptService("UI")
    ui.RunCommand("About")
  
    ui.RunCommand(".uno:BasicIDEAppear", "Document", "LibreOffice Macros & Dialogs", \
                  "LibName", "ScriptForge", "Name", "SF_Session", "Line", 600)
  I Python er det også muligt at kaæde RunCommand (kør_kommando) med nøgleordsargumenter:
    ui.RunCommand(".uno:BasicIDEAppear", Document = "LibreOffice Macros & Dialogs", \
                  LibName = "ScriptForge", Name = "SF_Session", Line = 600)
  Hver LibreOffice-komponent har sit eget sæt af tilgængelige kommandoer. En nem måde at lære kommandoer på er at gå til Funktioner - Tilpas - Tastatur. Når du placerer musen over en funktion på listen Funktion, vises et værtøjstip med den tilsvarende UNO-kommando.
Vis en tekst og en fremdriftslinje i det aktive vindues statuslinje. Ethvert efterfølgende kald i den samme makrokørsel refererer til den samme statuslinje i det samme vindue, også selv om vinduet ikke mere er synligt. Et kald uden argumenter nulstiller statuslinjen til dens normale tilstand.
svc.SetStatusbar(text: str = '', percentage: int = -1)
tekst: En valgfri tekst, der skal vises foran statuslinjen.
procentdel: en valgfri fremskrifts-procentdel mellem 0 og 100.
      Dim i As Integer
      For i = 0 To 100
          ui.SetStatusbar("Progress ...", i)
          Wait 50
      Next i
      ' Nulstiller statuslinjen
      ui.SetStatusbar
   
     from time import sleep
     for i in range(101):
         ui.SetStatusbar("Test:", i)
         sleep(0.05)
     ui.SetStatusbar()
   Viser et ikke-modalt dialogfelt. Angiver dets titel, en forklarende tekst og en fremskridts-procentdel, der skal præsentereres på en statuslinje. Dialogen forbliver synlig, indtil et kald af metoden uden argumenter eller indtil brugeren manuelt lukker dialogen.
svc.ShowProgressBar(title: str = '', text: str = '', percentage: int = -1)
titel: Titlen, der visves øverst i dialogfeltet. Standard = "ScriptForge".
tekst: En valgfri tekst, der skal vises over statuslinjen.
peocentdel: en valgfri grad af fremskrift mellem 0 og 100.
      Dim i As Integer
      For i = 0 To 100
          ui.ShowProgressBar("Window Title", "Progress ..." & i & "/100", i)
          Wait 50
      Next i
      ' Lukker vinduet Statuslinje
      ui.ShowProgressBar
   
     from time import sleep
     for i in range(101):
         ui.ShowProgressBar("Window Title", "Progress ... " + str(i) + "/100", i)
         sleep(0.05)
     # Lukker vinduet Statuslinje
     ui.ShowProgressBar()
   Returnerer True (sand), hvis det givne vindue kunne identificeres.
svc.WindowExists(windowname: str): bool
vinduesnavn: se definitionerne herover.
      If ui.WindowExists("C:\Document\My file.odt") Then
          ' ...
   
     if ui.WindowExists(r"C:\Document\My file.odt"):
         # ...