Innhald
Innhaldsliste 🔎︎

# Tenesta SFDialogs.Dialog

Tenesta Dialog bidreg til handsaminga av dialogar oppretta med Basic lDialog Editor. Kvar førekomst av den nåverande klassen representerer éin dialogboks som vert vist for brukaren.

Ein dialogboks kan visast i modal eller ikkje-modal modus.

I modal modus vert boksen vist og utføringa av makroprosessen vert utsett til ein av OK- eller Avbryt -knappane vert trykt på. I mellomtida kan brukarhandlingar utført på boksen løysa ut spesifikke handlingar.

I ikkje-modal modus er dialogvindauget «flytande» på brukarskrivebordet, og køyringa av makroprosessen held fram som normalt. Eit ikkje-modalt dialogvindauge vert lukka når den vert avslutta med Terminate()-metoden eller når LibreOffice-økta vert avslutta. Lukkeknappen for vindauget er inaktiv i ikkje-modale dialogvindauge.

Eit dialogvindauge forsvinn frå minnet etter eksplisitt avslutning.

Tenesta SFDialogs.Dialog er i nært slektskap med tenesta SFDialogs.DialogControl.

## Oppkall og bruk av tenester

Før du brukar Dialog-tenesta, må ScriptForge-biblioteket lastast inn eller importerast:

• Grunnleggjande makroar krev innlasting av biblioteket ScriptForge ved hjelp av denne setninga:
GlobalScope.BasicLibraries.loadLibrary("ScriptForge")
• Python-skript krev import frå scriptforge-modulen:
from scriptforge import CreateScriptService

Tenesta Dialog vert kalla opp med metoden CreateScriptService. Ho krev tre posisjons-argument for å opna dialogvindauget.

Container: "GlobalScope" for førehandsinstallerte bibliotek eller eit vindaugenamn som er definert av tenesta ScriptForge.UI. Standardverdien tom streng "" står for det gjeldande dokumentet.

Bibliotek: Biblioteknamn (som skil mellom store og små bokstavar) finst i behaldaren. Standardverdien er «Standard».

Dialognamn: Ein streng som skil mellom store og små bokstavar, gjev dialogvindauget.

Eksempla nedanfor i Basic og Python viser dialogvindauget dlgConsole, som høyrer til det delte biblioteket 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 av kontrollelementa vert skrivne her…
          lButton = oDlg.Execute()
          ' Standardmodus = Modal
          If lButton = oDlg.OKBUTTON Then
          ' … Handsama kontrollelementa og gjera det som trengst her
          End If
          oDlg.Terminate()

Eller med Python:

        dlg = CreateScriptService('SFDialogs.Dialog', 'GlobalScope', 'ScriptForge', 'dlgConsole')
        ' … initialisering av kontrollelementa vert skrivne her…
        rc = dlg.Execute()
        ' Standardmodus er Modal
        if rc == dlg.OKBUTTON:
            ' … Handsama kontrollelementa og gjera det som trengst her
        dlg.Terminate()

Bruk strengen «GlobalScope» som container-argumentet når dialogvindauget er lagra anten i Mine makroar og dialogvindauge eller i Programmakroar og dialogvindauge.

## Hentar dialogførekomsten som løyste ut ei dialoghending

Du kan henta ein førekomst av tenesta Dialog via tenesta SFDialogs.DialogEvent viss dialogvindauget vart opna med tenesta Dialog. I eksempelet nedanfor inneheld førekomsten av oDlg førekomsten av Dialog som utløyste dialoghendinga.

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

Eller bruka Python:

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

Merk at i dei tidlegare eksempla kan prefikset «SFDialogs.» sløyfast når det passar best.

## Handsaming av unnatak i hendingshandsamarane

Når du opprettar ein hendingshandsamar for dialoghendingar, er det god praksis å handsama feil inne i sjølve underrutinen.For eksempel går du ut frå at hendingshandsamaren nedanfor vert kalla opp når museknappen vert trykt i dialogvindauget.

        Sub OnMouseButtonPressed(ByRef oEvent As Object)
        On Local Error GoTo Catch
            Dim oDialog As Object
            oDialog = CreateScriptService("DialogEvent", oEvent)
            ' Køyr hendinga
            Exit Sub
        Catch:
            MsgBox SF_Exception.Description
            SF_Exception.Clear
        End Sub

Kall opp SF_Exception.Clear viss du ikkje vil at feilen skal overførast vidare etter at dialogvindauget er avslutta.

I Python brukar du native try/except-blokker for unntakshandsaming som vist nedanfor:

        def on_mouse_button_pressed(event=None):
            try:
                dlg = CreateScriptService("DialogEvent", event)
                # Køyr hendinga
            except Exception as e:
                # Objektet «oBase» er ein førekomst av Basic-tenesta
                bas.MsgBox(str(e))

## Eigenskapar

Namn | Skriveverna | Type | Beskriving
--- | --- | --- | ---
OKBUTTON | Ja | Integer | Verdi = 1. Der vart trykt på ein OK-knapp.
CANCELBUTTON | Ja | Integer | Verdi = 0. Der vart trykt på ein Avbryt-knapp.
Caption | Nei | String | Spesifiser tittelen på dialogvindauget.
Height | Nei | Long | Spesifiser høgda på dialogvindauget.
Modal | Ja | Boolean | Viser om dialogvindauget vert køyrd i modal-modus.
Name | Ja | String | Namnet på dialogvindauget
Page | Nei | Integer | Eit dialogvindauge kan ha fleire sider som brukaren kan gå gjennom steg for steg. Kva side i dialogvindauget som er gjeldande, vert definert i sideeigenskapen.
Visible | Nei | Boolean | Spesifiserer om dialogvindauget er synleg på skrivebordet. Som standard er han ikkje synleg før etter at metoden Execute() er utført.
XDialogModel | Ja | UNO object | Det UNO-objektet som representer modellen for dialogvindauget. Sjå detaljert informasjon i XControlModel og UnoControlDialogModel i dokumentasjonen for API-en ( Application Programming Interface).
XDialogView | Ja | UNO object | Det UNO-objektet som representer modellen for dialogvindauget. Sjå detaljert informasjon i XControlModel og UnoControlDialogModel i dokumentasjonen for API-en ( Application Programming Interface).
Width | Nei | Long | Spesifiser breidda på dialogvindauget.

## Hendingseigenskapar

Returnerer ein URI-streng med referansen til skriptet som vert utløyst av hendinga. Les spesifikasjonen i scripting framework URI specification.

Skriv inn eit namn for objektet | Skriveverna | Basic IDE-beskriving
--- | --- | ---
OnFocusGained | Ja | Når han får fokus
OnFocusLost | Ja | Når han mistar fokus
OnKeyPressed | Ja | Ved tastetrykk
OnKeyReleased | Ja | Etter tastetrykk
OnMouseDragged | Ja | Muserørsle medan ein tast er trykt
OnMouseEntered | Ja | Mus innanfor
OnMouseExited | Ja | Mus utanfor
OnMouseMoved | Ja | Mus flytt
OnMousePressed | Ja | Museknapp trykt ned
OnMouseReleased | Ja | Museknapp sloppe

| Metodar |
--- | --- | ---
Activate Center Controls | EndExecute Execute GetTextsFromL10N | Resize SetPageManager Terminate

## Activate

Set fokus på det gjeldande dialogvindauget. Returner Sann viss fokuseringa lukkast.

Denne metoden vert kalla opp frå eit dialogvindauge, ei kontrollhending eller når det vert vist eit dialogvindauge i ikkje-modal modus.

### Syntaks:

svc.Activate(): bool

### Eksempel:

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

Både Python- og LibreOffice-Basic-eksempla går ut frå at dialogvidauget er lagra i Standard-biblioteket i det gjeldande dokument.

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

## Center

Sentrerer det gjeldande dialogvindauget i midten av eit overordna vindauge. Utan argument sentrerer metoden dialogvindauget i midten av det gjeldande vindauget.

Returnerer Sann når han lukkast.

### Syntaks:

svc.Center(opt Parent: obj): bool

### Parametrar:

Overordna: Eit valfritt objekt som kan vera anten…

- eit ScriptForge-dialogobjekt

- eit ScriptForge-dokument (Calc, Base, ...)-objekt

### Eksempel:

##### I Basic

         Sub TriggerEvent(oEvent As Object)
             Dim oDialog1 As Object, oDialog2 As Object, lExec As Long
             Set oDialog1 = CreateScriptService("DialogEvent", oEvent) ' Dialogvindauget som var årsaka til hendinga
             Set oDialog2 = CreateScriptService("Dialog", ...) ' Opnar eit anna dialogvindauge
             oDialog2.Center(oDialog1)
             lExec = oDialog2.Execute()
             Select Case lExec
                 ...
         End Sub

##### I Python

         def triggerEvent(event: uno):
           dlg1 = CreateScriptService('DialogEvent.Dialog', hendelse) # Dialogvindauget som var årsaka til hendinga
           dlg2 = CreateScriptService("Dialog", ...) # Opnar eit anna dialogvindauge
           dlg2.Center(dlg1)
           rc = dlg2.Execute()
           if rc is False:
             # ...

## Controls

Returner anten:

- lista over kontrollelement som er i dialogvidauget

- ein DialogControl-klasseførekomst basert på namnet

### Syntaks:

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

svc.Controls(controlname: str): svc

### Parametrar:

KontrolNamn: Eit gyldig kontrollnamn som ein streng (som skil mellom små og store bokstavar). Viss denne manglar vert lista over kontrollnamn returnert som ei 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

Avsluttar visinga av eit modalt dialogvindauge og returnerer argumentet som returverdi for den gjeldande køyrehandlinga Execute ().

EndExecute() er til vanleg å finna i handsaminga av ein makro som er utløyst av ei hending i eit dialogvindauge eller eit kontrollelement.

### Syntaks:

svc.EndExecute(returnvalue: int)

### Parametrar:

returverdi: Verdien som vert sendt til den køyrande Execute()-metoden.

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

Overnemnde com.sun.star.lang.EventObject er valfrie. Slike merknadar hjelper til med å identifisere LibreOffice Application Programming Interface (API).

## Execute

Viser dialogvindauget og ventar, når modal, på avslutning av brukaren. Den returnerte verdien er anten:

- 0: knappen Avbryt er trykt

- 1: knappen OK er trykt

- Elles vart dialogvindauget stoppa med eit EndExecute()-uttrykk sendt frå ei hending i eit dialogvindauge eller eit kontrollelement

For ikkje-modale dialogvindauge returnerer metoden alltid 0 og utføringa av makroen held fram-.

### Syntaks:

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

### Parametrar:

modal: Usann ved eit ikkje-modalt dialogvindauge. Standard = Sann .

### Eksempel:

I dette Basic-eksempelet er dialogvindauget myDialog lagra i det gjeldande dokumentet sitt 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 det modale dialogvindauget DlgConvert i det delte Basic-biblioteket DlgConvert.

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

## GetTextsFromL10N

Bytar ut alle faste tekststrengar i eit dialogvindauge med den omsette versjonen basert på ein førekomst av tenesta L10N . Denne metode omsett desse strengane:

- Tittelen på dialogvindauget.

- Tittelen på desse kontrollelementtypane: knapp avkryssingsfelt, fast linje, fast tekst, gruppefelt og radioknapp.

- Statiske strengar i listefelt og kombinasjonsfelt.

- Det verktøytipset eller hjelpteksten som kjem fram når musepeikaren vert halde over kontrollelementet.

Metoden returnerer Sann viss han lukkast.

Bruk metoden AddTextsFromDialog frå tenesta L10N for å laga ei liste over strengar som kan omsetjast i eit dialogvindauge.

### Syntaks:

svc.GetTextsFromL10N(l10n: svc): bool

### Parametrar:

l10n: Ein førekomst av tenesta L10N som dei omsette strengane vert henta frå.

### Eksempel:

Dei neste eksempla lastar inn omsette strengar og brukar dei i dialogvindauget «MinDialog»:

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

Les hjelpsida L10N service for å læra meir om korleis PO. og POT-filer vert handsama.

## Resize

Flyttar det øvre, høgre hjørnet i eit dialogvindauge til nye koordinat eller endrar storleiken på det. Alle avstandane vert viste i 1/100 mm. Viss argumenta manglar, vert vindauget sett til den opphavlege storleiken. Returnerer Sann viss endringa av storleiken var vellukka.

### Syntaks:

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

### Parametrar:

Venstre: den vassrette avstanden frå øvre venstre hjørne

Topp: den loddrette avstanden frå øvste venstre hjørne

Breidd: breidda på rektangelet som inneheld dialogvindauget

Høgd: høgda på rektangelet som inneheld dialogvindauget

Negative eller manglande argument vert ikkje endra

### Eksempel:

##### I Basic

         oDialog.Resize(1000, 2000, Height := 6000) ' Breidda er ikkje endra

##### I Python

Med Python:

         oDialog.Resize(1000, 2000, Height = 6000) # Breidda er ikkje endra

## SetPageManager

Definerer kva kontrollelement i eit dialogvindauge som er ansvarlege for å byta sider, noko som gjer det enklare å administrera Side-eigenskapen til eit dialogvindauge og kontrollelementa i vindauget.

Dialogvindauge kan ha fleire sider, og den synlege siden er definert av dialogeigenskapen Side. Viss eigenskapen Side er uendra, er standard synleg side lik 0 (null), noeko som betyr at ingen bestemt side er definert og alle synlege kontrollelement vert viste uavhengig av verdien sett i deira eigen Side-eigenskap.

Når eigenskapen Page for eit dialogvindauge vert endra til ein annan verdi, som 1, 2, 3 og så vidare, er det berre kontrollelementa som Page-eigenskap samsvarer med i det gjeldande dialogvindauget som vert viste.

Ved å bruka SetPageManager-metoden er det mogleg å definera fire typar sideadministratorar:

- Listeboks eller kombinasjonsboks: I dette tilfellet svarar kvar oppføring i listeboksen eller kombinasjonsboksen til ei side. Det første elementet refererer til side 1, det andre elementet refererer til side 2 og så vidare.

- Gruppe av radioknappar: Definerer ei gruppe radioknappar som vil kontrollera kva side som er synleg.

- Rekkjefølgje av knappar: definerer eit sett med knappar som kvar svarar til i side i eit dialogvindauge. Dette kan brukast til å etterlikna eit fanebasert grensesnitt ved å setja opp knappar side ved side i dialogvindauget.

- Knappane Førre / Neste: definerer kva for knappar i dialogvindauget som skal brukast til å navigera til førre- eller neste-sida i dialogvindauget.

Det er mogleg å bruka ein sidehandsamingsmekanisme samstundes.

Denne metoden er meint å kallast opp bere éin gong før Execute-metoden vert kalla opp. Etterfølgjande oppkall vert ignorerte.

Viss han lukkast, returnerer denne metoden Sann.

### Syntaks:

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

### Parametrar:

pilotcontrols: ei kommadelt liste over namna på kontrollane ListBox, ComboBox og RadioButton som vert brukte som sideadministratorar. For kontrollelementa «RadioButton» vert namnet spesifisert på det første elementet i gruppa som skal brukast.

tabcontrols: ei kommadelt liste over namn på knappar som vert brukite som sideadministratorar. Rekkjefølgja dei er spesifiserte i dette argumentet svarar til sidetalet dei er knytte til.

wizardcontrols: ei kommadelt liste med namna på dei to knappane som vert brukte som knappar for «Førre» og «Neste».

lastpage: nummeret på den siste tilgjengelege sida. Det vert rådd til å spesifisera denne verdien når du brukar sidehandsaminga «Førre» og «Neste».

### Eksempel:

Tenk deg eit dialogvindauge med tre sider. Dialogvindauget har ein ListBox-kontroll kalla «aPageList» som vert brukt til å kontrollera den synlege sida. I tillegg er det to knappar kalla «btnForrige» og «btnNeste» som vil verta brukte som «Førre/Neste»-knappane i dialogvindauget.

##### 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 tenesta Dialog i den gjeldande førekomsten. Returner Sann viss avslutninga lukkast.

### Syntaks:

svc.Terminate(): bool

### Eksempel:

Basic- og Python-eksempla nedanfor opnar dei ikkje-modale dialogvindauga DlgConsole og dlgTrace. Dei er lagra i dei delte biblioteka ScriptForge og Access2Base. Knappane for å lukka dialogvindauga er kopla frå, og eksplisitt avslutning vert utført på slutten av ein køyrande prosess.

I dette eksempelet erstattar ein knapp i DlgConsole hemma lukking av vindauget:

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

Alle ScriptForge Basic-rutinane og -identifikatorane som vert innleidde med understrek «_» er reserverte for internt bruk. Dei er ikkje meint brukte i Basic-makroar.

Liknande emne

Tenesta SFDialogs.DialogControl

Tenesta ScriptForge.UI