Tjenesten SFDialogs.Dialog

Indhold
Indholdsfortegnelse 🔎︎

# Tjenesten SFDialogs. Dialog

Tjenesten Dialog bidrager til håndteringen af dialoger, der er oprettet med Basics Dialog-redigering. Hver forekomst af den aktuelle klasse repræsenter et enkelt dialogfelt, der vises for brugeren.

Et dialogfelt kan vises i modal eller ikke-modal tilstand.

I modal tilstand vises feltet og udførelsen af makro-processen er udsat, indtil der trykkes på en af knapperne OK eller Annuller. I mellemtiden kan brugerhandlinger, udført på feltet, udløse bestemte handlinger.

I ikke-modal tilstand "Flyder" dialogfeltet på brugerskrivebordet og udførelsen af makroprocessen fortsætter normalt. En ikke-modal dialog lukker, når den afsluttes med metoden Terminate() eller når sessionen LibreOffice Slutter. Knappen Luk vindue er inaktiv i ikke-modale dialoger.

Et dialogfelt forsvinger fra hukommelsen efter dets udtrykkelige afslfutning.

Tjenesten SFDialogs.Dialog er nært beslægtet med tjenesten SFDialogs.DialogControl.

## Kald og brug af tjeneste

Tjenesten Dialog kaldes med metoden CreateScriptService. Den kræver tre positions-argumenter til at angive dialogfeltet, der skal aktiveres:

Container: "GlobalScope" til forudinstallerede biblioteker eller et vinduesnavn som defineret af tjenesten ScriptForge.UI. Standardværdien tom streng "" står for det aktuelle dokument.

Bibliotek: Biblioteksnavn med skelnen mellem Store og små bogstaver, der findes i containeren. Standardværdien er "Standard".

DialogNavn: En streng, hvor der skelnes mellem Store og små bogstaver, og som betegner dialogen.

PRODUCTNAME Basic- og Python-eksemplerne herunder viser dialogen dlgConsole, der tilhører det delte bibliotek ScriptForge:

          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")
          '... initialisering af kontrolelementer skrives her...
          lButton = oDlg.Execute()
          'Standard tilstand = Modal
          If lButton = oDlg.OKBUTTON Then
          '... Proceskontrollerer og gør, hvad der er nødvendigt her
          End If
          oDlg.Terminate()

Eller med Python:

        dlg = CreateScriptService('SFDialogs.Dialog', 'GlobalScope', 'ScriptForge', 'dlgConsole')
        # ... initialisering af kontroller skrives her...
        rc = dlg.Execute()
        # Standard-tilstand er Modal
        if rc == dlg.OKBUTTON:
            # ... Behandl kontroller og gør, hvad der er nødvendigt her
        dlg.Terminate()

Alternativt kan en forekomst af Dialog hentes via tjenesten SFDialogs.DialogEvent, forudsat at dialogen blevinitieret med tjenesten Dialog. DialogEvent returnerer den forekomst af tjenesten SFDialogs.Dialog, der udløste hændelsen.

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

med Python:

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

Bemærk, at i de tidligere eksempler kan præfikset "SFDialogs." udelades, når det skønnes passende.

## Egenskaber

Navn | Skrivebeskyttet | Type | Beskrivelse
OKBUTTON | Ja | Integer | Værdi = 1. Der blev trykket på en OK-knap.
CANCELBUTTON | Ja | Integer | Værdi = 1. Der blev trykket på en OK-knap.
Caption | Nej | String | Angiv dialogens titel.
Height | Nej | Long | Angiv højden på dialogfeltet.
Modal | Ja | Boolean | Angiver, om dialogfeltet aktuelt er i udførelse i modal tilstand.
Name | Ja | String | Dialogens navn
Page | Nej | Integer | En dialog kan have flere sider, som brugeren kan gå igennem trin for trin. Dialogobjektets sideegenskab definerer, hvilken af dialogens sider, der er aktiv.
Visible | Nej | Boolean | Angiv, om dialogfeltet er synligt på skrivebordet. Som standard er det ikke synligt, før metoden Execute() køres og synligt derefter.
XDialogModel | Ja | UNO object | Det UNO-objekt, der repræsenter dialogenmodellen. Se detaljeret information i XControlModel og UnoControlDialogModel i APIens (Application Programming Interface) dokumentation.
XDialogView | Ja | UNO object | Det UNO-objekt, der repræsenter dialogvisningen. Se detaljeret information i XControl og UnoControlDialog i APIens (Application Programming Interface) dokumentation.
Width | Nej | Long | Angiv dialogfeltets bredde.

## Hændelsesegenskaber

Disse hændelsesegenskaber er tilgængelige fra LibreOffice 7.2 og fremad.

Returnerer en URI-streng med reference til det script, der udløste hændelsen. Læs den specifikation i script-rammens URI-specifikation.

Navn | Skrivebeskyttet | Beskrivelse af Basic IDE
OnFocusGained | Ja | Når fokus modtages
OnFocusLost | Ja | Når fokus mistes
OnKeyPressed | Ja | Tast trykket
OnKeyReleased | Ja | Tast sluppet
OnMouseDragged | Ja | Mus flyttet mens tast trykkes
OnMouseEntered | Ja | Mus indenfor
OnMouseExited | Ja | Mus udenfor
OnMouseMoved | Ja | Mus flyttet
OnMousePressed | Ja | Museknap trykket
OnMouseReleased | Ja | Museknap sluttet

| Metoder |
Activate Controls | EndExecute Execute | Terminate

## Activate

Sæt fokus på den aktuelle forekomst af Dialog. Returner True, hvis fokuseringen lykkedes.

Den metode kaldes fra en dialog, en kontrolhændelse eller når der vises en dialog i ikke-modal tilstand.

### Syntaks:

svc.Activate(): bool

### Eksempel:

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

Både Python- og LibreOffice-Basic-eksempler antager, at dialogen er gemt i det aktuelle dokuments Standard-bibliotek.

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

## Controls

Returner enten:

- listen over kontrolelementer, der er indeholdt i dialogen

- en DialogControl-klasseforekomst baseret på dens navn

### Syntaks:

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

svc.Controls(controlname: str): svc

### Parametre:

KontrolNavn: Et gyldigt kontrolnavn som en streng, der skelner mellem Store og små bogstaver. Hvis den mangler, returneres listen over kontrolnavne som en nul-baseret matrix.

### 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

Afslutter visningen af en modal dialog og giver argumentet tilbage som den aktuelle Execute() løbende handlings returværdi.

EndExecute() opbevares sædvanligvis i behandlingen af en makro, der udløstes af en dialog eller en kontrolhændelse.

### Syntaks:

svc.EndExecute(returnvalue: int)

### Parametre:

returværdi: Den værdi, der videregives til den kørende Execute()-metode.

### Eksempel:

Med 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

Med Python:

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

Ovennævnte omtaler af com.sun.star.lang.EventObject er valgfrie. Disse anmærkninger hjælper med at identificere LibreOffice Application Programming Interface (API).

## Execute

Viser dialogfeltet og venter, når modal, på den afslutning af brugeren. Den returnerede værdi er enten:

- 0: et tryk på knappen Annuller

- 1 : et tryk på knappen OK

- Ellers stoppede dialogen med et EndExecute()-udtryk, udsendt af en dialog eller en kontrolhændelse

Ved ikke-modale dialogfelter returnerer metoden altid 0 og udførelsen af makroen fortsætter.

### Syntaks:

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

### Parametre:

modal: False (falsk) ved en ikke-modal dialog. Standard = True (sand).

### Eksempel:

I dette Basic-eksempel er dialogen myDialog gemt i det aktuelle 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-kode viser den modale dialog DlgConvert i det delte Basic-bibliotek DlgConvert.

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

## Terminate

Afslut tjenesten Dialog i den aktuelle forekomst. Returner True (sand), hvis afslutningen lykkedes.

### Syntaks:

svc.Terminate(): bool

### Eksempel:

Basic- og Python-eksemplerne herunder åbner de ikke modale dialoger DlgConsole og dlgTrace. De gemmes henholdsvis i de delte biblioteker ScriptForge og Access2Base. Luk dialog-knapperne er deaktiveret og der udføres udtrykkelig afslutning i slutningen af en kørselsproces.

I dette eksempel erstatter en knap i DlgConsole hæmmet lukning af vinduet:

         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 Basic-rutiner eller identifikatorer, som indledes med et understregningstegn "_" er reserveret til internt brug. De er ikke beregnet til brug i Basic-makroer.

Relaterede emner

Tjenesten SFDialogs.DialogControl

Tjenesten ScriptForge.UI (brugerflade)