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.

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 Collabora Office-økten avsluttes. Lukk vindu-knappen er inaktiv i ikke-modale dialoger.

En dialogboks forsvinner fra minnet etter at den eksplisitt avsluttes.

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:

• 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()
  

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
  

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

Hendelsesegenskaper

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

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.

svc.Activate(): bool

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

Python- og Collabora Office 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.

svc.Center(opt Parent: obj): bool

Foreldre: Et valgfritt objekt som kan være enten …

• et ScriptForge-dialogobjekt

• et ScriptForge-dokument (Calc, Base, ...) objekt

     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
  

     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:

• listen over kontrollene i dialogboksen

• en klasseforekomst DialogControl basert på navnet

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

svc.Controls(controlname: str): svc

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.

      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.

svc.EndExecute(returnvalue: int)

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

Bruk Collabora Office 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)
   

Over com.sun.star.lang.EventObject-omtaler er valgfrie. Slike merknader hjelper med å identifisere Collabora Office Application Programming Interface (API).

Execute

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

• 0 : Avbryt-knappen trykket

• 1 : OK-knappen trykket

• Ellers stoppet dialogen med en EndExecute()-setning utstedt av en dialog- eller kontrollhendelse

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

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

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

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.

svc.GetTextsFromL10N(l10n: svc): bool

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

Følgende eksempel laster oversatte strenger og bruker dem på dialogen "MyDialog".

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

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

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.

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

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

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

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:

• Listeboks eller kombinasjonsboks: i dette tilfellet tilsvarer hver oppføring i listeboksen eller kombinasjonsboksen en side. Det første elementet refererer til side 1, det andre elementet refererer til side 2 og så videre.

• Gruppe av radioknapper: definerer en gruppe radioknapper som vil kontrollere hvilken side som er synlig.

• Rekkefølge av knapper: definerer et sett med knapper, som hver tilsvarer en dialogside. Dette kan brukes til å emulere et fanebasert grensesnitt ved å plassere knapper side ved side i dialogboksen.

• Forrige/Neste-knapper: definerer hvilke knapper i dialogboksen som skal brukes til å navigere til Forrige/Neste-siden i dialogboksen.

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.

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

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.

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.

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

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

Terminate

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

svc.Terminate(): bool

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:

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

Med Python:

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

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.