Hilfe für LibreOffice 24.8
Der Dienst Dialog trägt zur Verwaltung von Dialogen bei, die mit dem Dialogeditor Basic erstellt wurden, oder von Dialogen, die im laufenden Betrieb erstellt wurden. Jede Instanz der aktuellen Klasse stellt einen einzelnen Dialog dar, der dem Benutzer angezeigt wird.
Der Dialog kann im modalen oder im nicht-modalen Modus angezeigt werden.
Im modalen Modus wird das Feld angezeigt und die Ausführung des Makroprozesses ausgesetzt, bis eine der Schaltflächen „OK“ oder „Abbrechen“ gedrückt wird. In der Zwischenzeit können auf der Box ausgeführte Benutzeraktionen bestimmte Aktionen auslösen.
Im nicht-modalen Modus „schwebt“ der Dialog auf dem Desktop des Benutzers und die Ausführung des Makroprozesses wird normal fortgesetzt. Der nicht-modale Dialog wird geschlossen, wenn er mit der Methode Terminate() beendet wird oder wenn die LibreOffice-Sitzung endet. Die Schaltfläche zum Schließen des Fensters ist in nicht-modalen Dialogen inaktiv.
Der Dialog verschwindet nach seiner expliziten Beendigung aus dem Speicher.
Der Dienst SFDialogs.Dialog ist eng mit dem Dienst SFDialogs.DialogControl verwandt.
Vor der Verwendung des Dienstes Dialog muss die Bibliothek ScriptForge geladen oder importiert werden:
Der Dienst Dialog wird über die Methode CreateScriptService aufgerufen. Er erfordert drei zusätzliche Positionsargumente, um den zu aktivierende Dialog anzugeben:
Container: "GlobalScope" für vorinstallierte Bibliotheken oder ein Fenstername wie vom Dienst ScriptForge.UI definiert. Der Standardwert leere Zeichenfolge "" steht für das aktuelle Dokument.
Library: Der Name einer im Container enthaltenen Bibliothek, bei der die Groß-/Kleinschreibung beachtet wird. Der Standardwert ist "Standard".
DialogName: Eine Zeichenfolge mit Berücksichtigung der Groß-/Kleinschreibung, die den Dialog bezeichnet.
Die folgenden Beispiele in Basic und Python zeigen den Dialog dlgConsole, der zur gemeinsam genutzten Bibliothek ScriptForge gehört:
      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")
      ' … Steuerungsinitialisierung startet hier …
      lButton = oDlg.Execute()
      ' Standardmodus = Modal
      If lButton = oDlg.OKBUTTON Then
      ' … Prozesskontrollen und erledigen, was hier nötig ist
      End If
      oDlg.Terminate()
  Oder mit Python:
    dlg = CreateScriptService('SFDialogs.Dialog', 'GlobalScope', 'ScriptForge', 'dlgConsole')
    # … Steuerungsinitialisierung startet hier …
    rc = dlg.Execute()
    # Standardmodus ist Modal
    if rc == dlg.OKBUTTON:
        # … Prozesskontrollen und erledigen, was hier nötig ist
    dlg.Terminate()
  Verwenden Sie die Zeichenfolge "GlobalScope" als Argument container, wenn der Dialog entweder in oder in gespeichert ist.
Der Dienst "Dialog" bietet Methoden, die dynamisch neue Steuerelemente in einem vorhandenen Dialog erstellen, der mit dem Dialogeditor vordefiniert ist. Ein Dialog wird mit Steuerelementen im Dialogeditor initialisiert und neue Steuerelemente können zur Laufzeit vor oder nach der Anweisung Execute() des Dialogs hinzugefügt werden.
Der Dienst Dialog kann auch über die Methode CreateScriptService aufgerufen werden, wenn Dialoge im laufenden Betrieb erstellt werden. Es sind zwei zusätzliche Positionsargumente nach dem Namen des Ad-hoc-Dienstes "NewDialog" erforderlich:
DialogName: Eine Zeichenfolge mit Berücksichtigung der Groß-/Kleinschreibung, die den Dialog bezeichnet.
Place: Fensterposition des Dialogs, entweder:
eine Basic-Matrix oder ein Python-Tupel mit 4 Elementen: (X, Y, Breite, Höhe)
ein Objekt com.sun.star.awt.Rectangle [X, Y, Breite, Höhe]
Alle Elemente werden in Einheiten Map AppFont ausgedrückt.
    Sub newDialog()
        Dim oDlg As Object
       oDlg = CreateScriptService("NewDialog", "myDialog1", Array(100,200, 40, 110))
       ' ...
    End Sub
  Oder mit Python:
    def newDialog():
       dlg = CreateScriptService('NeuerDialog', 'meinDialog1', (100, 200, 40, 110))
       # … Prozesskontrollen und erledigen, was nötig ist
  Für solche neuen Dialoge stehen alle Eigenschaften und Methoden zur Verfügung, die für vordefinierte Dialoge gelten. Insbesondere die Reihe der Methoden CreateXXX() zum Hinzufügen neuer Dialogsteuerelemente.
Eine Instanz des Dienstes Dialog kann über den Dienst SFDialogs.DialogEvent abgerufen werden, sofern der Dialog mit dem Dienst Dialog initiiert wurde. Im Beispiel unten enthält oDlg die Instanz Dialog, die das Dialogereignis ausgelöst hat.
    Sub aDialogEventHander(ByRef poEvent As Object)
        Dim oDlg As Object
        Set oDlg = CreateScriptService("SFDialogs.DialogEvent", poEvent)
        ' ...
    End Sub
  Oder mit Python:
    def control_event_handler(event: uno):
        dlg = CreateScriptService("SFDialogs.DialogEvent", event)
        # ...
  Beachten Sie, dass in den vorherigen Beispielen das Präfix "SFDialogs." weggelassen werden kann, wenn es angebracht erscheint.
Beim Erstellen einer Ereignisbehandlungsroutine für Dialogereignisse empfiehlt es sich, Fehler innerhalb der Subroutine selbst zu behandeln. Angenommen, der unten stehende Ereignishandler wird aufgerufen, wenn die Maustaste im Dialogfenster gedrückt wird.
    Sub OnMouseButtonPressed(ByRef oEvent As Object)
    On Local Error GoTo Catch
        Dim oDialog As Object
        oDialog = CreateScriptService("DialogEvent", oEvent)
        ' Das Ereignis verarbeiten
        Exit Sub
    Catch:
        MsgBox SF_Exception.Description
        SF_Exception.Clear
    End Sub
  Rufen Sie SF_Exception.Clear auf, wenn Sie nicht möchten, dass der Fehler nach Beendigung der Dialogausführung weitergegeben wird.
Verwenden Sie in Python native Blöcke try/except für die Ausnahmebehandlung, wie unten gezeigt:
    def on_mouse_button_pressed(event=None):
        try:
            dlg = CreateScriptService("DialogEvent", event)
            # Verarbeite das Ereignis
        except Exception as e:
            # Das Objekt "bas" ist eine Instanz des Dienstes Basic
            bas.MsgBox(str(e))
  | Name | Schreibgeschützt | Typ | Beschreibung | 
|---|---|---|---|
| OKBUTTON | Ja | Integer | Wert = 1. Die Schaltfläche "OK" wurde gedrückt. | 
| CANCELBUTTON | Ja | Integer | Wert = 0. Die Schaltfläche "Abbrechen" wurde gedrückt. | 
| Caption | Nein | String | Legt den Titel des Dialogs fest. | 
| Height | Nein | Long | Legt die Höhe des Dialogs fest. | 
| Modal | Ja | Boolean | Legt fest, ob der Dialog derzeit im modalen Modus ausgeführt wird. | 
| Name | Ja | String | Der Name des Dialogs | 
| Page | Nein | Integer | Der Dialog kann mehrere Seiten haben, die vom Benutzer Schritt für Schritt durchlaufen werden können. Die Eigenschaft "Page" des Objekts "Dialog" definiert, welche Seite des Dialogs aktiv ist. | 
| Visible | Nein | Boolean | Legt fest, ob der Dialog auf dem Desktop sichtbar ist. Standardmäßig ist er nicht sichtbar, bis die Methode "Execute()" ausgeführt wird und danach sichtbar ist. | 
| XDialogModel | Ja | UNO | Das UNO-Objekt, welches das Dialogmodell darstellt. Siehe XControlModel und UnoControlDialogModel in der Programmierschnittstelle (API). | 
| XDialogView | Ja | UNO | Das UNO-Objekt, das die Dialogansicht darstellt. Siehe XControl und UnoControlDialog in der Dokumentation der Programmierschnittstelle (API) für detaillierte Informationen. | 
| Width | Nein | Long | Legt die Breite des Dialogs fest. | 
Eigenschaften On… geben eine URI-Zeichenfolge mit der Bezug zu dem durch das Ereignis ausgelöste Skript zurück. Eigenschaften On… können programmgesteuert festgelegt werden.
Lesen Sie die Spezifikation unter scripting framework URI specification.
| Name | Lesen/Schreiben | Basic-IDE-Beschreibung | 
|---|---|---|
| OnFocusGained | Ja | Beim Erhalten des Fokus | 
| OnFocusLost | Ja | Beim Verlust des Fokus | 
| OnKeyPressed | Ja | Beim Tastendruck | 
| OnKeyReleased | Ja | Beim Taste loslassen | 
| OnMouseDragged | Ja | Bei Mausbewegung während Tastedruck | 
| OnMouseEntered | Ja | Maus hinein | 
| OnMouseExited | Ja | Maus heraus | 
| OnMouseMoved | Ja | Mausbewegung | 
| OnMousePressed | Ja | Mausklick | 
| OnMouseReleased | Ja | Maustaste lösen | 
Das Zuweisen von Ereignissen über die Basic-IDE und das Zuweisen von Ereignissen über Makros schließen sich gegenseitig aus.
Die Bemaßung eines Dialogs erfolgt mittels Einheiten Map AppFont. Ein Dialog- oder Steuerungsmodell verwendet auch Einheiten AppFont, während ihre Ansichten Pixel verwenden.
Setzt den Fokus auf die aktuelle Instanz von Dialog. Gib True zurück, wenn die Fokussierung erfolgreich war.
Diese Methode wird von einem Dialog- oder Steuerereignis aufgerufen oder wenn ein Dialog im nicht-modalen Modus angezeigt wird.
svc.Activate(): bool
      Dim oDlg As Object
      Set oDlg = CreateScriptService(,, "myDialog")
      oDlg.Execute()
      ' ...
      oDlg.Activate()
   Python- und LibreOffice Basic-Beispiele setzen beide voraus, dass der Dialog in der Bibliothek Standard des aktuellen Dokuments gespeichert ist.
     dlg = CreateScriptService(,,'myDialog')
     dlg.Execute()
     # ...
     dlg.Activate()
   Zentriert den aktuellen Dialog in der Mitte eines übergeordneten Fensters. Ohne Argumente zentriert die Methode den Dialog in der Mitte des aktuellen Fensters.
Gibt bei Erfolg True zurück.
svc.Center(opt Parent: obj): bool
Parent: Ein optionales Objekt …
ein Dialog "ScriptForge"
ein Dokument (Calc, Base, …) "ScriptForge"
     Sub TriggerEvent(oEvent As Object)
         Dim oDialog1 As Object, oDialog2 As Object, lExec As Long
         Set oDialog1 = CreateScriptService("DialogEvent", oEvent) ' Der Dialog, der das Ereignis verursacht hat
         Set oDialog2 = CreateScriptService("Dialog", …) ' Öffnet einen zweiten Dialog
         oDialog2.Center(oDialog1)
         lExec = oDialog2.Execute()
         Select Case lExec
             ...
     End Sub
  
     def triggerEvent(event: uno):
       dlg1 = CreateScriptService('DialogEvent.Dialog', event) # Der Dialog, der das Ereignis verursacht hat
       dlg2 = CreateScriptService('Dialog', …)  # Öffnet einen zweiten Dialog
       dlg2.Center(dlg1)
       rc = dlg2.Execute()
       if rc is False:
         # ...
   Vervielfältigt ein vorhandenes Steuerelement eines beliebigen Typs im aktuellen Dialog. Das vervielfältigte Steuerelement bleibt unverändert und kann verschoben werden.
svc.CloneControl(SourceName: str, ControlName: str, Left: num, Top: num): svc
SourceName: Der Name des zu vervielfältigen Steuerelements.
ControlName: Ein gültiger Steuerelementname als Zeichenfolge, bei der die Groß-/Kleinschreibung beachtet wird. Es darf noch nicht existieren.
Left, Top: Die Koordinaten des neuen Steuerelements, ausgedrückt in Einheiten Map AppFont.
      Set myButton2 = oDlg.CloneControl("Button1", "Button2", 30, 30)
   
     dlg = dlg.CloneControl('Button1', 'Button2', 30, 30)
   Rückgabe:
die Liste der im Dialog enthaltenen Steuerelemente
eine Klasseninstanz von DialogControl basierend auf ihrem Namen
svc.Controls(): str[0..*]
svc.Controls(controlname: str): svc
ControlName: Ein gültiger Steuerelementname als Zeichenfolge mit Beachtung der Groß-/Kleinschreibung. Wenn nicht vorhanden, wird die Liste der Steuerelementnamen als nullbasierte Matrix zurückgegeben.
      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')
   Erstellt im aktuellen Dialog ein neues Steuerelement vom Typ Button.
svc.CreateButton(ControlName: str, Place: any, Toggle: bool = False, Push: str = ""): svc
ControlName: der Name des neuen Steuerelements. Er darf noch nicht existieren.
Place: entweder …
eine Basic-Matrix oder ein Python-Tupel mit 4 Elementen: (X, Y, Breite, Höhe)
ein Objekt com.sun.star.awt.Rectangle [X, Y, Breite, Höhe]
Alle Elemente werden in Einheiten Map AppFont ausgedrückt.
Toggle: Wenn True, wird eine Schaltfläche zum Umschalten erstellt. Standard = False
Push: "OK", "CANCEL" oder "" (Standard)
Eine Instanz des Dienstes SFDialogs.DialogControl oder Nothing.
     Set myButton = oDlg.CreateButton("Button1", Array(20, 20, 60, 15))
   
     myButton = dlg.CreateButton('Button1', (20, 20, 60, 15))
   Erstellt im aktuellen Dialog ein neues Steuerelement vom Typ CheckBox.
svc.CreateCheckBox(ControlName: str, Place: any, Multiline: bool = False): svc
MultiLine: Wenn True (Standard = False), kann die Beschriftung in mehr als einer Zeile angezeigt werden.
     Set myCheckBox = oDlg.CreateCheckBox("CheckBox1", Array(20, 20, 60, 15), MultiLine := True)
   
     myCheckBox = dlg.CreateCheckBox('CheckBox1', (20, 20, 60, 15), MultiLine = True)
   Erstellt im aktuellen Dialog ein neues Steuerelement vom Typ ComboBox.
svc.CreateComboBox(ControlName: str, Place: any, Border: str = "3D", DropDown: bool = True, LineCount: num = 5): svc
Border: "3D" (Standard), "FLAT" oder "NONE"
DropDown: Wenn True (Standard), wird eine Dropdown-Schaltfläche angezeigt
LineCount: Gibt die maximale Zeilenanzahl an, die im Dropdown-Menü angezeigt wird (Standard = 5)
     Set myComboBox = oDlg.CreateComboBox("ComboBox1", Array(20, 20, 60, 15), Dropdown := True)
   
     myComboBox = dlg.CreateComboBox('ComboBox1', (20, 20, 60, 15), Dropdown = True)
   Erstellt im aktuellen Dialog ein neues Steuerelement vom Typ CurrencyField.
svc.CreateCurrencyField(ControlName: str, Place: any, Border ="3D", SpinButton: bool = False, MinValue: num = -1000000, MaxValue: num = +1000000, Increment: num = 1, Accuracy: num = 2): svc
Border: "3D" (Standard), "FLAT" oder "NONE"
SpinButton: Wenn True (Standard = False), ist eine Drehfeld-Schaltfläche vorhanden
MinValue: der kleinste Wert, der in das Steuerelement eingegeben werden kann. Standard = -1000000
MaxValue: der größte Wert, der in das Steuerelement eingegeben werden kann. Standard = +1000000
Increment: die Schrittweite, wenn die Drehfeld-Schaltfläche gedrückt wird. Standard = 1
Accuracy: Gibt die Dezimalgenauigkeit an. Standard = 2 Dezimalstellen
     Set myCurrencyField = oDlg.CreateCurrencyField("CurrencyField1", Array(20, 20, 60, 15), SpinButton := True)
   
     myCurrencyField = dlg.CreateCurrencyField('CurrencyField1', (20, 20, 60, 15), SpinButton = True)
   Erstellt im aktuellen Dialog ein neues Steuerelement vom Typ DateField.
svc.CreateDateField(ControlName: str, Place: any, Border: str = "3D", DropDown: bool = False, opt MinDate: datetime, opt MaxDate: datetime): svc
Border: "3D" (Standard), "FLAT" oder "NONE"
DropDown: Wenn True (Standard = False), wird eine Dropdown-Schaltfläche angezeigt
MinDate: das kleinste Datum, das in das Steuerelement eingegeben werden kann. Standard = 01.01.1900
MaxDate: das größte Datum, das in das Steuerelement eingegeben werden kann. Standard = 31.12.2200
     Set myDateField = oDlg.CreateDateField("DateField1", Array(20, 20, 60, 15), Dropdown := True)
   
     myDateField = dlg.CreateDateField('DateField1', (20, 20, 60, 15), Dropdown = True)
   Erstellt im aktuellen Dialog ein neues Steuerelement vom Typ FileControl.
svc.CreateFileControl(ControlName: str, Place: any, Border: str = "3D"): svc
Border: "3D" (Standard), "FLAT" oder "NONE"
     Set myFileControl = oDlg.CreateFileControl("FileControl1", Array(20, 20, 60, 15))
   
     myFileControl = dlg.CreateFileControl('FileControl1', (20, 20, 60, 15))
   Erstellt im aktuellen Dialog ein neues Steuerelement vom Typ FixedLine.
svc.CreateFixedLine(ControlName: str, Place: any, Orientation: str): svc
Orientation: Für die horizontale Ausrichtung verwenden Sie „H“ oder „Horizontal“; Für die vertikale Ausrichtung verwenden Sie „V“ oder „Vertical“.
     Set myFixedLine = oDlg.CreateFixedLine("FixedLine1", Array(20, 20, 60, 15), Orientation := "vertical")
   
     myFixedLine = dlg.CreateFixedLine('FixedLine1', (20, 20, 60, 15), Orientation = 'vertical')
   Erstellt im aktuellen Dialog ein neues Steuerelement vom Typ FixedText.
svc.CreateFixedText(ControlName: str, Place: any, Border: str = "3D", MultiLine: bool = False, Align: str = "LEFT", VerticalAlign: str = "TOP"): svc
Border: "NONE" (Standard), "FLAT" oder "3D"
Multiline: Wenn True (Standard = False), kann die Beschriftung in mehr als einer Zeile angezeigt werden
Align: horizontale Ausrichtung, "LEFT" (Standard), "CENTER" oder "RIGHT"
VerticalAlign: vertikale Ausrichtung, "TOP" (Standard), "MIDDLE" oder "BOTTOM"
     Set myFixedText = oDlg.CreateFixedText("FixedText1", Array(20, 20, 60, 15), MultiLine := True)
   
     myFixedText = dlg.CreateFixedText('FixedText1', (20, 20, 60, 15), MultiLine = True)
   Erstellt im aktuellen Dialog ein neues Steuerelement vom Typ FormattedField.
svc.CreateFormattedField(ControlName: str, Place: any, Border: str = "3D", SpinButton: bool = False, MinValue: num = -1000000, MaxValue: num = +1000000): svc
Border: "3D" (Standard), "FLAT" oder "NONE"
SpinButton: Wenn True (Standard = False), ist eine Drehfeld-Schaltfläche vorhanden
MinValue: der kleinste Wert, der in das Steuerelement eingegeben werden kann. Standard = -1000000
MaxValue: der größte Wert, der in das Steuerelement eingegeben werden kann. Standard = +1000000
     Set myFormattedField = oDlg.CreateFormattedField("FormattedField1", Array(20, 20, 60, 15), SpinButton := True)
   
     myFormattedField = dlg.CreateFormattedField('FormattedField1', (20, 20, 60, 15), SpinButton = True)
   Erstellt im aktuellen Dialog ein neues Steuerelement vom Typ GroupBox.
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))
   Erstellt im aktuellen Dialog ein neues Steuerelement vom Typ Hyperlink.
svc.CreateHyperlink(ControlName: str, Place: any, Border: str = "NONE", MultiLine: bool = False, Align: str = "LEFT", VerticalAlign: str = "TOP"): svc
Border: "NONE" (Standard), "FLAT" oder "3D"
MultiLine: Wenn True (Standard = False), kann die Beschriftung in mehr als einer Zeile angezeigt werden
Align: horizontale Ausrichtung, "LEFT" (Standard), "CENTER" oder "RIGHT"
VerticalAlign: vertikale Ausrichtung, "TOP" (Standard), "MIDDLE" oder "BOTTOM"
     Set myHyperlink = oDlg.CreateHyperlink("Hyperlink1", Array(20, 20, 60, 15), MultiLine := True)
   
     myHyperlink = dlg.CreateHyperlink('Hyperlink1', (20, 20, 60, 15), MultiLine = True)
   Erstellt im aktuellen Dialog ein neues Steuerelement vom Typ ImageControl.
svc.CreateImageControl(ControlName: str, Place: any, Border: str = "3D", Scale: str = "FITTOSIZE"): svc
Border: "3D" (Standard), "FLAT" oder "NONE"
Scale: Einer der folgenden Werte: "FITTOSIZE" (Standard), "KEEPRATIO" oder "NO"
     Set myImageControl = oDlg.CreateImageControl("ImageControl1", Array(20, 20, 60, 15))
   
       myImageControl = dlg.CreateImageControl('ImageControl1", (20, 20, 60, 15))
   Erstellt im aktuellen Dialog ein neues Steuerelement vom Typ ListBox.
svc.CreateListBox(ControlName: str, Place: any, Border: str = "3D", DropDown: bool = True, LineCount: num = 5, MultiSelect: bool = False): svc
Border: "3D" (Standard), "FLAT" oder "NONE"
DropDown: Wenn True (Standard), wird eine Dropdown-Schaltfläche angezeigt
LineCount: Gibt die maximale Zeilenanzahl an, die im Dropdown-Menü angezeigt wird (Standard = 5)
MultiSelect: Wenn True, kann mehr als ein Eintrag ausgewählt werden. Standard = False
     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)
   Erstellt im aktuellen Dialog ein neues Steuerelement vom Typ NumericField.
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
Border: "3D" (Standard), "FLAT" oder "NONE"
SpinButton: Wenn True (Standard = False), ist eine Drehfeld-Schaltfläche vorhanden
MinValue: der kleinste Wert, der in das Steuerelement eingegeben werden kann. Standard = -1000000
MaxValue: der größte Wert, der in das Steuerelement eingegeben werden kann. Standard = +1000000
Increment: die Schrittweite, wenn die Drehfeld-Schaltfläche gedrückt wird. Standard = 1
Accuracy: Gibt die Dezimalgenauigkeit an. Standard = 2 Dezimalstellen
     Set myNumericField = oDlg.CreateNumericField("NumericField1", Array(20, 20, 60, 15), SpinButton := True)
   
     myNumericField = dlg.CreateNumericField('NumericField1', (20, 20, 60, 15), SpinButton = True)
   Erstellt im aktuellen Dialog ein neues Steuerelement vom Typ PatternField.
svc.CreatePatternField(ControlName: str, Place: any, Border: str = "3D", EditMask: str, opt LiteralMax: str): svc
Border: "3D" (Standard), "FLAT" oder "NONE"
EditMask: ein Zeichencode, der bestimmt, was der Benutzer eingeben darf
Siehe Pattern_Field im Wiki für weitere Informationen.
LiteralMask: enthält die Anfangswerte, die im Musterfeld angezeigt werden
     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')
   Erstellt im aktuellen Dialog ein neues Steuerelement vom Typ ProgressBar.
svc.CreateProgressBar(ControlName: str, opt Place: any, Border: str = "3D", MinValue: num = 0, MaxValue: num = 100): svc
Border: "3D" (Standard), "FLAT" oder "NONE"
MinValue: der kleinste Wert, der in das Steuerelement eingegeben werden kann. Standard = 0
MaxValue: der größte Wert, der in das Steuerelement eingegeben werden kann. Standard = 100
     Set myProgressBar = oDlg.CreateProgressBar("ProgressBar1", Array(20, 20, 60, 15), MaxValue := 1000)
   
     myProgressBar = dlg.CreateProgressBar('ProgressBar1', (20, 20, 60, 15), MaxValue = 1000)
   Erstellt im aktuellen Dialog ein neues Steuerelement vom Typ RadioButton.
svc.CreateRadioButton(ControlName: str, Place: any, MultiLine: bool = False): svc
MultiLine: Wenn True (Standard = False), kann die Beschriftung in mehr als einer Zeile angezeigt werden
     Set myRadioButton = oDlg.CreateRadioButton("RadioButton1", Array(20, 20, 60, 15), MultiLine := True)
   
     myRadioButton = dlg.CreateRadioButton('RadioButton1', (20, 20, 60, 15), MultiLine = True)
   Erstellt im aktuellen Dialog ein neues Steuerelement vom Typ ScrollBar.
svc.CreateScrollBar(ControlName: str, Place, Orientation: str, Border: str = "3D", MinValue: num = 0, MaxValue: num = 100): svc
Orientation: Für die horizontale Ausrichtung verwenden Sie „H“ oder „Horizontal“; Für die vertikale Ausrichtung verwenden Sie „V“ oder „Vertical“.
Border: "3D" (Standard), "FLAT" oder "NONE"
MinValue: der kleinste Wert, der in das Steuerelement eingegeben werden kann. Standard = 0
MaxValue: der größte Wert, der in das Steuerelement eingegeben werden kann. Standard = 100
     Set myScrollBar = oDlg.CreateScrollBar("ScrollBar1", Array(20, 20, 60, 15), MaxValue := 1000)
   
     myScrollBar = dialog.CreateScrollBar('ScrollBar1', (20, 20, 60, 15), MaxValue = 1000)
   Erstellt im aktuellen Dialog ein neues Steuerelement vom Typ TableControl.
svc.CreateTableControl(ControlName: str, Place: any, Border: str = "3D", RowHeaders: bool = True, ColumnHeaders: bool = True, ScrollBars: str = "N", GridLines: bool = False): svc
Border: "3D" (Standard), "FLAT" oder "NONE"
RowHeaders: Wenn True (Standard), werden die Zeilenköpfe angezeigt
ColumnHeaders: Wenn True (Standard), werden die Spaltenköpfe angezeigt
ScrollBars: mögliche Werte sind: "H" oder "Horizontal" (horizontale Bildlaufleisten), "V" oder "Vertical" (vertikale Bildlaufleisten), "B" oder "Both" (beide Bildlaufleisten); "N" oder "None" (Standard) für keine Bildlaufleisten. Bildlaufleisten werden dynamisch angezeigt, wenn sie benötigt werden.
GridLines: Wenn True (Standard = False), werden horizontale und vertikale Linien zwischen den Gitterzellen gezeichnet
     Set myTableControl = oDlg.CreateTableControl("TableControl1", Array(20, 20, 60, 15), ScrollBars := "B")
   
     myTableControl = dlg.CreateTableControl('TableControl1', (20, 20, 60, 15), ScrollBars = 'B')
   Erstellt im aktuellen Dialog ein neues Steuerelement vom Typ TextField.
svc.CreateTextField(ControlName: str, Place: any, Border: str = "3D", MultiLine: bool = False, MaximumLength: num = 0, PasswordCharacter: str = ""): svc
Border: "3D" (Standard), "FLAT" oder "NONE"
MultiLine: Wenn True (Standard = False), kann die Beschriftung in mehr als einer Zeile angezeigt werden
MaximumLength: die maximale Zeichenanzahl (Standard = 0 bedeutet unbegrenzt)
PasswordCharacter: ein einzelnes Zeichen, welches den Rückgabewert für ein Passwort-Textfeld angibt (Standard = "")
Set myTextField = oDlg.CreateTextField("TextField1", Array(20, 20, 120, 50), MultiLine := True)
   
     myTextField = dlg.CreateTextField('TextField1', (20, 20, 120, 50), MultiLine = True)
   Erstellt im aktuellen Dialog ein neues Steuerelement vom Typ TimeField.
svc.CreateTimeField(ControlName: str, Place: any, Border: str = "3D", MinTime: num = 0, MaxTime: num = 24): svc
Border: "3D" (Standard), "FLAT" oder "NONE"
MinTime: die kleinste Zeit, die in das Steuerelement eingegeben werden kann. Standard = 0
MaxTime: die größte Zeit, die in das Steuerelement eingegeben werden kann. Standard = 24 Stunden
     Set myTimeField = oDlg.CreateTimeField("TimeField1", Array(20, 20, 60, 15))
   
     myTimeField = dlog.CreateTimeField('TimeField1', (20, 20, 60, 15))
   Erstellt im aktuellen Dialog ein neues Steuerelement vom Typ TreeControl.
svc.CreateTreeControl(ControlName: str, Place: any, Border = "3D"): svc
Border: "3D" (Standard), "FLAT" oder "NONE"
     Set myTreeControl = oDlg.CreateTreeControl("TreeControl1", Array(20, 20, 60, 15))
   
     myTreeControl = dlg.CreateTreeControl('TreeControl1', (20, 20, 60, 15))
   Beendet die Anzeige eines modalen Dialogs und gibt das Argument als Rückgabewert für die aktuell laufende Aktion Execute() zurück.
EndExecute() ist normalerweise in der Verarbeitung eines Makros enthalten, das durch ein Dialog- oder Steuerereignis ausgelöst wird.
svc.EndExecute(returnvalue: int)
returnvalue: Der Wert, der an die laufende Methode Execute() übergeben wird.
      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)
   Obige Erwähnungen von com.sun.star.lang.EventObject sind optional. Solche Anmerkungen helfen bei der Identifizierung der LibreOffice-Programmierschnittstelle (API).
Zeigt den Dialog an und wartet, wenn es modal ist, auf seine Beendigung durch den Benutzer. Der zurückgegebene Wert ist:
0: Schaltfläche Abbrechen gedrückt
1: Schaltfläche OK gedrückt
Andernfalls wurde der Dialog mit einer Anweisung EndExecute() beendet, die von einem Dialog- oder Steuerereignis ausgegeben wurde
Bei nicht-modalen Dialogen gibt die Methode immer 0 zurück und die Ausführung des Makros wird fortgesetzt.
svc.Execute(modal: bool = True): int
modal: False bei nicht-modalem Dialog. Standard = True.
In diesem einfachen Beispiel wird der Dialog myDialog in der Bibliothek Standard des aktuellen Dokuments gespeichert.
      Dim oDlg As Object, lReturn As Long
      Set oDlg = CreateScriptService("SFDialogs.Dialog", , , "myDialog")
      lReturn = oDlg.Execute(Modal := False)
      Select Case lReturn
          ' ...
      End Select
   Dieser Python-Code zeigt den modalen Dialog DlgConvert aus der gemeinsamen Basisbibliothek Euro an.
     dlg = CreateScriptService("SFDialogs.Dialog", 'GlobalScope', 'Euro', "DlgConvert")
     rc = dlg.Execute()
     if rc == dlg.CANCELBUTTON:
         # ...
   Ersetzt alle festen Textzeichenfolgen in einem Dialog durch ihre übersetzten Versionen basierend auf einer Dienstinstanz L10N. Diese Methode übersetzt die folgenden Zeichenfolgen:
Die Methode gibt bei Erfolg True zurück.
Verwenden Sie zum Erstellen einer Liste übersetzbarer Zeichenfolgen in einem Dialog die Methode AddTextsFromDialog des Dienstes "L10N".
svc.GetTextsFromL10N(l10n: svc): bool
l10n: Eine Dienstinstanz L10N, von der übersetzte Zeichenfolgen abgerufen werden.
Das folgende Beispiel lädt übersetzte Zeichenfolgen und wendet sie auf den Dialog "MyDialog" an.
     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()
   Lesen Sie die Hilfeseite zum Dienst L10N, um mehr darüber zu erfahren, wie PO- und POT-Dateien gehandhabt werden.
Legt die Tabulatorreihenfolge einer Reihe von Steuerelementen fest. Die Reihenfolge der Steuerelemente wird als Matrix von Steuerelementnamen vom ersten bis zum letzten angegeben.
Auf Steuerelemente mit einem Index >= 1 kann nicht mit [Tabulator] zugegriffen werden, wenn:
- sie in der angegebenen Liste weggelassen werden
 - ihr Typ "FixedLine", "GroupBox" oder "ProgressBar" ist
- sie deaktiviert sind
svc.TabsList(TabsList: num, Start: num = 1, Increment: num = 1): bool
TabsList: eine Matrix gültiger Steuerelementnamen in der Tabulatorreihenfolge
Start: der Tabulatorindex, der dem ersten Steuerelement in der Liste zugewiesen werden soll. Standard = 1
Increment: die Differenz zwischen zwei aufeinanderfolgenden Tabulatorindizes. Standard = 1
Gibt bei Erfolg True zurück.
     oDlg.OrderTabs(Array("myListBox", "myTextField", "myNumericField"), Start := 10)
   
     dlg.OrderTabs(('myListBox', 'myTextField', 'myNumericField'), Start = 10)
   Verschiebt die obere linke Ecke eines Dialogs auf neue Koordinaten und/oder ändert seine Abmessungen. Alle Entfernungen werden in Einheit AppFont ausgedrückt. Ohne Argumente setzt die Methode die ursprünglichen Abmessungen zurück. Gibt True zurück, wenn die Größenänderung erfolgreich war.
svc.Resize(opt Left: num, opt Top: num, opt Width: num, opt Height: num): bool
Left: der horizontale Abstand von der oberen linken Ecke
Top: Der vertikale Abstand von der oberen linken Ecke
Width: die Breite des Rechtecks, das den Dialog enthält
Height: die Höhe des Rechtecks, das den Dialog enthält
Fehlende Argumente bleiben unverändert
     oDlg.Resize(1000, 2000, Height := 6000) ' Die Breite wird nicht geändert
   
     dlg.Resize(1000, 2000, Height = 6000)  # Die Breite wird nicht geändert
   Definiert, welche Steuerelemente in einem Dialog für das Wechseln von Seiten verantwortlich sind, wodurch die Verwaltung der Eigenschaft Page eines Dialogs und seiner Steuerelemente vereinfacht wird.
Dialoge können mehrere Seiten haben und die aktuell sichtbare Seite wird durch die Dialogeigenschaft Page definiert. Wenn die Eigenschaft Page unverändert gelassen wird, ist die standardmäßig sichtbare Seite gleich 0 (Null), was bedeutet, dass keine bestimmte Seite definiert ist und alle sichtbaren Steuerelemente angezeigt werden, unabhängig von dem Wert, der in ihrer eigenen Eigenschaft Page gesetzt ist.
Wenn die Eigenschaft Page eines Dialogs auf einen anderen Wert als 1, 2, 3 und so weiter geändert wird, dann werden nur die Steuerelemente angezeigt, deren Eigenschaft Page mit der aktuellen Dialogseite übereinstimmen.
Durch die Verwendung der Methode SetPageManager ist es möglich, vier Arten von Seitenmanagern zu definieren:
Listenfeld oder Kombinationsfeld: Es entspricht jeder Eintrag in dem Listen- oder Kombinationsfeld einer Seite. Das erste Element bezieht sich auf Seite 1, das zweite Element bezieht sich auf Seite 2 und so weiter.
Gruppe von Optionsfeldern: definiert eine Gruppe von Optionsfeldern, die steuern, welche Seite sichtbar ist.
Schaltflächenfolge: definiert eine Reihe von Schaltflächen, von denen jede einer Dialogseite entspricht. Dies kann verwendet werden, um eine Oberfläche mit Registern zu emulieren, indem Schaltflächen nebeneinander im Dialog platziert werden.
Schaltflächen Vorherige/Nächste: definiert, welche Schaltflächen im Dialog verwendet werden, um zur vorherigen/nächsten Seite im Dialog zu navigieren.
Es ist möglich, mehr als einen Seitenverwaltungsmechanismus gleichzeitig zu verwenden.
Diese Methode sollte nur einmal aufgerufen werden, bevor die Methode Execute aufgerufen wird. Nachfolgende Aufrufe werden ignoriert.
Bei Erfolg gibt diese Methode True zurück.
svc.SetPageManager(pilotcontrols: str = "", tabcontrols: str = "", wizardcontrols: str = "", opt lastpage: int): bool
pilotcontrols: eine durch Kommas getrennte Liste von Steuerelementennamen ListBox, ComboBox oder RadioButton, die als Seitenmanager verwendet werden. Legen Sie für Steuerelemente "RadioButton" den Namen des ersten zu verwendenden Steuerelements in der Gruppe fest.
Tabcontrols: eine durch Kommas getrennte Liste von Schaltflächennamen, die als Seitenmanager verwendet werden. Die Reihenfolge, in der sie in diesem Argument angegeben werden, entspricht der Seitenzahl, der sie zugeordnet sind.
wizardcontrols: eine durch Kommas getrennte Liste mit den Namen von zwei Schaltflächen, die als Schaltflächen Zurück/Weiter verwendet werden.
lastpage: die Nummer der letzten verfügbaren Seite. Es wird empfohlen, diesen Wert festzulegen, wenn Sie den Manager für vorherige/nächste Seite verwenden.
Stellen Sie sich einen Dialog mit drei Seiten vor. Der Dialog hat ein Steuerelement ListBox namens "aPageList", das verwendet wird, um die sichtbare Seite zu steuern. Zusätzlich gibt es zwei Schaltflächen mit den Namen "btnPrevious" und "btnNext", die als Schaltflächen Zurück/Weiter im Dialog verwendet werden.
    oDlg.SetPageManager(PilotControls := "aPageList", _
                           WizardControls := "btnPrevious,btnNext", _
                           LastPage := 3)
    oDlg.Execute()
  
    dlg.SetPageManager(pilotcontrols="aPageList",
                       wizardcontrols="btnPrevious,btnNext",
                       lastpage=3)
    dlg.Execute()
  Beendet den Dienst Dialog für die aktuelle Instanz. Gibt True zurück, wenn die Beendigung erfolgreich war.
svc.Terminate(): bool
Die folgenden Basic- und Python-Beispiele öffnen die nicht-modalen Dialoge DlgConsole und dlgTrace. Sie werden jeweils in gemeinsam genutzten Bibliotheken von ScriptForge und Access2Base gespeichert. Schaltflächen zum Schließen von Dialogen sind deaktiviert und eine explizite Beendigung wird am Ende eines laufenden Prozesses durchgeführt.
In diesem Beispiel ersetzt eine Schaltfläche in DlgConsole das gesperrte Schließen des Fensters:
     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()