ScriptForge.UI zerbitzua

UI zerbitzuak (erabiltzaile-interfazearenak) LibreOffice aplikazio osoa osatzen duten leiho anitzen identifikazioa eta manipulazioa sinplifikatzen du:

tip

UI zerbitzua dokumentu berriak edo lehendik daudenak erabiltzaile-script batetik irekitzeko, sortzeko edo atzitzeko abiapuntua da.


Definizioak

WindowName

Leiho bat adierazteko modu anitz daude:

Leiho-izenak maiuskulak/minuskulak bereizten ditu.

Document objektua

Behean deskribatutako CreateDocument, CreateBaseDocument, GetDocument eta OpenDocument metodoek dokumentu-objektuak sortzen dituzte. Leiho batek dokumentu bat duenean, Document klasearen instantzia batek dokumentu hori ordezkatzen du. Kontrako adibide gisa, Basic IDE bat ez da dokumentu bat gure terminologian, leiho bat baizik. Aurrekoaz gain, dokumentu batek mota bat du: Calc, Impress, Writer ...

Dokumentuetan aplikatu daitezkeen propietate eta metodo espezifikoak dokumentu-klase batean inplementatzen dira.

tip

Dokumentu-objektuen klasearen inplementazioa elkartutako SFDocuments liburutegian egiten da. Ikusi haren "Document" zerbitzua.


Zerbitzuari deitzea

Basic lengoaian

    Dim ui As Variant
    GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")
    Set ui = CreateScriptService("UI")
  
Python lengoaian

    from scriptforge import CreateScriptService
    svcUI = CreateScriptService("UI")
  

Propietateak

Izena

Irakurtzeko soilik

Mota

Deskribapena

ActiveWindow

Bai

String

WindowName baliozkoa eta bakarra uneko leiho aktiborako. Leihoa ezin bada identifikatu, zero luzerako kate bat itzuliko da.

Documents

Bai

String array

Unean irekitako dokumentuen zerrenda. Leiho bereziei ez ikusiarena egingo zaie. Zerrenda hori zeron oinarritutako dimentsio bakarreko matrize bat da, bai fitxategi-izenak dituena (SF_FileSystem.FileNaming notazioan) bai gorde gabeko dokumentuen leiho-izenburuak dituena.


Konstanteak

Izena

Balioa

Deskribapena

MACROEXECALWAYS

2

Makroak beti exekutatzen dira

MACROEXECNEVER

1

Makroak ez dira inoiz exekutatzen

MACROEXECNORMAL

0

Makroen exekuzioa erabiltzaile-ezarpenen araberakoa da


Adibidea:

Beheko adibideek unean irekitako dokumentu guztien izenak dituen MsgBox bat erakusten dute.

Basic lengoaian

      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
   
Python lengoaian

     svcUI = CreateScriptService("UI")
     sBasic = CreateScriptService("Basic")
     openDocs = svcUI.Documents()
     strDocs = "\n".join(openDocs)
     sBasic.MsgBox(strDocs)
   

UI zerbitzuaren metodoen zerrenda

Activate
CreateBaseDocument
CreateDocument (*)
GetDocument

Maximize
Minimize
OpenBaseDocument
OpenDocument (*)

Resize
SetStatusBar (*)
ShowProgressBar
WindowExists


warning

Kontuan izan, salbuespen gisa, (*) markatutako metodoak ezin zaizkiela Base dokumentuei aplikatu.


Activate

Bihurtu aktibo zehaztutako leihoa. Metodoak True itzuliko du emandako leihoa aurkitu bada eta aktibatu ahal izan bada. Ez da aldaketarik egongo uneko erabiltzaile-interfazean ez badago hautapenarekin bat datorren leihorik.

Sintaxia:

svc.Activate(windowname: str): bool

Parametroak:

windowname: Ikusi goiko definizioak.

Adibidea:

Basic lengoaian

      ui.Activate("C:\Documents\My file.odt")
    
Python lengoaian

      svcUI.Activate(r"C:\Documents\My file.odt")
    

CreateBaseDocument

Emandako motatako datu-base huts bat kapsulatuta duen LibreOffice Base dokumentu berria sortzen eta gordetzen du. Metodoak Document zerbitzuaren instantzia bat itzuliko du.

Sintaxia:

svc.CreateBaseDocument(filename: str, embeddeddatabase: str = 'HSQLDB', registrationname: str = ''): svc

Parametroak:

filename: Sortuko den fitxategia identifikatzen du. SF_FileSystem.FileNaming notazioa jarraitu behar du. Fitxategia lehendik badago, gainidatzi egingo du inolako abisurik gabe.

embeddeddatabase: "HSQLDB" (lehenetsia) edo "FIREBIRD".

registrationname: Datu-base berria datu-baseen erregistroa gordetzeko erabiliko den izena. Balioa = "" bada ez da erregistrorik egingo. Izena lehendik badago, gainidatzi egingo da abisurik gabe.

Adibidea:

Basic lengoaian

      Dim myBase As Object
      Set myBase = ui.CreateBaseDocument("C:\Databases\MyBaseFile.odb", "FIREBIRD")
   
Python lengoaian

     myBase = svcUI.CreateBaseDocument(r"C:\Databases\MyBaseFile.odb", "FIREBIRD")
   

CreateDocument (*)

Mota jakin bateko LibreOffice dokumentu berria sortzen du emandako txantiloi batean oinarrituta. Metodoak dokumentu-objektu bat itzuliko du.

Sintaxia:

svc.CreateDocument(documenttype: str = '', templatefile: str = '', hidden: bool = False): svc

Parametroak:

documenttype : "Calc", "Writer", etab. Argumentu hori falta bada, templatefile argumentuak egon behar du.

templatefile: Dokumentu berria eraikitzeko erabiliko den txantiloiaren FileName osoa. Fitxategia ez badago lehendik, argumentuari ez ikusiarena egingo zaio. FileSystem zerbitzuak TemplatesFolder eta UserTemplatesFolder propietateak ematen ditu argumentua eraikitzen laguntzeko.

hidden: True bada, ireki dokumentu berria atzeko planoan (lehenetsia = False). Erabili kontuz: geroago hura aktibatu edo itxi nahi bada, programazio bidez egin beharko da.

Adibidea:

Beheko bi adibideetan, CreateDocument metodoari egindako lehen deiak Calc dokumentu hutsa sortzen du, eta bigarrenak txantiloi-fitxategi batetik abiatuta sortzen du dokumentu bat.

Basic lengoaian

      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"))
   
Python lengoaian

     myDoc1 = svcUI.CreateDocument("Calc")
     FSO = CreateScriptService("FileSystem")
     myDoc2 = svcUI.CreateDocument(templatefile = FSO.BuildPath(FSO.TemplatesFolder, "personal/CV.ott"))
   

GetDocument

Leiho aktiboari edo emandako leihoari erreferentzia egiten dion dokumentu-objektu bat itzultzen du.

Sintaxia:

svc.GetDocument(windowname: str = ''): svc

Parametroak:

windowname: Ikusi definizioak goian. Argumentu hau falta bada, leiho aktiboa erabiliko da.

Adibidea:

Basic lengoaian

      Dim myDoc As Object
      Set myDoc = ui.GetDocument("C:\Documents\My file.odt")
   
Python lengoaian

     myDoc = svcUI.GetDocument(r"C:\Documents\My file.odt")
   
tip

Uneko leiho aktiboaren izena atzitzeko, erabili ActiveWindow propietatea.


Maximize

Leiho aktiboa edo emandako leihoa maximizatzen du.

Sintaxia:

svc.Maximize(windowname: str)

Parametroak:

windowname: Ikusi definizioak goian. Argumentu hau falta bada, leiho aktiboa maximizatuko da.

Adibidea:

Basic lengoaian

      ui.Maximize("Untitled 1")
   
Python lengoaian

     svcUI.Maximize("Untitled 1")
   

Minimize

Leiho aktiboa edo emandako leihoa ikonotzen du.

Sintaxia:

svc.Minimize(windowname: str)

Parametroak:

windowname: Ikusi definizioak goian. Argumentu hau falta bada, leiho aktiboa ikonotuko da.

Adibidea:

Basic lengoaian

     ui.Minimize()
   
Python lengoaian

     svcUI.Minimize()
   

OpenBaseDocument

Ireki lehendik dagoen LibreOffice Base dokumentu bat. Metodoak dokumentu-objektu bat itzuliko du.

Sintaxia:

svc.OpenBaseDocument(filename: str = '', registrationname: str = '', macroexecution: int = 0): svc

Parametroak:

filename: Irekiko den fitxategia identifikatzen du. SF_FileSystem.FileNaming notazioa jarraitu behar du. Fitxategia lehendik badago, gainidatzi egingo du abisurik gabe.

registrationname: Datu-basea datu-baseen erregistroan aurkitzeko erabiliko den izena. Ez ikusiarena egingo zaio FileName <> "" bada.

macroexecution: 0 = portaera erabiltzaile-konfigurazioak definituko du, 1 = makroak ez dira exekutagarriak, 2 = makroak exekutagarriak dira.

Adibidea:

Basic lengoaian

      Dim myBase As Object
      Set myBase = ui.OpenBaseDocument("C:\Documents\myDB.odb", MacroExecution := ui.MACROEXECALWAYS)
   
Python lengoaian

     svcUI.OpenBaseDocument(r"C:\Documents\myDB.odb", macroexecution = svcUI.MACROEXECALWAYS)
   
tip

Kodearen irakurgarritasuna hobetzeko, konstante aurredefinituak erabili daitezke macroexecution argumentuan, goiko adibideetan erakutsi den moduan.


OpenDocument (*)

LibreOffice dokumentu bat irekitzen du emandako aukerekin. Dokumentu-objektu bat edo haren azpiklaseetako bat itzultzen du. Metodoak Nothing (Basic lengoaian) / None (Python lengoaian) itzuliko du irekitzeak huts egin bada, baita hutsegitea erabiltzailearen erabaki batek eragin badu ere.

Sintaxia:

svc.Opendocument(filename: str, password: str = '', readonly: bool = False, hidden: bool = False, macroexecution: int = 0, filtername: str = '', filteroptions: str = ''): svc

Parametroak:

filename: Irekiko den fitxategia identifikatzen du. FileSystem zerbitzuaren FileNaming notazioa jarraitu behar du.

password: Dokumentua babestuta dagoenean erabili beharrekoa. Okerra bada edo falta bada dokumentua babestuta dagoenean, erabiltzaileari pasahitz bat sartu dezan eskatuko zaio.

readonly: Lehenetsia = False.

hidden: True bada, ireki dokumentu berria atzeko planoan (lehenetsia = False). Erabili kontuz, geroago dokumentua aktibatzea edo ixtea programazio bidez soilik egin baitaiteke.

macroexecution: 0 = portaera erabiltzaile-konfigurazioak definitzen du, 1 = makroak ez dira exekutagarriak, 2 = makroak exekutagarriak dira.

filtername: Dokumentua kargatzeko erabili beharko den iragazki baten izena. Argumentu hau ematen bada, iragazkiak existitu behar du.

filteroptions: Iragazkiari lotutako aukerak dituen kate bat.

Adibidea:

Basic lengoaian

      Dim myDoc As Object, FSO As Object
      Set myDoc = ui.OpenDocument("C:\Documents\myFile.odt", ReadOnly := True)
   
Python lengoaian

     svcUI.OpenDocument(r"C:\Documents\myFile.odt", readonly = True)
   

Resize

Leiho aktiboaren tamaina edo lekua aldatzen du. Argumentua ez badago edo negatiboa bada, ez ikusiarena egingo zaio. Leihoa ikonotuta edo maximizatuta badago, Resize metodoari argumenturik gabe deitzen bazaio leihoa berrezarri egingo da.

Sintaxia:

svc.Resize(left: int = -1, top: int = -1, width: int = -1, height: int = -1)

Parametroak:

left, top: Goiko ezkerreko izkinaren distantziak pantailaren goiko eta ezkerreko ertzetara, pixeletan.

width, height: Leihoaren dimentsio berriak, pixeletan.

Adibidea:

Hurrengo adibideetan, leihoaren width eta height parametroak aldatu egingo dira, baina top eta left aldaketarik gabe utziko dira.

Basic lengoaian

      ui.Resize(, ,500, 500)
   
Python lengoaian

     svcUI.Resize(width = 500, height = 500)
   
tip

Aktibo ez den leiho baten tamaina aldatzeko, lehenengo hura aktibatu behar da Activate metodoa erabilita.


SetStatusbar (*)

Bistaratu testu bat eta aurrerapen-barra bat leiho aktiboaren egoera-barran. Makro berari egindako hurrengo deiek leiho bereko egoera-barra berari egingo diote erreferentzia, baita leihoa ikusgai ez badago ere. Deia argumenturik gabe egiten bada, egoera-barra egoera normalera itzuliko da.

Sintaxia:

svc.SetStatusbar(text: str = '', percentage: int = -1)

Parametroak:

text: Aurrerapen-barraren aurrean bistaratuko den testu bat, aukerakoa.

percentage: Aurrerapen-maila, 0 eta 100 artekoa, aukerakoa.

Adibidea:

Basic lengoaian

      Dim i As Integer
      For i = 0 To 100
          ui.SetStatusbar("Progress ...", i)
          Wait 50
      Next i
      ' Egoera-barra berrezartzen du
      ui.SetStatusbar
   
Python lengoaian

     from time import sleep
     for i in range(101):
         svcUI.SetStatusbar("Test:", i)
         sleep(0.05)
     svcUI.SetStatusbar()
   

ShowProgressBar

Elkarrizketa-koadro ez modal bat bistaratzen du. Zehazte bere izenburua, azalpen-testua eta aurrerapen-barrak adieraziko den aurrerapen-ehunekoa. Elkarrizketa-koadroa ikusgai egongo da metodoari argumenturik gabe deitu arte edo erabiltzaileak elkarrizketa-koadroa eskuz ixten duen arte.

Sintaxia:

svc.ShowProgressBar(title: str = '', text: str = '', percentage: str = -1)

Parametroak:

title: Elkarrizketa-koadroaren goiko aldean agertuko den izenburua. Lehenetsia = "ScriptForge".

text: Aurrerapen-barraren gainean bistaratuko den testu bat, aukerakoa.

percentage: Aurrerapen-maila, 0 eta 100 artekoa, aukerakoa.

Adibidea:

Basic lengoaian

      Dim i As Integer
      For i = 0 To 100
          ui.ShowProgressBar("Window Title", "Progress ..." & i & "/100", i)
          Wait 50
      Next i
      ' Aurrerapen-barraren leihoa ixten du
      ui.ShowProgressBar
   
Python lengoaian

     from time import sleep
     for i in range(101):
         svcUI.ShowProgressBar("Window Title", "Progress ... " + str(i) + "/100", i)
         sleep(0.05)
     # Aurrerapen-barraren leihoa ixten du
     svcUI.ShowProgressBar()
   

WindowExists

True itzuliko du emandako leihoa identifikatu badaiteke.

Sintaxia:

svc.WindowExists(windowname: str): bool

Parametroak:

windowname: Ikusi goiko definizioak.

Adibidea:

Basic lengoaian

      If ui.WindowExists("C:\Document\My file.odt") Then
          ' ...
   
Python lengoaian

     if svcUI.WindowExists(r"C:\Document\My file.odt"):
         # ...
   

Emaguzu laguntza!