Inhalte
Index 🔎︎

# Dienst SFDialogs.Dialog

Der Dienst Dialog trägt zur Verwaltung von Dialogen bei, die mit dem Dialogeditor Basic 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.

## Dienstaufruf und Nutzung

Der Dienst Dialog wird über die Methode CreateScriptService aufgerufen. Es erfordert drei Positionsargumente, um den zu aktivierenden 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 LibreOffice Basic- und Python-Beispiele 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()

Alternativ kann die Instanz Dialog über den Dienst SFDialogs.DialogEvent abgerufen werden, vorausgesetzt, der Dialog wurde mit dem Dienst Dialog initiiert. DialogEvent gibt die Dienstinstanz SFDialogs.Dialog zurück, die das Ereignis ausgelöst hat.

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

mit Python:

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

Beachten Sie, dass in den vorherigen Beispielen das Präfix "SFDialogs." weggelassen werden kann, wenn dies angemessen erscheint.

## Eigenschaften

Name | ReadOnly | 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 object | Das UNO-Objekt, welches das Dialogmodell darstellt. Siehe XControlModel und UnoControlDialogModel in der Programmierschnittstelle (API).
XDialogView | Ja | UNO object | 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.

## Ereigniseigenschaften

Diese Ereigniseigenschaften sind ab LibreOffice 7.2 verfügbar.

Gibt eine URI-Zeichenfolge mit dem Verweis auf das durch das Ereignis ausgelöste Skript zurück. Lesen Sie die Spezifikation in der Skript-Framework URI-Spezifikation nach.

Name | ReadOnly | 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

| Methoden |
Activate Controls | EndExecute Execute | Terminate

## Activate

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.

### Syntax:

svc.Activate(): bool

### Beispiel:

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

## Controls

Rückgabe entweder:

- die Liste der im Dialog enthaltenen Steuerelemente

- eine Klasseninstanz von DialogControl basierend auf ihrem Namen

### Syntax:

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

svc.Controls(controlname: str): svc

### Parameter:

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.

### Beispiel:

          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

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.

### Syntax:

svc.EndExecute(returnvalue: int)

### Parameter:

returnvalue: Der Wert, der an die laufende Methode Execute() übergeben wird.

### Beispiel:

Verwendung von 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

Verwendung von Python:

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

## Execute

Zeigt den Dialog an und wartet, wenn es modal ist, auf seine Beendigung durch den Benutzer. Der zurückgegebene Wert ist entweder:

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

### Syntax:

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

### Parameter:

modal: False bei nicht-modalem Dialog. Standard = True.

### Beispiel:

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

## Terminate

Beendet den Dienst Dialog für die aktuelle Instanz. Gibt True zurück, wenn die Beendigung erfolgreich war.

### Syntax:

svc.Terminate(): bool

### Beispiel:

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

Mit Python:

         from time import sleep
         dlg = CreateScriptService('SFDialogs.Dialog',"GlobalScope",'Access2Base',"dlgTrace")
         dlg.Execute(modal=False)
         sleep 5
         dlg.Terminate()

Alle Basic-Routinen oder -Identifikatoren von ScriptForge mit einem Unterstrich "_" sind für internen Gebrauch reserviert. Sie sind nicht für den Einsatz in Basic-Macros gedacht.

Verwandte Themen

Dienst SFDialogs.DialogControl

ScriptForge.UI service