SFDialoger.Dialog tjeneste

Tjenesten Dialog bidrar til administrasjonen av dialoger som er opprettet med den grunnleggende Dialog Editor eller dialoger som er opprettet i farten . 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 LibreOffice-ø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 supplerende 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.

Dialogtjenesten tilbyr metoder som oppretter nye kontroller dynamisk i en eksisterende dialogboks som er forhåndsdefinert med Dialog Editor. En dialog er initialisert med kontroller i dialogredigereren, og nye kontroller kan legges til under kjøring før eller etter dialogen Execute()-setningen.

Tjenesten Dialog kan på samme måte aktiveres - gjennom CreateScriptService-metoden - når du oppretter dialoger på farten. Det krever to supplerende posisjonsargumenter etter navnet på ad-hoc-tjenesten "NewDialog":

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

Sted: Vinduets plassering av dialogboksen er enten:

• en grunnleggende Matrise eller Python-tuppel med 4 elementer: (X, Y, bredde, høyde)

• et com.sun.star.awt.Rectangle [X, Y, Bredde, Høyde] objekt

Alle elementer er uttrykt i Kart AppFont-enheter.

    Sub newDialog()
        Dim oDlg As Object
       oDlg = CreateScriptService("NewDialog", "myDialog1", Array(100,200, 40, 110))
       ' ...
    End Sub
  

Eller bruk Python:

    def newDialog():
       dlg = CreateScriptService('NewDialog', 'myDialog1', (100,200, 40, 110))
       # ... Prosesskontroller og gjør det som trengs
  

Alle egenskaper og metoder som gjelder for forhåndsdefinerte dialoger er tilgjengelige for slike nye dialoger. Spesielt serien med CreateXXX() metoder for å legge til nye dialogkontroller.

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

On… egenskaper returnerer en URI-streng med referansen til skriptet som utløses av hendelsen. On… egenskaper kan settes programmatisk.
Les spesifikasjonen i skriptrammeverket URI-spesifikasjon.

Tilordning av hendelser via Basic IDE og tilordning av hendelser via makroer utelukker hverandre.

Dimensjonering av en dialog gjøres ved å bruke Kart AppFont-enheter. En dialog- eller kontrollmodell bruker også AppFont-enheter. Mens visningene bruker piksler.

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

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

CloneControl

Dupliser en eksisterende kontroll av hvilken som helst type i selve dialogboksen. Den dupliserte kontrollen forblir uendret og kan flyttes.

svc.CloneControl(SourceName: str, ControlName: str, Left: num, Top: num): svc

Kildenavn: Navnet på kontrollen som skal dupliseres.

Kontrollnavn: Et gyldig kontrollnavn som en streng som skiller mellom store og små bokstaver. Det må ikke eksistere ennå.

Venstre, Topp: Koordinatene til den nye kontrollen uttrykt i Kart AppFont-enheter.

      Set myButton2 = oDlg.CloneControl("Button1", "Button2", 30, 30)
   

     dlg = dlg.CloneControl('Button1', 'Button2', 30, 30)
   

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

CreateButton

Opprett en ny kontroll av typen Knapp i den gjeldende dialogboksen.

svc.CreateButton(ControlName: str, Place: any, Toggle: bool = False, Push: str = ""): svc

Kontrollnavn: navnet på den nye kontrollen. Det må ikke eksistere ennå.

Sted: enten …

• En grunnleggende Matrise eller Python-tuppel med 4 elementer: (X, Y, bredde, høyde)

• et com.sun.star.awt.Rectangle [X, Y, Bredde, Høyde] objekt

Alle elementer er uttrykt i Kart AppFont-enheter.

Veksle: når True opprettes en veksleknapp. Standard = Usann

Trykk: "OK", "CANCEL" eller "" (standard)

En forekomst av SFDialogs.DialogControl-tjeneste eller Ingenting .

     Set myButton = oDlg.CreateButton("Button1", Array(20, 20, 60, 15))
   

     myButton = dlg.CreateButton('Button1', (20, 20, 60, 15))
   

CreateCheckBox

Opprett en ny kontroll av typen CheckBox i den gjeldende dialogboksen.

svc.CreateCheckBox(ControlName: str, Place: any, Multiline: bool = False): svc

MultiLine: Når True (standard = Usann), kan bildeteksten vises på mer enn én linje.

     Set myCheckBox = oDlg.CreateCheckBox("CheckBox1", Array(20, 20, 60, 15), MultiLine := True)
   

     myCheckBox = dlg.CreateCheckBox('CheckBox1', (20, 20, 60, 15), MultiLine = True)
   

CreateComboBox

Opprett en ny kontroll av typen ComboBox i den gjeldende dialogboksen.

svc.CreateComboBox(ControlName: str, Place: any, Border: str = "3D", DropDown: bool = True, LineCount: num = 5): svc

Kantlinjer: "3D" (standard) eller "FLAT" eller "INGEN"

DropDown: Når True (standard), vises en rullegardinknapp

LineCount: Spesifiserer det maksimale linjeantallet som vises i rullegardinmenyen (standard = 5)

     Set myComboBox = oDlg.CreateComboBox("ComboBox1", Array(20, 20, 60, 15), Dropdown := True)
   

     myComboBox = dlg.CreateComboBox('ComboBox1', (20, 20, 60, 15), Dropdown = True)
   

CreateCurrencyField

Opprett en ny kontroll av typen CurrencyField i den gjeldende dialogboksen.

svc.CreateCurrencyField(ControlName: str, Place: any, Border ="3D", SpinButton: bool = False, MinValue: num = -1000000, MaxValue: num = +1000000, Increment: num = 1, Accuracy: num = 2): svc

Kantlinjer: "3D" (standard) eller "FLAT" eller "INGEN"

SpinButton: når Sann (standard = Usann), er det en spin-knapp

MinValue: den minste verdien som kan angis i kontrollen. Standard = -1000000

MaxValue: den største verdien som kan angis i kontrollen. Standard = +1000000

Inkrement: trinnet når spinnknappen trykkes. Standard = 1

Nøyaktighet: angir desimalnøyaktigheten. Standard = 2 desimaler

     Set myCurrencyField = oDlg.CreateCurrencyField("CurrencyField1", Array(20, 20, 60, 15), SpinButton := True)
   

     myCurrencyField = dlg.CreateCurrencyField('CurrencyField1', (20, 20, 60, 15), SpinButton = True)
   

CreateDateField

Opprett en ny kontroll av typen DateField i den gjeldende dialogboksen.

svc.CreateDateField(ControlName: str, Place: any, Border: str = "3D", DropDown: bool = False, opt MinDate: datetime, opt MaxDate: datetime): svc

Kantlinjer: "3D" (standard) eller "FLAT" eller "INGEN"

DropDown: når Sann (standard = Usann), vises en rullegardinknapp

MinDate: den minste datoen som kan legges inn i kontrollen. Standard = 1900-01-01

MaxDate: den største datoen som kan legges inn i kontrollen. Standard = 2200-12-31

     Set myDateField = oDlg.CreateDateField("DateField1", Array(20, 20, 60, 15), Dropdown := True)
   

     myDateField = dlg.CreateDateField('DateField1', (20, 20, 60, 15), Dropdown = True)
   

CreateFileControl

Opprett en ny kontroll av typen FileControl i den gjeldende dialogboksen.

svc.CreateFileControl(ControlName: str, Place: any, Border: str = "3D"): svc

Kantlinjer: "3D" (standard) eller "FLAT" eller "INGEN"

     Set myFileControl = oDlg.CreateFileControl("FileControl1", Array(20, 20, 60, 15))
   

     myFileControl = dlg.CreateFileControl('FileControl1', (20, 20, 60, 15))
   

CreateFixedLine

Opprett en ny kontroll av typen FixedLine i den gjeldende dialogboksen.

svc.CreateFixedLine(ControlName: str, Place: any, Orientation: str): svc

Retning: "H[orisontal]" eller "V[ertikal]".

     Set myFixedLine = oDlg.CreateFixedLine("FixedLine1", Array(20, 20, 60, 15), Orientation := "vertical")
   

     myFixedLine = dlg.CreateFixedLine('FixedLine1', (20, 20, 60, 15), Orientation = 'vertical')
   

CreateFixedText

Opprett en ny kontroll av typen FixedText i den gjeldende dialogboksen.

svc.CreateFixedText(ControlName: str, Place: any, Border: str = "3D", MultiLine: bool = False, Align: str = "LEFT", VerticalAlign: str = "TOP"): svc

Kantlinjer: "INGEN" (standard) eller "FLAT" eller "3D"

Flerlinje: Når Sann (standard = Usann), kan bildeteksten vises på mer enn én linje

Juster: horisontal justering, "VENSTRE" (standard) eller "SENTER" eller "HØYRE"

VerticalAlign: vertikal justering, "TOPP" (standard) eller "MIDT" eller "BUNN"

     Set myFixedText = oDlg.CreateFixedText("FixedText1", Array(20, 20, 60, 15), MultiLine := True)
   

     myFixedText = dlg.CreateFixedText('FixedText1', (20, 20, 60, 15), MultiLine = True)
   

CreateFormattedField

Opprett en ny kontroll av typen FormattedField i den gjeldende dialogboksen.

svc.CreateFormattedField(ControlName: str, Place: any, Border: str = "3D", SpinButton: bool = False, MinValue: num = -1000000, MaxValue: num = +1000000): svc

Kantlinjer: "3D" (standard) eller "FLAT" eller "INGEN"

SpinButton: når Sann (standard = Usann), er det en spin-knapp

MinValue: den minste verdien som kan angis i kontrollen. Standard = -1000000

MaxValue: den største verdien som kan angis i kontrollen. Standard = +1000000

     Set myFormattedField = oDlg.CreateFormattedField("FormattedField1", Array(20, 20, 60, 15), SpinButton := True)
   

     myFormattedField = dlg.CreateFormattedField('FormattedField1', (20, 20, 60, 15), SpinButton = True)
   

CreateGroupBox

Opprett en ny kontroll av typen GroupBox i den gjeldende dialogboksen.

svc.CreateGroupBox(ControlName: str, Place: any): svc

     Set myGroupBox = oDlg.CreateGroupBox("GroupBox1", Array(20, 20, 60, 15))
   

     myGroupBox = dlg.CreateGroupBox('GroupBox1', (20, 20, 60, 15))
   

CreateHyperlink

Opprett en ny kontroll av typen Hyperkobling i den gjeldende dialogboksen.

svc.CreateHyperlink(ControlName: str, Place: any, Border: str = "NONE", MultiLine: bool = False, Align: str = "LEFT", VerticalAlign: str = "TOP"): svc

Kantlinjer: "INGEN" (standard) eller "FLAT" eller "3D"

MultiLine: Når Sann (standard = Usann), kan bildeteksten vises på mer enn én linje

Juster: horisontal justering, "VENSTRE" (standard) eller "SENTER" eller "HØYRE"

VerticalAlign: vertikal justering, "TOPP" (standard) eller "MIDT" eller "BUNN"

     Set myHyperlink = oDlg.CreateHyperlink("Hyperlink1", Array(20, 20, 60, 15), MultiLine := True)
   

     myHyperlink = dlg.CreateHyperlink('Hyperlink1', (20, 20, 60, 15), MultiLine = True)
   

CreateImageControl

Opprett en ny kontroll av typen ImageControl i den gjeldende dialogboksen.

svc.CreateImageControl(ControlName: str, Place: any, Border: str = "3D", Scale: str = "FITTOSIZE"): svc

Kantlinje: "3D" (standard) eller "FLAT" eller "INGEN"

Skala: En av de neste verdiene: "FITTOSIZE" (standard), "KEEPRATIO" eller "NO"

     Set myImageControl = oDlg.CreateImageControl("ImageControl1", Array(20, 20, 60, 15))
   

       myImageControl = dlg.CreateImageControl('ImageControl1", (20, 20, 60, 15))
   

CreateListBox

Opprett en ny kontroll av typen ListBox i den gjeldende dialogboksen.

svc.CreateListBox(ControlName: str, Place: any, Border: str = "3D", DropDown: bool = True, LineCount: num = 5, MultiSelect: bool = False): svc

Kantlinjer: "3D" (standard) eller "FLAT" eller "INGEN"

DropDown: Når Sann (standard), vises en rullegardinknapp

LineCount: Spesifiserer det maksimale linjeantallet som vises i rullegardinmenyen (standard = 5)

MultiSelect: Når Sann, kan mer enn 1 oppføring velges. Standard = Usann

     Set myListBox = oDlg.CreateListBox("ListBox1", Array(20, 20, 60, 15), Dropdown := True, MultiSelect := True)
   

     myListBox = dlg.CreateListBox('ListBox1', (20, 20, 60, 15), Dropdown = True, MultiSelect = True)
   

CreateNumericField

Opprett en ny kontroll av typen NumericField i den gjeldende dialogboksen.

svc.CreateNumericField(ControlName: str, Place: any, Border: str = "3D", SpinButton: bool = False, MinValue: num = -1000000, MaxValue: num = 1000000, Increment: num = 1, Accuracy: num = 2): svc

Kantlinjer: "3D" (standard) eller "FLAT" eller "INGEN"

SpinButton: når Sann (standard = Usann), er det en spin-knapp

MinValue: den minste verdien som kan angis i kontrollen. Standard = -1000000

MaxValue: den største verdien som kan angis i kontrollen. Standard = +1000000

Inkrement: trinnet når spinnknappen trykkes. Standard = 1

Nøyaktighet: angir desimalnøyaktigheten. Standard = 2 desimaler

     Set myNumericField = oDlg.CreateNumericField("NumericField1", Array(20, 20, 60, 15), SpinButton := True)
   

     myNumericField = dlg.CreateNumericField('NumericField1', (20, 20, 60, 15), SpinButton = True)
   

CreatePatternField

Opprett en ny kontroll av typen PatternField i den gjeldende dialogboksen.

svc.CreatePatternField(ControlName: str, Place: any, Border: str = "3D", EditMask: str, opt LiteralMax: str): svc

Kantlinjer: "3D" (standard) eller "FLAT" eller "INGEN"

EditMask: en tegnkode som bestemmer hva brukeren kan skrive inn
Se Pattern_Field i wikien for mer informasjon.

LiteralMask: inneholder startverdiene som vises i mønsterfeltet

     Set myPatternField = oDlg.CreatePatternField("PatternField1", Array(20, 20, 60, 15), EditMask := "NNLNNLLLLL", LiteralMask := "__.__.2002")
   

     myPatternField = dlg.CreatePatternField('PatternField1', (20, 20, 60, 15), EditMask = 'NNLNNLLLLL', LiteralMask = '__.__.2002')
   

CreateProgressBar

Opprett en ny kontroll av typen ProgressBar i den gjeldende dialogboksen.

svc.CreateProgressBar(ControlName: str, opt Place: any, Border: str = "3D", MinValue: num = 0, MaxValue: num = 100): svc

Kantlinjer: "3D" (standard) eller "FLAT" eller "INGEN"

MinValue: den minste verdien som kan angis i kontrollen. Standard = 0

MaxValue: den største verdien som kan angis i kontrollen. Standard = 100

     Set myProgressBar = oDlg.CreateProgressBar("ProgressBar1", Array(20, 20, 60, 15), MaxValue := 1000)
   

     myProgressBar = dlg.CreateProgressBar('ProgressBar1', (20, 20, 60, 15), MaxValue = 1000)
   

CreateRadioButton

Opprett en ny kontroll av typen RadioButton i den gjeldende dialogboksen.

svc.CreateRadioButton(ControlName: str, Place: any, MultiLine: bool = False): svc

MultiLine: Når Sann (standard = Usann), kan bildeteksten vises på mer enn én linje

     Set myRadioButton = oDlg.CreateRadioButton("RadioButton1", Array(20, 20, 60, 15), MultiLine := True)
   

     myRadioButton = dlg.CreateRadioButton('RadioButton1', (20, 20, 60, 15), MultiLine = True)
   

CreateScrollBar

Opprett en ny kontroll av typen ScrollBar i den gjeldende dialogboksen.

svc.CreateScrollBar(ControlName: str, Place, Orientation: str, Border: str = "3D", MinValue: num = 0, MaxValue: num = 100): svc

Retning: Horisontal] eller Vertikal]

Kantlinjer: "3D" (standard) eller "FLAT" eller "INGEN"

MinValue: den minste verdien som kan angis i kontrollen. Standard = 0

MaxValue: den største verdien som kan angis i kontrollen. Standard = 100

     Set myScrollBar = oDlg.CreateScrollBar("ScrollBar1", Array(20, 20, 60, 15), MaxValue := 1000)
   

     myScrollBar = dialog.CreateScrollBar('ScrollBar1', (20, 20, 60, 15), MaxValue = 1000)
   

CreateTableControl

Opprett en ny kontroll av typen TableControl i den gjeldende dialogboksen.

svc.CreateTableControl(ControlName: str, Place: any, Border: str = "3D", RowHeaders: bool = True, ColumnHeaders: bool = True, ScrollBars: str = "N", GridLines: bool = False): svc

Kantlinjer: "3D" (standard) eller "FLAT" eller "INGEN"

RowHeaders: når Sann (standard), vises radoverskriftene

ColumnHeaders: når Sann (standard), vises kolonneoverskriftene

ScrollBars: H[orizontal] eller V[ertikal] eller B[egge] eller N[one, Ingen] (standard). Rullefelt vises dynamisk når de er nødvendige.

GridLines: når Sann (standard = Usann) horisontale og vertikale linjer tegnes opp mellom rutenettcellene

     Set myTableControl = oDlg.CreateTableControl("TableControl1", Array(20, 20, 60, 15), ScrollBars := "B")
   

     myTableControl = dlg.CreateTableControl('TableControl1', (20, 20, 60, 15), ScrollBars = 'B')
   

CreateTextField

Opprett en ny kontroll av typen Tekstfelt i den gjeldende dialogboksen.

svc.CreateTextField(ControlName: str, Place: any, Border: str = "3D", MultiLine: bool = False, MaximumLength: num = 0, PasswordCharacter: str = ""): svc

Kantlinjer: "3D" (standard) eller "FLAT" eller "INGEN"

MultiLine: Når Sann (standard = Usann), kan bildeteksten vises på mer enn én linje

MaximumLength: maksimalt antall tegn (standard = 0 betyr ubegrenset)

Passordtegn: et enkelt tegn som spesifiserer ekkoet for et passordtekstfelt (standard = "")

Set myTextField = oDlg.CreateTextField("TextField1", Array(20, 20, 120, 50), MultiLine := True)
   

     myTextField = dlg.CreateTextField('TextField1', (20, 20, 120, 50), MultiLine = True)
   

CreateTimeField

Opprett en ny kontroll av typen TimeField i den gjeldende dialogboksen.

svc.CreateTimeField(ControlName: str, Place: any, Border: str = "3D", MinTime: num = 0, MaxTime: num = 24): svc

Kantlinjer: "3D" (standard) eller "FLAT" eller "INGEN"

MinTime: den minste tiden som kan angis i kontrollen. Standard = 0

MaxTime: den lengste tiden som kan angis i kontrollen. Standard = 24 timer

     Set myTimeField = oDlg.CreateTimeField("TimeField1", Array(20, 20, 60, 15))
   

     myTimeField = dlog.CreateTimeField('TimeField1', (20, 20, 60, 15))
   

CreateTreeControl

Opprett en ny kontroll av typen TreeControl i den gjeldende dialogboksen.

svc.CreateTreeControl(ControlName: str, Place: any, Border = "3D"): svc

Kantlinjer: "3D" (standard) eller "FLAT" eller "INGEN"

     Set myTreeControl = oDlg.CreateTreeControl("TreeControl1", Array(20, 20, 60, 15))
   

     myTreeControl = dlg.CreateTreeControl('TreeControl1', (20, 20, 60, 15))
   

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.

      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
   

     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 LibreOffice 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.

OrderTabs

Angi tabuleringsindeksen for en rekke kontroller. Sekvensen av kontroller er gitt som en rekke kontrollnavn fra den første til den siste.

Kontroller med en indeks >= 1 er ikke tilgjengelige med TAB-tasten hvis:
- de er utelatt fra den gitte listen
- typen deres er FixedLine, GroupBox eller ProgressBar
- de er deaktivert

svc.TabsList(TabsList: num, Start: num = 1, Increment: num = 1): bool

TabsList: en rekke gyldige kontrollnavn i tabuleringsrekkefølgen

Start: faneindeksen som skal tilordnes til den første kontrollen i listen. Standard = 1

Inkrement: forskjellen mellom to påfølgende faneindekser. Standard = 1

Sann når vellykket.

     oDlg.OrderTabs(Array("myListBox", "myTextField", "myNumericField"), Start := 10)
   

     dlg.OrderTabs(('myListBox', 'myTextField', 'myNumericField'), Start = 10)
   

Resize

Flytter det øverste venstre hjørnet av en dialogboks til nye koordinater og/eller endrer dimensjonene. Alle avstander er uttrykt i AppFont-enheter. Uten argumenter tilbakestiller metoden de opprinnelige dimensjonene. Returner Sann 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

Manglende argumenter forblir uendret

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

     dlg.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.

• Sekvens 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.

    oDlg.SetPageManager(PilotControls := "aPageList", _
                           WizardControls := "btnPrevious,btnNext", _
                           LastPage := 3)
    oDlg.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()
   

     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.