SFDialogs.Dialog service

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.

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

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

Container: "GlobalScope" for preinstalled libraries or a window name as defined by ScriptForge.UI service. Empty string "" default value stands for the current document.

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.

Below Collabora Office Basic and Python examples are displaying the dlgConsole dialog that belongs to ScriptForge shared library:

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

Alternatively a Dialog instance can be retrieved via the SFDialogs.DialogEvent service, providing that the dialog was initiated with the Dialog service. DialogEvent returns the SFDialogs.Dialog service instance that triggered the event.

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

with Python:

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

Note that in previous examples, the prefix "SFDialogs." may be omitted when deemed appropriate.

Egenskaper

Hendelsesegenskaper

Returns a URI string with the reference to the script triggered by the event. Read its specification in the scripting framework URI specification.

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

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)
   

Above com.sun.star.lang.EventObject mentions are optional. Such annotations help identify 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.

To create a list of translatable strings in a dialog use the AddTextsFromDialog method from the L10N service.

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

Read the L10N service help page to learn more about how PO and POT files are handled.

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.