SFDialoger.Dialog tjeneste

Tjenesten Dialog bidrar til administrasjonen av dialoger opprettet med den grunnleggende Dialog Redigerer. Hver forekomst av gjeldende klasse representerer en enkelt dialogboks som vises for brukeren.

tip

En dialogboks kan vises i modal eller ikke-modal modus.


I modal modus vises boksen og utfÞrelsen av makroprosessen avbrytes til en av OK- eller Avbryt-knappene trykkes. I mellomtiden kan brukerhandlinger utfÞrt pÄ boksen utlÞse spesifikke handlinger.

I ikke-modal modus er dialogboksen "flytende" pÄ brukerens skrivebord og utfÞrelsen av makroprosessen fortsetter normalt. En ikke-modal dialogboks lukkes nÄr den avsluttes med Terminate()-metoden eller nÄr LibreOffice-Þkten avsluttes. Lukk vindu-knappen er inaktiv i ikke-modale dialoger.

En dialogboks forsvinner fra minnet etter at den eksplisitt avsluttes.

tip

SFDialogs.Dialog-tjenesten er nĂŠrt beslektet med SFDialogs.DialogControl-tjenesten.


Tjenesteanrop og bruk

FÞr du bruker Dialog-tjenesten, mÄ ScriptForge-biblioteket lastes eller importeres:

note

‱ Grunnleggende makroer krever Ă„ laste ScriptForge-biblioteket ved hjelp av fĂžlgende setning:
GlobalScope.BasicLibraries.loadLibrary("ScriptForge")

‱ Python-skript krever import fra scriptforge-modulen:
fra scriptforge import CreateScriptService


Dialog-tjenesten pÄkalles gjennom metoden CreateScriptService. Det krever tre posisjonsargumenter for Ä spesifisere dialogboksen som skal aktiveres:

Beholder: "GlobalScope" for forhÄndsinstallerte biblioteker eller en vindusnavn som definert av ScriptForge.UI-tjenesten. Tom streng "" standardverdi stÄr for gjeldende dokument.

Bibliotek: Det skiller mellom store og smÄ bokstaver i navnet pÄ et bibliotek i beholderen. Standardverdien er "Standard".

DialogName: En streng som skiller mellom store og smÄ bokstaver som angir dialogen.

Eksemplene nedenfor i Basic og Python viser dlgConsole-dialogboksen som tilhĂžrer ScriptForge delte bibliotek:


      Dim oDlg As Object, lButton As Long
      Dim Container As String, Library As String, DialogName As String
      Set oDlg = CreateScriptService("SFDialogs.Dialog", "GlobalScope", "ScriptForge", "dlgConsole")
      '...kontrollinitialisering gÄr her...
      lButton = oDlg.Execute()
      'Standardmodus = Modal
      If lButton = oDlg.OKBUTTON Then
      '... Prosesskontroller og gjĂžr det som trengs her
      End If
      oDlg.Terminate()
  

Eller bruk Python:


    dlg = CreateScriptService('SFDialogs.Dialog', 'GlobalScope', 'ScriptForge', 'dlgConsole')
    # ... kontroller initialisering gÄr her ...
    rc = dlg.Execute()
    # Standardmodus er Modal
    if rc == dlg.OKBUTTON:
        # ... Prosesskontroller og gjĂžr det som trengs her
    dlg.Terminate()
  
note

Bruk strengen "GlobalScope" som container-argumentet nÄr dialogen er lagret enten i Mine makroer og dialogbokser eller i Programmakroer og dialogbokser.


Henter dialogforekomsten som utlĂžste en dialoghendelse

En forekomst av Dialog-tjenesten kan hentes via SFDialogs.DialogEvent-tjenesten, forutsatt at dialogen ble startet med Dialog-tjenesten. I eksemplet nedenfor inneholder oDlg Dialog-forekomsten som utlĂžste dialoghendelsen.


    Sub aDialogEventHander(ByRef poEvent As Object)
        Dim oDlg As Object
        Set oDlg = CreateScriptService("SFDialogs.DialogEvent", poEvent)
        ' ...
    End Sub
  

Eller bruk Python:


    def control_event_handler(event: uno):
        dlg = CreateScriptService("SFDialogs.DialogEvent", event)
        # ...
  

Merk at i de foregÄende eksemplene kan prefikset "SFDialogs." utelates nÄr det anses hensiktsmessig.

HÄndtering av unntak i hendelsesbehandlere

NÄr du oppretter en hendelsesbehandler for dialoghendelser, er det god praksis Ä hÄndtere feil inne i selve subrutinen. Anta for eksempel at hendelsesbehandleren nedenfor kalles nÄr museknappen trykkes i dialogvinduet.


    Sub OnMouseButtonPressed(ByRef oEvent As Object)
    On Local Error GoTo Catch
        Dim oDialog As Object
        oDialog = CreateScriptService("DialogEvent", oEvent)
        ' KjĂžr hendelsen
        Exit Sub
    Catch:
        MsgBox SF_Exception.Description
        SF_Exception.Clear
    End Sub
  
tip

Ring SF_Exception.Clear hvis du ikke vil at feilen skal forplante seg etter at dialogboksen er avsluttet.


I Python, bruk native try/except-blokker for unntakshÄndtering som vist nedenfor:


    def on_mouse_button_pressed(event=None):
        try:
            dlg = CreateScriptService("DialogEvent", event)
            # KjĂžr hendelsen
        except Exception as e:
            # Objektet "bas" er en forekomst av Basic-tjenesten
            bas.MsgBox(str(e))
  

Egenskaper

Navn

Skrivebeskyttet

Type

Beskrivelse

OKBUTTON

Ja

Integer

Verdi = 1. En OK-knapp ble trykket.

CANCELBUTTON

Ja

Integer

Verdi = 0. En Avbryt-knapp ble trykket.

Caption

Nei

String

Angi tittelen pÄ dialogen

Height

Nei

Long

Angi hÞyden pÄ dialogboksen.

Modal

Ja

Boolean

Angir om dialogboksen for Ăžyeblikket kjĂžres i modal modus.

Name

Ja

String

Navnet pÄ dialogboksen

Page

Nei

Integer

En dialog kan ha flere sider som brukeren kan gÄ gjennom trinn for trinn. Side-egenskapen til Dialog-objektet definerer hvilken side i dialogboksen som er aktiv.

Visible

Nei

Boolean

Spesifiser om dialogboksen er synlig pÄ skrivebordet. Som standard er den ikke synlig fÞr Execute()-metoden kjÞres og er synlig etterpÄ.

XDialogModel

Ja

UNO
object

UNO-objektet som representerer dialogmodellen. Se XControlModel og UnoControlDialogModel i Application Programming Interface for detailedI.

XDialogView

Ja

UNO
object

UNO-objektet som representerer dialogvisningen. Se XControl og UnoControlDialog i Application Programming Interface (API) dokumentasjon for detaljert informasjon.

Width

Nei

Long

Angi bredden pÄ dialogboksen.


Hendelsesegenskaper

Returnerer en URI-streng med referansen til skriptet som utlĂžses av hendelsen. Les spesifikasjonen i URI-spesifikasjonen for skriptrammeverk.

Navn

Skrivebeskyttet

Basic IDE Beskrivelse

OnFocusGained

Ja

NÄr du mottar fokus

OnFocusLost

Ja

NÄr man mister fokus

OnKeyPressed

Ja

Tast trykket

OnKeyReleased

Ja

NĂžkkelen er sluppet

OnMouseDragged

Ja

Musen beveget seg mens tasten trykkes

OnMouseEntered

Ja

Mus innenfor

OnMouseExited

Ja

Mus utenfor

OnMouseMoved

Ja

Musen beveget seg

OnMousePressed

Ja

Museknapp trykket

OnMouseReleased

Ja

Museknappen slippes


Metoder

Activate
Center
Controls

EndExecute
Execute
GetTextsFromL10N

Resize
SetPageManager
Terminate


Activate

Sett fokus pÄ gjeldende Dialog-forekomst. Returner Sann hvis fokuseringen var vellykket.

Denne metoden kalles fra en dialog- eller kontrollhendelse, eller nÄr en dialogboks vises i ikke-modal modus.

Syntaks:

svc.Activate(): bool

Eksempel:


      Dim oDlg As Object
      Set oDlg = CreateScriptService(,, "myDialog")
      oDlg.Execute()
      ' ...
      oDlg.Activate()
   

Python- og LibreOffice Basic-eksempler forutsetter begge at dialogboksen er lagret i gjeldende dokuments Standard-bibliotek.


     dlg = CreateScriptService(,,'myDialog')
     dlg.Execute()
     # ...
     dlg.Activate()
   

Center

Sentrerer gjeldende dialogforekomst i midten av et overordnet vindu. Uten argumenter sentrerer metoden dialogen i midten av det gjeldende vinduet.

Returnerer Sann nÄr det lykkes.

Syntaks:

svc.Center(opt Parent: obj): bool

Parametre:

Foreldre: Et valgfritt objekt som kan vére enten 


Eksempel:

I Basic

     Sub TriggerEvent(oEvent As Object)
         Dim oDialog1 As Object, oDialog2 As Object, lExec As Long
         Set oDialog1 = CreateScriptService("DialogEvent", oEvent) ' Dialogboksen som forÄrsaket hendelsen
         Set oDialog2 = CreateScriptService("Dialog", ...) ' Åpne en annen dialog
         oDialog2.Center(oDialog1)
         lExec = oDialog2.Execute()
         Select Case lExec
             ...
     End Sub
  
I Python

     def triggerEvent(event: uno):
       dlg1 = CreateScriptService('DialogEvent.Dialog', hendelse) # Dialogboksen som forÄrsaket hendelsen
       dlg2 = CreateScriptService('Dialog', ...) # Åpne en ny dialogboks
       dlg2.Center(dlg1)
       rc = dlg2.Execute()
       if rc is False:
         # ...
   

Controls

Returner enten:

Syntaks:

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

svc.Controls(controlname: str): svc

Parametre:

Kontrollnavn : Et gyldig kontrollnavn som en streng som skiller mellom store og smÄ bokstaver. Hvis fravÊrende, returneres listen over kontrollnavn som en nullbasert matrise.

Eksempel:


      Dim myDialog As Object, myList As Variant, myControl As Object
      Set myDialog = CreateScriptService("SFDialogs.Dialog", , "Standard", "Dialog1")
      myList = myDialog.Controls()
      Set myControl = myDialog.Controls("myTextBox")
   

     dlg = CreateScriptService('SFDialogs.Dialog','', 'Standard', 'Dialog1')
     ctrls = dlg.Controls()
     ctrl = dlg.Controls('myTextBox')
   

EndExecute

Avslutter visningen av en modal dialog og gir tilbake argumentet som returverdi for gjeldende KjĂžr() kjĂžrende handling.

EndExecute() er vanligvis inneholdt i behandlingen av en makro utlĂžst av en dialog- eller kontrollhendelse.

Syntaks:

svc.EndExecute(returnvalue: int)

Parametre:

returnvalue: Verdien som ble sendt til den kjĂžrende Execute()-metoden.

Eksempel:

Bruk LibreOffice Basic:


      Sub OnEvent(poEvent As com.sun.star.lang.EventObject)
          Dim oDlg As Object
          Set oDlg = CreateScriptService("SFDialogs.DialogEvent", poEvent)
          oDlg.EndExecute(ReturnValue := 25)
      End Sub
   

Bruk Python:


     from com.sun.star.lang import EventObject
     def on_event(event: EventObject):
         dlg = CreateScriptService("SFDialogs.DialogEvent", event)
         dlg.EndExecute(25)
   
tip

Over com.sun.star.lang.EventObject-omtaler er valgfrie. Slike merknader hjelper med Ă„ identifisere LibreOffice Application Programming Interface (API).


Execute

Vis dialogboksen og, nÄr modal, vent pÄ at avsluttes av brukeren. Den returnerte verdien er enten:

For ikke-modale dialogbokser returnerer metoden alltid 0 og utfĂžrelsen av makroen fortsetter.

Syntaks:

svc.Execute(modal: bool = True): int

Parametre:

modal: Usann nÄr ikke-modal dialog. Standard = Sann.

Eksempel:

I dette grunnleggende eksempelet er myDialog-dialogboksen lagret i gjeldende dokuments Standard-bibliotek.


      Dim oDlg As Object, lReturn As Long
      Set oDlg = CreateScriptService("SFDialogs.Dialog", , , "myDialog")
      lReturn = oDlg.Execute(Modal := False)
      Select Case lReturn
          ' ...
      End Select
   

Denne Python-koden viser DlgConvert modal dialog fra Euro delt Basic-bibliotek.


     dlg = CreateScriptService("SFDialogs.Dialog", 'GlobalScope', 'Euro', "DlgConvert")
     rc = dlg.Execute()
     if rc == dlg.CANCELBUTTON:
         # ...
   

GetTextsFromL10N

Erstatter alle faste tekststrenger i en dialog med deres oversatte versjoner basert pÄ en L10N tjenesteforekomst. Denne metoden oversetter fÞlgende strenger:

Metoden returnerer Sann hvis vellykket.

For Ă„ lage en liste over oversettbare strenger i en dialog, bruk AddTextsFromDialog-metoden fra L10N-tjenesten.

Syntaks:

svc.GetTextsFromL10N(l10n: svc): bool

Parametre:

l10n: En L10N tjenesteforekomst som oversatte strenger vil bli hentet fra.

Eksempel:

FÞlgende eksempel laster oversatte strenger og bruker dem pÄ dialogen "MyDialog".

I Basic

     oDlg = CreateScriptService("Dialog", "GlobalScope", "Standard", "MyDialog")
     myPO = CreateScriptService("L10N", "/home/user/po_files/")
     oDlg.GetTextsFromL10N(myPO)
     oDlg.Execute()
   
I Python

     dlg = CreateScriptService("Dialog", "GlobalScope", "Standard", "MyDialog")
     myPO = CreateScriptService("L10N", "/home/user/po_files/")
     dlg.GetTextsFromL10N(myPO)
     dlg.Execute()
   
tip

Les L10N-tjenesten hjelpesiden for Ä lÊre mer om hvordan PO- og POT-filer hÄndteres.


Resize

Flytter det Ăžverste venstre hjĂžrnet av en dialogboks til nye koordinater og/eller endrer dimensjonene. Alle avstander er uttrykt i 1/100 mm. Uten argumenter tilbakestiller metoden de opprinnelige dimensjonene. Returner True hvis endringen av stĂžrrelse var vellykket.

Syntaks:

svc.Resize(opt Left: num, opt Top: num, opt Width: num, opt Height: num): bool

Parametre:

Venstre: den horisontale avstanden fra Ăžverste venstre hjĂžrne

Topp: den vertikale avstanden fra Ăžverste venstre hjĂžrne

Bredde: bredden pÄ rektangelet som inneholder dialogboksen

HÞyde: HÞyden pÄ rektangelet som inneholder dialogboksen

Negative eller manglende argumenter forblir uendret

Eksempel:

I Basic

     oDialog.Resize(1000, 2000, Height := 6000) ' Bredde er ikke endret
   
I Python

Med Python:


     oDialog.Resize(1000, 2000, Height = 6000) # Bredde er ikke endret
   

SetPageManager

Definerer hvilke kontroller i en dialog som er ansvarlige for Ă„ bytte side, noe som gjĂžr det enklere Ă„ administrere Side-egenskapen til en dialogboks og dens kontroller.

Dialoger kan ha flere sider, og den synlige siden er definert av dialogegenskapen Side. Hvis egenskapen Side forblir uendret, er standard synlig side lik 0 (null), noe som betyr at ingen bestemt side er definert og alle synlige kontroller vises uavhengig av verdien satt i deres egen Side-eiendom.

NÄr egenskapen Side til en dialogboks endres til en annen verdi som 1, 2, 3 og sÄ videre, er det bare kontrollene hvis Side-egenskap samsvarer med den gjeldende dialogsiden vil vises.

Ved Ă„ bruke SetPageManager-metoden er det mulig Ă„ definere fire typer sideadministratorer:

tip

Det er mulig Ä bruke mer enn én sidebehandlingsmekanisme samtidig.


Denne metoden skal kalles bare én gang fÞr Execute-metoden kalles. EtterfÞlgende anrop ignoreres.

Hvis den lykkes, returnerer denne metoden Sann.

Syntaks:

svc.SetPageManager(pilotcontrols: str = "", tabcontrols: str = "", wizardcontrols: str = "", opt lastpage: int): bool

Parametre:

pilotkontroller: en kommadelt liste over ListBox, ComboBox eller RadioButton kontrollnavn som brukes som sideadministratorer. For RadioButton-kontroller, spesifiser navnet pÄ den fÞrste kontrollen i gruppen som skal brukes.

tabkontroller: en kommadelt liste over knappenavn som vil bli brukt som sideadministratorer. RekkefĂžlgen de er spesifisert i dette argumentet tilsvarer sidetallet de er knyttet til.

veiviserkontroller: en kommadelt liste med navnene pÄ to knapper som vil bli brukt som Forrige/Neste-knappene.

lastpage: nummeret pÄ den siste tilgjengelige siden. Det anbefales Ä spesifisere denne verdien nÄr du bruker Forrige/Neste sidebehandling.

Eksempel:

Tenk pÄ en dialog med tre sider. Dialogboksen har en ListBox-kontroll kalt "aPageList" som vil bli brukt til Ä kontrollere den synlige siden. I tillegg er det to knapper kalt "btnForrige" og "btnNeste" som vil bli brukt som Forrige/Neste-knappene i dialogboksen.

I Basic

    oDialog.SetPageManager(PilotControls := "aPageList", _
                           WizardControls := "btnPrevious,btnNext", _
                           LastPage := 3)
    oDialog.Execute()
  
I Python

    dlg.SetPageManager(pilotcontrols="aPageList",
                       wizardcontrols="btnPrevious,btnNext",
                       lastpage=3)
    dlg.Execute()
  

Terminate

Avslutt Dialog-tjenesten for gjeldende forekomst. Returner True hvis oppsigelsen var vellykket.

Syntaks:

svc.Terminate(): bool

Eksempel:

Nedenfor Basic og Python-eksempler Äpner DlgConsole og dlgTrace ikke-modale dialoger. De er henholdsvis lagret i ScriptForge og Access2Base delte biblioteker. Lukkeknapper for dialogbokser er deaktivert og eksplisitt avslutning utfÞres pÄ slutten av en kjÞrende prosess.

I dette eksemplet erstatter en knapp i DlgConsole hindret vinduslukking:

I Basic

     oDlg = CreateScriptService("SFDialogs.Dialog","GlobalScope","ScriptForge","DlgConsole")
     oDlg.Execute(modal:=False)
     Wait 5000
     oDlg.Terminate()
   

Med Python:

I Python

     from time import sleep
     dlg = CreateScriptService('SFDialogs.Dialog',"GlobalScope",'Access2Base',"dlgTrace")
     dlg.Execute(modal=False)
     sleep 5
     dlg.Terminate()
   
warning

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.