Služba SFDialogs.Dialog

The Dialog service contributes to the management of dialogs created with the Basic Dialog Editor or dialogs created on-the-fly. Each instance of the current class represents a single dialog box displayed to the user.

tip

Dialogové okno může být zobrazeno v modálním nebo nemodálním režimu.


V modálním režimu se po zobrazení okna pozastaví vykonávání makra, dokud není stisknuto tlačítko OK nebo Zrušit. Mezitím může uživatel spouštět v okně specifické akce.

V nemodálním režimu je okno na pracovní ploše uživatele „plovoucí“ a vykonávání makra normálně pokračuje. Nemodální okno se zavře, pokud je ukončeno metodou Terminate() nebo pokud skončí relace LibreOfficeDev. Tlačítko pro zavření okna je v těchto oknech neaktivní.

Při explicitním zavření je dialogové okno vymazáno z paměti.

tip

Služba SFDialogs.Dialog úzce souvisí se službou SFDialogs.DialogControl.


Volání a použití služby

Před používáním služby Dialog je nutné načíst či naimportovat knihovnu ScriptForge pomocí:

note

• V makrech Basicu je nutné načíst knihovnu ScriptForge následujícím příkazem:
GlobalScope.BasicLibraries.loadLibrary("ScriptForge")

• Ve skriptech Pythonu je nezbytné import z modulu scriptforge:
from scriptforge import CreateScriptService


The Dialog service is invoked through the CreateScriptService method. It requires three supplemental positional arguments to specify the dialog box to activate:

Container: "GlobalScope" pro předinstalované knihovny nebo název okna, jak byl definován službou ScriptForge.UI. Výchozí hodnotou je prázdný řetězec "", který znamená aktuální dokument.

Library: Název knihovny obsažené v kontejneru, záleží u něj na velikosti písmen. Výchozí hodnotou je "Standard".

DialogName: Řetězec označující dialogové okno, záleží u něj na velikosti písmen.

V následujících příkladech pro Basic a Python se zobrazí dialogové okno dlgConsole, které je součástí sdílené knihovny 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")
      ' ... místo pro inicializaci ovládacích prvků...
      lButton = oDlg.Execute()
      ' Výchozí režim je modální
      If lButton = oDlg.OKBUTTON Then
      ' ... Místo pro zpracování ovládacích prvků a provedení potřebných akcí
      End If
      oDlg.Terminate()
  

Nebo pomocí Pythonu:


    dlg = CreateScriptService('SFDialogs.Dialog', 'GlobalScope', 'ScriptForge', 'dlgConsole')
    # ... místo pro inicializaci ovládacích prvků...
    rc = dlg.Execute()
    # Výchozí režim je modální
    if rc == dlg.OKBUTTON:
        # ... Místo pro zpracování ovládacích prvků a provedení potřebných akcí
    dlg.Terminate()
  
note

Řetězec "GlobalScope" použije jako argument container v případě, že je dialogové okno uloženo v části Moje makra a dialogová okna nebo Makra a dialogová okna aplikace.


tip

The dialog service offers methods that create new controls dynamically in an existing dialog predefined with the Dialog Editor. A dialog is initialized with controls in the Dialog Editor and new controls can be added at run-time before or after the dialog Execute() statement.


The Dialog service can equally be invoked - through the CreateScriptService method - when creating dialogs on-the-fly. It requires two supplemental positional arguments after the name of the ad-hoc service "NewDialog":

DialogName: A case-sensitive string designating the dialog.

Place: Window location of the dialog being either :

All elements are expressed in Map AppFont units.


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

Or using Python:


    def newDialog():
       dlg = CreateScriptService('NewDialog', 'myDialog1', (100,200, 40, 110))
       # ... Process controls and do what is needed
  

All properties and methods applicable to predefined dialogs are available for such new dialogs. In particular the series of CreateXXX() methods for the additionof new dialog controls.

Získání instance služby Dialog, která spustila událost dialogového okna

Instanci služby Dialog lze získat pomocí služby SFDialogs.DialogEvent, a to za předpokladu, že dialogové okno bylo službou Dialog vytvořeno. V následujícím příkladu je instanci služby Dialog, která spustila událost dialogového okna, obsažena v proměnné oDlg.


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

Nebo pomocí Pythonu:


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

Ve výše uvedených příkladech je možné předponu "SFDialogs." vynechat.

Zpracování výjimek v handlerech událostí

Při vytváření handleru události pro událost dialogového okna je vhodné zpracovávat chyby v samotném podprogramu. Například následující handler je volán tehdy, když je v dialogovém okně stisknuto tlačítko myši.


    Sub OnMouseButtonPressed(ByRef oEvent As Object)
    On Local Error GoTo Catch
        Dim oDialog As Object
        oDialog = CreateScriptService("DialogEvent", oEvent)
        ' Zpracování události
        Exit Sub
    Catch:
        MsgBox SF_Exception.Description
        SF_Exception.Clear
    End Sub
  
tip

Volání SF_Exception.Clear použijte, pokud si nepřejete, aby se chyba propagovala.


V Pythonu použijte pro zpracování výjimek nativní bloky try/except, jak ukazuje následující příklad:


    def on_mouse_button_pressed(event=None):
        try:
            dlg = CreateScriptService("DialogEvent", event)
            # Zpracování události
        except Exception as e:
            # Objekt "bas" je instancí služby Basic
            bas.MsgBox(str(e))
  

Vlastnosti

Název

Pouze pro čtení

Typ

Popis

OKBUTTON

ano

Integer

Hodnota = 1. Bylo stisknuto tlačítko OK.

CANCELBUTTON

ano

Integer

Hodnota = 0. Bylo stisknuto tlačítko Zrušit.

Caption

ne

String

Určuje popisek dialogového okna.

Height

ne

Long

Určuje výšku dialogového okna.

Modal

ano

Boolean

Určuje, zda je dialogové okno aktuálně v modálním režimu.

Name

ano

String

Název dialogového okna.

Page

ne

Integer

Dialogové okno může mít několik stránek, které uživatel krok za krokem prochází. Vlastnost Page objektu Dialog určuje, která stránka okna je aktivní.

Visible

ne

Boolean

Určuje, zda je dialogové okno na pracovní ploše viditelné. Ve výchozím nastavení je viditelné až po spuštění metody Execute().

XDialogModel

ano

UNO
object

Objekt UNO představující model dialogového okna. Podrobné informace naleznete v dokumentaci API na stránkách XControlModel a UnoControlDialogModel.

XDialogView

ano

UNO
object

Objekt UNO představující pohled (view) dialogového okna. Podrobné informace naleznete v dokumentaci API na stránkách XControl a UnoControlDialog.

Width

ne

Long

Určuje šířku dialogového okna.


Vlastnosti události

On… properties return a URI string with the reference to the script triggered by the event. On… properties can be set programmatically.
Read its specification in the scripting framework URI specification.

Název

Read/Write

Popis v IDE jazyka BASIC

OnFocusGained

ano

Při zaměření

OnFocusLost

ano

Při ztrátě zaměření

OnKeyPressed

ano

Klávesa stisknuta

OnKeyReleased

ano

Klávesa uvolněna

OnMouseDragged

Ano

Myš se pohnula spolu se stisknutou klávesou

OnMouseEntered

ano

Myš uvnitř

OnMouseExited

ano

Myš vně

OnMouseMoved

ano

Posuv myši

OnMousePressed

ano

Stisknuto tlačítko myši

OnMouseReleased

ano

Uvolněno tlačítko myši


warning

Assigning events via the Basic IDE and assigning events via macros are mutually exclusive.


List of Methods in the Dialog Service

Activate
Center
Controls
CloneControl
CreateButton
CreateCheckBox
CreateComboBox
CreateCurrencyField
CreateDateField
CreateFileControl
CreateFixedLine

CreateFixedText
CreateFormattedField
CreateGroupBox
CreateHyperlink
CreateImageControl
CreateListBox
CreateNumericField
CreatePatternField
CreateProgressBar
CreateRadioButton
CreateScrollBar

CreateTableControl
CreateTextField
CreateTimeField
CreateTreeControl
EndExecute
Execute
GetTextsFromL10N
Resize
OrderTabs
SetPageManager
Terminate


note

Dimensioning a dialog is done by using Map AppFont units. A dialog or control model also uses AppFont units. While their views use pixels.


Activate

Nastaví aktuální instanci služby Dialog zaměření. V případě úspěšného nastavení vrátí True.

Metoda je volána z události dialogového okna či ovládacího prvku, případně při zobrazení okna v nemodálním režimu.

Syntaxe:

svc.Activate(): bool

Příklad:


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

V příkladech v Pythonu i jazyce LibreOfficeDev Basic se předpokládá, že je okno uloženo v aktuálním dokumentu v knihovně Standard.


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

Center

Zarovná aktuální instanci dialogového okna na střed rodičovského okna. Bez argumentů metoda dialogové okno zarovná na střed aktuálního okna.

V případě úspěšného zarovnání vrátí True.

Syntaxe:

svc.Center(opt Parent: obj): bool

Parametry:

Parent: Nepovinný objekt, kterým může být:

Příklad:

V Basicu

     Sub TriggerEvent(oEvent As Object)
         Dim oDialog1 As Object, oDialog2 As Object, lExec As Long
         Set oDialog1 = CreateScriptService("DialogEvent", oEvent) ' Dialogové okno, které způsobilo událost
         Set oDialog2 = CreateScriptService("Dialog", ...) ' Otevře druhé dialogové okno
         oDialog2.Center(oDialog1)
         lExec = oDialog2.Execute()
         Select Case lExec
             ...
     End Sub
  
V Pythonu

     def triggerEvent(event: uno):
       dlg1 = CreateScriptService('DialogEvent.Dialog', event)  # Dialogové okno, které způsobilo událost
       dlg2 = CreateScriptService('Dialog', ...)  # Otevře druhé dialogové okno
       dlg2.Center(dlg1)
       rc = dlg2.Execute()
       if rc is False:
         # ...
   

CloneControl

Duplicate an existing control of any typein the actual dialog. The duplicated control is left unchanged and can be relocated.

Syntaxe:

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

Parametry:

SourceName: The name of the control to duplicate.

ControlName: A valid control name as a case-sensitive string. It must not exist yet.

Left, Top: The coordinates of the new control expressed in Map AppFont units.

Návratová hodnota:

An instance of SFDialogs.DialogControl service or Nothing.

Příklad:

V Basicu

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

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

Controls

Vrátí:

Syntaxe:

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

svc.Controls(controlname: str): svc

Parametry:

ControlName : Platný název jako řetězec, u něhož záleží na velikost písmen. Není-li zadán, vrátí se seznam názvů ovládacích prvků jako pole začínající od 0.

Příklad:


      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

Create a new control of type Button in the current dialog.

Syntaxe:

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

Parametry:

ControlName: the name of the new control. It must not exist yet.

Place: either …

All elements are expressed in Map AppFont units.

Toggle: when True a Toggle button is created. Default = False

Push: "OK", "CANCEL" or "" (default)

Návratová hodnota:

An instance of SFDialogs.DialogControl service or Nothing.

Příklad:

V Basicu

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

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

CreateCheckBox

Create a new control of type CheckBox in the current dialog.

Syntaxe:

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

Parametry:

ControlName: the name of the new control. It must not exist yet.

Place: either …

All elements are expressed in Map AppFont units.

MultiLine: When True (default = False), the caption may be displayed on more than one line.

Návratová hodnota:

An instance of SFDialogs.DialogControl service or Nothing.

Příklad:

V Basicu

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

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

CreateComboBox

Create a new control of type ComboBox in the current dialog.

Syntaxe:

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

Parametry:

ControlName: the name of the new control. It must not exist yet.

Place: either …

All elements are expressed in Map AppFont units.

Border: "3D" (default) or "FLAT" or "NONE"

DropDown: When True (default), a drop down button is displayed

LineCount: Specifies the maximum line count displayed in the drop down (default = 5)

Návratová hodnota:

An instance of SFDialogs.DialogControl service or Nothing.

Příklad:

V Basicu

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

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

CreateCurrencyField

Create a new control of type CurrencyField in the current dialog.

Syntaxe:

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

Parametry:

ControlName: the name of the new control. It must not exist yet.

Place: either …

All elements are expressed in Map AppFont units.

Border: "3D" (default) or "FLAT" or "NONE"

SpinButton: when True (default = False), a spin button is present

MinValue: the smallest value that can be entered in the control. Default = -1000000

MaxValue: the largest value that can be entered in the control. Default = +1000000

Increment: the step when the spin button is pressed. Default = 1

Accuracy: specifies the decimal accuracy. Default = 2 decimal digits

Návratová hodnota:

An instance of SFDialogs.DialogControl service or Nothing.

Příklad:

V Basicu

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

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

CreateDateField

Create a new control of type DateField in the current dialog.

Syntaxe:

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

Parametry:

ControlName: the name of the new control. It must not exist yet.

Place: either …

All elements are expressed in Map AppFont units.

Border: "3D" (default) or "FLAT" or "NONE"

DropDown: when True (default = False), a dropdown button is shown

MinDate: the smallest date that can be entered in the control. Default = 1900-01-01

MaxDate: the largest date that can be entered in the control. Default = 2200-12-31

Návratová hodnota:

An instance of SFDialogs.DialogControl service or Nothing.

Příklad:

V Basicu

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

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

CreateFileControl

Create a new control of type FileControl in the current dialog.

Syntaxe:

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

Parametry:

ControlName: the name of the new control. It must not exist yet.

Place: either …

All elements are expressed in Map AppFont units.

Border: "3D" (default) or "FLAT" or "NONE"

Návratová hodnota:

An instance of SFDialogs.DialogControl service or Nothing.

Příklad:

V Basicu

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

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

CreateFixedLine

Create a new control of type FixedLine in the current dialog.

Syntaxe:

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

Parametry:

ControlName: the name of the new control. It must not exist yet.

Place: either …

All elements are expressed in Map AppFont units.

Orientation: "H[orizontal]" or "V[ertical]".

Návratová hodnota:

An instance of SFDialogs.DialogControl service or Nothing.

Příklad:

V Basicu

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

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

CreateFixedText

Create a new control of type FixedText in the current dialog.

Syntaxe:

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

Parametry:

ControlName: the name of the new control. It must not exist yet.

Place: either …

All elements are expressed in Map AppFont units.

Border: "NONE" (default) or "FLAT" or "3D"

Multiline: When True (default = False), the caption may be displayed on more than one line

Align: horizontal alignment, "LEFT" (default) or "CENTER" or "RIGHT"

VerticalAlign: vertical alignment, "TOP" (default) or "MIDDLE" or "BOTTOM"

Návratová hodnota:

An instance of SFDialogs.DialogControl service or Nothing.

Příklad:

V Basicu

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

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

CreateFormattedField

Create a new control of type FormattedField in the current dialog.

Syntaxe:

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

Parametry:

ControlName: the name of the new control. It must not exist yet.

Place: either …

All elements are expressed in Map AppFont units.

Border: "3D" (default) or "FLAT" or "NONE"

SpinButton: when True (default = False), a spin button is present

MinValue: the smallest value that can be entered in the control. Default = -1000000

MaxValue: the largest value that can be entered in the control. Default = +1000000

Návratová hodnota:

An instance of SFDialogs.DialogControl service or Nothing.

Příklad:

V Basicu

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

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

CreateGroupBox

Create a new control of type GroupBox in the current dialog.

Syntaxe:

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

Parametry:

ControlName: the name of the new control. It must not exist yet.

Place: either …

All elements are expressed in Map AppFont units.

Návratová hodnota:

An instance of SFDialogs.DialogControl service or Nothing.

Příklad:

V Basicu

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

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

CreateHyperlink

Create a new control of type Hyperlink in the current dialog.

Syntaxe:

Parametry:

ControlName: the name of the new control. It must not exist yet.

Place: either …

All elements are expressed in Map AppFont units.

Border: "NONE" (default) or "FLAT" or "3D"

MultiLine: When True (default = False), the caption may be displayed on more than one line

Align: horizontal alignment, "LEFT" (default) or "CENTER" or "RIGHT"

VerticalAlign: vertical alignment, "TOP" (default) or "MIDDLE" or "BOTTOM"

Návratová hodnota:

An instance of SFDialogs.DialogControl service or Nothing.

Příklad:

V Basicu

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

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

CreateImageControl

Create a new control of type ImageControl in the current dialog.

Syntaxe:

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

Parametry:

ControlName: the name of the new control. It must not exist yet.

Place: either …

All elements are expressed in Map AppFont units.

Border: "3D" (default) or "FLAT" or "NONE"

Scale: One of next values: "FITTOSIZE" (default), "KEEPRATIO" or "NO"

Návratová hodnota:

An instance of SFDialogs.DialogControl service or Nothing.

Příklad:

V Basicu

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

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

CreateListBox

Create a new control of type ListBox in the current dialog.

Syntaxe:

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

Parametry:

ControlName: the name of the new control. It must not exist yet.

Place: either …

All elements are expressed in Map AppFont units.

Border: "3D" (default) or "FLAT" or "NONE"

DropDown: When True (default), a drop down button is displayed

LineCount: Specifies the maximum line count displayed in the drop down (default = 5)

MultiSelect: When True, more than 1 entry may be selected. Default = False

Návratová hodnota:

An instance of SFDialogs.DialogControl service or Nothing.

Příklad:

V Basicu

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

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

CreateNumericField

Create a new control of type NumericField in the current dialog.

Syntaxe:

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

Parametry:

ControlName: the name of the new control. It must not exist yet.

Place: either …

All elements are expressed in Map AppFont units.

Border: "3D" (default) or "FLAT" or "NONE"

SpinButton: when True (default = False), a spin button is present

MinValue: the smallest value that can be entered in the control. Default = -1000000

MaxValue: the largest value that can be entered in the control. Default = +1000000

Increment: the step when the spin button is pressed. Default = 1

Accuracy: specifies the decimal accuracy. Default = 2 decimal digits

Návratová hodnota:

An instance of SFDialogs.DialogControl service or Nothing.

Příklad:

V Basicu

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

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

CreatePatternField

Create a new control of type PatternField in the current dialog.

Syntaxe:

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

Parametry:

ControlName: the name of the new control. It must not exist yet.

Place: either …

All elements are expressed in Map AppFont units.

Border: "3D" (default) or "FLAT" or "NONE"

EditMask: a character code that determines what the user may enter
Refer to Pattern_Field in the wiki for more information.

LiteralMask: contains the initial values that are displayed in the pattern field

Návratová hodnota:

An instance of SFDialogs.DialogControl service or Nothing.

Příklad:

V Basicu

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

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

CreateProgressBar

Create a new control of type ProgressBar in the current dialog.

Syntaxe:

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

Parametry:

ControlName: the name of the new control. It must not exist yet.

Place: either …

All elements are expressed in Map AppFont units.

Border: "3D" (default) or "FLAT" or "NONE"

MinValue: the smallest value that can be entered in the control. Default = 0

MaxValue: the largest value that can be entered in the control. Default = 100

Návratová hodnota:

An instance of SFDialogs.DialogControl service or Nothing.

Příklad:

V Basicu

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

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

CreateRadioButton

Create a new control of type RadioButton in the current dialog.

Syntaxe:

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

Parametry:

ControlName: the name of the new control. It must not exist yet.

Place: either …

All elements are expressed in Map AppFont units.

MultiLine: When True (default = False), the caption may be displayed on more than one line

Návratová hodnota:

An instance of SFDialogs.DialogControl service or Nothing.

Příklad:

V Basicu

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

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

CreateScrollBar

Create a new control of type ScrollBar in the current dialog.

Syntaxe:

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

Parametry:

ControlName: the name of the new control. It must not exist yet.

Place: either …

All elements are expressed in Map AppFont units.

Orientation: H[orizontal] or V[ertical]

Border: "3D" (default) or "FLAT" or "NONE"

MinValue: the smallest value that can be entered in the control. Default = 0

MaxValue: the largest value that can be entered in the control. Default = 100

Návratová hodnota:

An instance of SFDialogs.DialogControl service or Nothing.

Příklad:

V Basicu

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

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

CreateTableControl

Create a new control of type TableControl in the current dialog.

Syntaxe:

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

Parametry:

ControlName: the name of the new control. It must not exist yet.

Place: either …

All elements are expressed in Map AppFont units.

Border: "3D" (default) or "FLAT" or "NONE"

RowHeaders: when True (default), the row Headers are shown

ColumnHeaders: when True (default), the column Headers are shown

ScrollBars: H[orizontal] or V[ertical] or B[oth] or N[one] (default). Scrollbars appear dynamically when they are needed.

GridLines: when True (default = False) horizontal and vertical lines are painted between the grid cells

Návratová hodnota:

An instance of SFDialogs.DialogControl service or Nothing.

Příklad:

V Basicu

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

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

CreateTextField

Create a new control of type TextField in the current dialog.

Syntaxe:

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

Parametry:

ControlName: the name of the new control. It must not exist yet.

Place: either …

All elements are expressed in Map AppFont units.

Border: "3D" (default) or "FLAT" or "NONE"

MultiLine: When True (default = False), the caption may be displayed on more than one line

MaximumLength: the maximum character count (default = 0 meaning unlimited)

PasswordCharacter: a single character specifying the echo for a password text field (default = "")

Návratová hodnota:

An instance of SFDialogs.DialogControl service or Nothing.

Příklad:

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

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

CreateTimeField

Create a new control of type TimeField in the current dialog.

Syntaxe:

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

Parametry:

ControlName: the name of the new control. It must not exist yet.

Place: either …

All elements are expressed in Map AppFont units.

Border: "3D" (default) or "FLAT" or "NONE"

MinTime: the smallest time that can be entered in the control. Default = 0

MaxTime: the largest time that can be entered in the control. Default = 24h

Návratová hodnota:

An instance of SFDialogs.DialogControl service or Nothing.

Příklad:

V Basicu

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

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

CreateTreeControl

Create a new control of type TreeControl in the current dialog.

Syntaxe:

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

Parametry:

ControlName: the name of the new control. It must not exist yet.

Place: either …

All elements are expressed in Map AppFont units.

Border: "3D" (default) or "FLAT" or "NONE"

Návratová hodnota:

An instance of SFDialogs.DialogControl service or Nothing.

Příklad:

V Basicu

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

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

EndExecute

Ukončí zobrazení modálního dialogového okna a předá zadaný argument do návratové hodnoty aktuálně spuštěné akce Excecute().

Metodu EndExecute() obvykle obsahuje zpracování makra spuštěného událostí dialogového okna či ovládacího prvku.

Syntaxe:

svc.EndExecute(returnvalue: int)

Parametry:

returnvalue: Hodnota předaná spuštěné metodě Execute().

Příklad:

V Basicu

      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
   
V Pythonu

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

Výše zmíněný zápis com.sun.star.lang.EventObject je nepovinný. Podobná označení napomáhají identifikovat rozhraní pro programování aplikací (API) pro LibreOfficeDev.


Execute

Zobrazí dialogové okno, a pokud je okno modální, počká na jeho zavření uživatelem. Vrácená hodnota je:

U nemodálních oken vrátí tato metoda vždy hodnotu 0 a bude pokračovat provádění makra.

Syntaxe:

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

Parametry:

modal: False v případě nemodálního dialogového okna. Výchozí = True.

Příklad:

V tomto příkladu Basicu je okno myDialog uloženo v knihovně Standard v aktuálním dokumentu.


      Dim oDlg As Object, lReturn As Long
      Set oDlg = CreateScriptService("SFDialogs.Dialog", , , "myDialog")
      lReturn = oDlg.Execute(Modal := False)
      Select Case lReturn
          ' ...
      End Select
   

Tento kód v Pythonu zobrazí modální dialogového okno DlgConvert se sdílené knihovny Basicu Euro.


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

GetTextsFromL10N

Nahradí všechny textové řetězce dialogového okna jejich přeloženými verzemi z instance služby L10N. Metoda přeloží následující řetězce:

V případě úspěšného nahrazení vrátí metoda True.

Seznam řetězců okna určených k překladu vytvoříte metodou AddTextsFromDialog ze služby L10N.

Syntaxe:

svc.GetTextsFromL10N(l10n: svc): bool

Parametry:

l10n: Instance služby L10N, ze které se přeložené řetězce získají.

Příklad:

V následujícím příkladu se načtou přeložené řetězce a použijí se na dialogové okno "MyDialog".

V Basicu

     oDlg = CreateScriptService("Dialog", "GlobalScope", "Standard", "MyDialog")
     myPO = CreateScriptService("L10N", "/home/user/po_files/")
     oDlg.GetTextsFromL10N(myPO)
     oDlg.Execute()
   
V Pythonu

     dlg = CreateScriptService("Dialog", "GlobalScope", "Standard", "MyDialog")
     myPO = CreateScriptService("L10N", "/home/user/po_files/")
     dlg.GetTextsFromL10N(myPO)
     dlg.Execute()
   
tip

Další informace o nakládání se soubory PO a POT naleznete na stránce služby L10N.


OrderTabs

Set the tabulation index of a series of controls. The sequence of controls are given as an array of control names from the first to the last.

warning

Controls with an index >= 1 are not accessible with the TAB key if:
- they are omitted from the given list
- their type is FixedLine, GroupBox or ProgressBar
- they are disabled


Syntaxe:

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

Parametry:

TabsList: an array of valid control names in the order of tabulation

Start: the tab index to be assigned to the 1st control in the list. Default = 1

Increment: the difference between 2 successive tab indexes. Default = 1

Návratová hodnota:

True when successful.

Příklad:

V Basicu

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

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

Resize

Moves the topleft corner of a dialog to new coordinates and/or modify its dimensions. All distances are expressed in AppFont units. Without arguments, the method resets the initial dimensions. Return True if the resize was successful.

Syntaxe:

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

Parametry:

Left: vodorovná vzdálenost od levého horního rohu

Top: svislá vzdálenost od levého horního rohu

Width: šířka obdélníku představujícího dialogové okno

Height: výška obdélníku představujícího dialogové okno

Missing arguments are left unchanged

Příklad:

V Basicu

     oDlg.Resize(1000, 2000, Height := 6000) ' Width is not changed
   
V Pythonu

     dlg.Resize(1000, 2000, Height = 6000)  # Width is not changed
   

SetPageManager

Určuje, které ovládací prvky dialogového okna slouží k přepínání stránek. Tím usnadní správu vlastnosti Page dialogového okna a souvisejících ovládacích prvků.

Dialogová okna mohou mít více stránek. Aktuálně zobrazenou stránku určuje vlastnost Page dialogového okna. Pokud tato vlastnost není změněna, výchozí zobrazená stránka bude rovna 0 (nule), což znamená, že nebude stránka nebude určena a zobrazí se všechny viditelné ovládací prvky bez ohledu na to, jako hodnotu mají nastavenu ve svých vlastnostech Page.

Změní-li se vlastnost Page dialogového okna, například na hodnotu 1, 2, 3 atd., zobrazí se pouze ty ovládací prvky, jejichž vlastnost Page aktuální stránce dialogového okna odpovídá.

Metodou SetPageManager je možné určit čtyři typu prvků spravujících stránky:

tip

Je možné použít více způsobů správy stránek zároveň.


Předpokládá se, že se tato metoda bude volat pouze jednou, před voláním metody Execute. Následující volání jsou ignorována.

V případě úspěšného provedení vrátí metoda True.

Syntaxe:

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

Parametry:

pilotcontrols: čárkami oddělený seznam názvů ovládacích prvků typu ListBox, ComboBox nebo RadioButton, které se použijí pro správu stránek. U ovládacích prvků typu RadioButton zadejte název prvního prvku skupiny, která se má použít.

tabcontrols: čárkami oddělený seznam názvů tlačítek, která se použijí pro správu stránky. Pořadí, v jakém jsou zadány, odpovídá číslům stránek, ke kterým jsou přiřazeny.

wizardcontrols: čárkou oddělený seznam názvů dvou tlačítek, které se použijí jako tlačítka Předchozí/Další.

lastpage: číslo poslední dostupné stránky. Tuto hodnotu je vhodné zadat při použití správy stránek s tlačítky Předchozí/Další.

Příklad:

Dialogové okno obsahuje tři stránky a ovládací prvek typu ListBox pojmenovaný "aPageList", který se použije k nastavení zobrazené stránky. Kromě toho má dvě tlačítka pojmenovaná "btnPrevious" a "btnNext", která se použijí jako tlačítka Předchozí/Další.

V Basicu

    oDlg.SetPageManager(PilotControls := "aPageList", _
                           WizardControls := "btnPrevious,btnNext", _
                           LastPage := 3)
    oDlg.Execute()
  
V Pythonu

    dlg.SetPageManager(pilotcontrols="aPageList",
                       wizardcontrols="btnPrevious,btnNext",
                       lastpage=3)
    dlg.Execute()
  

Terminate

Ukončí službu Dialog pro aktuální instanci. V případě úspěšného ukončení vrátí True.

Syntaxe:

svc.Terminate(): bool

Příklad:

V níže uvedených příkladech v Basicu a v Pythonu je otevřena dialogová okna DlgConsole a dlgTrace, která jsou uložena ve sdílených knihovnách ScriptForge a Access2Base. Tlačítka pro zavření okna jsou zakázána, a na konci spuštěného procesu je proto okno ukončeno explicitně.

V tomto příkladu je potlačené zavírání okna nahrazeno tlačítkem v DlgConsole:

V Basicu

     oDlg = CreateScriptService("SFDialogs.Dialog","GlobalScope","ScriptForge","DlgConsole")
     oDlg.Execute(modal:=False)
     Wait 5000
     oDlg.Terminate()
   
V Pythonu

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

Všechny procedury nebo identifikátory knihovny ScriptForge, které jsou uvozeny podtržítkem "_", jsou určeny pro interní použití. Není zamýšleno je používat v makrech Basicu nebo skriptech Pythonu.