source/text/sbasic/shared/03/sf_dialog.xhp | 219 ++++++++++++++---------------
1 file changed, 113 insertions(+), 106 deletions(-)
New commits:
commit 8313fdfe3877948b51781949448c6439ee08b734
Author: Alain Romedenne <alain.romede...@libreoffice.org>
AuthorDate: Fri Jul 7 10:00:56 2023 +0200
Commit: Alain Romedenne <alain.romede...@libreoffice.org>
CommitDate: Sun Oct 1 11:04:59 2023 +0200
SF_Dialog help page updates:
- missing literals
- method signature review
- mute Basic & Python
Change-Id: I64ceaa4c90c2b4b9e684359a838e4bd0a299c81c
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/154127
Tested-by: Jenkins
Reviewed-by: Jean-Pierre Ledure <j...@ledure.be>
diff --git a/source/text/sbasic/shared/03/sf_dialog.xhp
b/source/text/sbasic/shared/03/sf_dialog.xhp
index 145a6fc6f0..520e80f60d 100644
--- a/source/text/sbasic/shared/03/sf_dialog.xhp
+++ b/source/text/sbasic/shared/03/sf_dialog.xhp
@@ -22,7 +22,7 @@
</section>
<section id="abstract">
<h1 id="bm_id781582391760253" xml-lang="en-US"><variable id="dlg_h1"><link
href="text/sbasic/shared/03/sf_dialog.xhp"><literal>SFDialogs</literal>.<literal>Dialog</literal>
service</link></variable></h1>
- <paragraph role="paragraph" id="par_id931583589764919" xml-lang="en-US">The
<literal>Dialog</literal> service contributes to the management of dialogs
created with the Basic <link href="text/sbasic/guide/create_dialog.xhp">Dialog
Editor</link>. Each instance of the current class represents a single dialog
box displayed to the user.</paragraph>
+ <paragraph role="paragraph" id="par_id931583589764919" xml-lang="en-US">The
<literal>Dialog</literal> service contributes to the management of dialogs
created with the Basic <link href="text/sbasic/guide/create_dialog.xhp">Dialog
Editor</link> or dialogs created on-the-fly. Each instance of the current class
represents a single dialog box displayed to the user.</paragraph>
</section>
<tip id="par_id831598110550771" xml-lang="en-US">A dialog box can be
displayed in modal or in non-modal modes.</tip>
<paragraph role="paragraph" id="par_id221598110444025" xml-lang="en-US">In
modal mode, the box is displayed and the execution of the macro process is
suspended until one of the OK or Cancel buttons is pressed. In the meantime,
user actions executed on the box can trigger specific actions.</paragraph>
@@ -63,22 +63,27 @@
</pycode>
<note id="par_id811670854106781">Use the string "GlobalScope" as the
<emph>container</emph> argument when the dialog is stored either in
<menuitem>My Macros & Dialogs</menuitem> or in <menuitem>Application Macros
& Dialogs</menuitem>.</note>
<tip id="par_id461688463074274">The dialog service offers methods that
create new controls dynamically in an existing dialog predefined with the <link
href="text/sbasic/guide/create_dialog.html">Dialog Editor</link>. A dialog is
initialized with controls in the Dialog Editor and new controls can be added at
run-time before or after the dialog <literal>Execute()</literal>
statement.</tip>
-
- <paragraph role="paragraph" id="par_id261688459210848">The
<literal>Dialog</literal> service can equally be invoked - through the
<literal>CreateScriptService</literal> method - when creating dialogs
on-the-fly; It requires two supplemental positional arguments:</paragraph>
+
+ <paragraph role="paragraph" id="par_id261688459210848">The
<literal>Dialog</literal> service can equally be invoked - through the
<literal>CreateScriptService</literal> method - when creating dialogs
on-the-fly. It requires two supplemental positional arguments after the name of
the ad-hoc service "NewDialog":</paragraph>
<paragraph role="paragraph"
id="par_id751688460276630"><emph>DialogName</emph>: A case-sensitive string
designating the dialog.</paragraph>
- <paragraph role="paragraph" id="par_id291688460281953"><emph>Library</emph>:
The case-sensitive name of the library where to store the dialog. Default value
is "Standard".</paragraph>
+ <paragraph role="paragraph" id="par_id751688460276640"><emph>Place</emph>:
Window location of the dialog being either :</paragraph>
+ <list type="unordered">
+ <listitem><paragraph id="par_id421598178080993" role="listitem"
xml-lang="en-US">a Basic <link href="sbasic/shared/03104200.xhp">Array</link>
or Python tuple with 4 elements: (X, Y, width, height)</paragraph></listitem>
+ <listitem><paragraph id="par_id881502858229301" role="listitem"
xml-lang="en-US">a com.sun.star.awt.Rectangle [X, Y, Width, Height]
object</paragraph></listitem>
+ </list>
+ <paragraph role="paragraph" id="par_id241688051453685">All elements are
expressed in <link href="text/sbasic/shared/00000002.xhp#AppFontUnits">Map
AppFont units</link>.</paragraph>
<bascode>
<paragraph role="bascode" id="bas_id351688461519997" localize="false">Sub
newDialog()</paragraph>
<paragraph role="bascode" id="bas_id41688461520253" localize="false">
Dim oDlg As Object</paragraph>
- <paragraph role="bascode" id="bas_id351688461520480" localize="false">
oDlg = CreateScriptService("NewDialog", "myDialog1", "myLib")</paragraph>
+ <paragraph role="bascode" id="bas_id351688461520480" localize="false">
oDlg = CreateScriptService("NewDialog", "myDialog1", Array(100,200, 40,
110))</paragraph>
<paragraph role="bascode" id="bas_id341688461520677" localize="false"> '
...</paragraph>
<paragraph role="bascode" id="bas_id761688461521102" localize="false">End
Sub</paragraph>
</bascode>
<paragraph role="paragraph" id="par_id601619633410089">Or using
Python:</paragraph>
<pycode>
<paragraph role="pycode" id="pyc_id711688462077145" localize="false">def
newDialog():</paragraph>
- <paragraph role="pycode" id="pyc_id981688462077340" xml-lang="en-US">
dlg = CreateScriptService("NewDialog", "myDialog1") # "Standard" library is
used</paragraph>
- <paragraph role="pycode" xml-lang="en-US" id="pyc_id681619620065191"> #
... Process controls and do what is needed</paragraph>
+ <paragraph role="pycode" id="pyc_id981688462077340" xml-lang="en-US">
dlg = CreateScriptService('NewDialog', 'myDialog1', (100,200, 40,
110))</paragraph>
+ <paragraph role="pycode" xml-lang="en-US" id="pyc_id681619620065191"> #
... Process controls and do what is needed</paragraph>
</pycode>
<paragraph role="paragraph" id="par_id951688460698125">All properties and
methods applicable to predefined dialogs are available for such new dialogs. In
particular the series of <literal>CreateXXX()</literal> methods for the addition
of new dialog controls.</paragraph>
@@ -584,9 +589,11 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<paragraph role="paragraph" id="par_id31688475132631"><emph>Left</emph>,
<emph>Top</emph>: The coordinates of the new control expressed in <link
href="text/sbasic/shared/00000002.xhp#AppFontUnits">Map AppFont
units</link>.</paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateReturn"/>
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
+ <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/>
<bascode>
<paragraph role="bascode" localize="false"
id="bas_id151509285478904">Set myButton2 =
oDlg.CloneControl("Button1", "Button2", 30, 30)</paragraph>
</bascode>
+ <embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
<paragraph role="pycode" localize="false" id="pyc_id351619627686732">dlg
= dlg.CloneControl('Button1', 'Button2', 30, 30)</paragraph>
</pycode>
@@ -632,9 +639,9 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<bookmark_value>Dialog service;CreateButton</bookmark_value>
</bookmark>
<h2 id="hd_id501519885886436" localize="false">CreateButton</h2>
- <paragraph role="paragraph" id="par_id381591885776500">Create a new control
of type Button in the current dialog.</paragraph>
+ <paragraph role="paragraph" id="par_id381591885776500">Create a new control
of type <literal>Button</literal> in the current dialog.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
- <paragraph role="paragraph" localize="false"
id="par_CreateButton"><input>svc.CreateButton(opt ControlName: str, opt Place,
Toggle = False, Push = ""): svc</input></paragraph>
+ <paragraph role="paragraph" localize="false"
id="par_CreateButton"><input>svc.CreateButton(ControlName: str, Place: any,
Toggle: bool = False, Push: str = ""): svc</input></paragraph>
<section id="CreateSharedParms">
<embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
<paragraph role="paragraph" id="parm_ControlName"><emph>ControlName</emph>:
the name of the new control. It must not exist yet.</paragraph>
@@ -654,11 +661,11 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<embed href="text/sbasic/shared/00000003.xhp#In_Basic"/>
<bascode>
- <paragraph role="bascode" id="bas_id241688389976612">Set myButton =
oDlg.CreateButton("Button1", Array(20, 20, 60, 15))</paragraph>
+ <paragraph role="bascode" id="bas_id241688389976612" localize="false">Set
myButton = oDlg.CreateButton("Button1", Array(20, 20, 60,
15))</paragraph>
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id861688389993653">myButton =
dlg.CreateButton('Button1', (20, 20, 60, 15))</paragraph>
+ <paragraph role="pycode" id="pyc_id861688389993653"
localize="false">myButton = dlg.CreateButton('Button1', (20, 20, 60,
15))</paragraph>
</pycode>
</section>
@@ -668,20 +675,20 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<bookmark_value>Dialog service;CreateCheckBox</bookmark_value>
</bookmark>
<h2 id="hd_id941688119314514" localize="false">CreateCheckBox</h2>
- <paragraph role="paragraph" id="par_id991591995776500">Create a new control
of type CheckBox in the current dialog.</paragraph>
+ <paragraph role="paragraph" id="par_id991591995776500">Create a new control
of type <literal>CheckBox</literal> in the current dialog.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
- <paragraph role="paragraph" localize="false"
id="par_CreateCheck"><input>svc.CreateCheckBox(opt ControlName: str, opt Place,
Multiline = False): svc</input></paragraph>
+ <paragraph role="paragraph" localize="false"
id="par_CreateCheck"><input>svc.CreateCheckBox(ControlName: str, Place: any,
Multiline: bool = False): svc</input></paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateSharedParms"/>
- <paragraph role="paragraph"
id="par_id241688132171052"><emph>MultiLine</emph>: When True (default = False),
the caption may be displayed on more than one line.</paragraph>
+ <paragraph role="paragraph"
id="par_id241688132171052"><emph>MultiLine</emph>: When <literal>True</literal>
(default = <literal>False</literal>), the caption may be displayed on more than
one line.</paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateReturn"/>
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<embed href="text/sbasic/shared/00000003.xhp#In_Basic"/>
<bascode>
- <paragraph role="bascode" id="bas_id211688391124091">Set myCheckBox =
oDlg.CreateCheckBox("CheckBox1", Array(20, 20, 60, 15), MultiLine :=
True)</paragraph>
+ <paragraph role="bascode" id="bas_id211688391124091" localize="false">Set
myCheckBox = oDlg.CreateCheckBox("CheckBox1", Array(20, 20, 60, 15),
MultiLine := True)</paragraph>
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id711688391128090">myCheckBox =
dlg.CreateCheckBox('CheckBox1', (20, 20, 60, 15), MultiLine = True)</paragraph>
+ <paragraph role="pycode" id="pyc_id711688391128090"
localize="false">myCheckBox = dlg.CreateCheckBox('CheckBox1', (20, 20, 60, 15),
MultiLine = True)</paragraph>
</pycode>
</section>
@@ -691,12 +698,12 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<bookmark_value>Dialog service;CreateComboBox</bookmark_value>
</bookmark>
<h2 id="hd_id941688113914514" localize="false">CreateComboBox</h2>
- <paragraph role="paragraph" id="par_id991591885776500">Create a new control
of type ComboBox in the current dialog.</paragraph>
+ <paragraph role="paragraph" id="par_id991591885776500">Create a new control
of type <literal>ComboBox</literal> in the current dialog.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
- <paragraph role="paragraph" localize="false"
id="par_CreateCombo"><input>svc.CreateComboBox(opt ControlName: str, opt Place,
Border = "3D", DropDown = True, LineCount = 5): svc</input></paragraph>
+ <paragraph role="paragraph" localize="false"
id="par_CreateCombo"><input>svc.CreateComboBox(ControlName: str, Place: any,
Border: str = "3D", DropDown: bool = True, LineCount: num = 5):
svc</input></paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateSharedParms"/>
<paragraph role="paragraph" id="par_id241688132526109"><emph>Border</emph>:
"3D" (default) or "FLAT" or "NONE"</paragraph>
- <paragraph role="paragraph"
id="par_id641688132528598"><emph>DropDown</emph>: When True (default), a drop
down button is displayed</paragraph>
+ <paragraph role="paragraph"
id="par_id641688132528598"><emph>DropDown</emph>: When <literal>True</literal>
(default), a drop down button is displayed</paragraph>
<paragraph role="paragraph"
id="par_id901688132529427"><emph>LineCount</emph>: Specifies the maximum line
count displayed in the drop down (default = 5)</paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateReturn"/>
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
@@ -716,12 +723,12 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<bookmark_value>Dialog service;CreateCurrencyField</bookmark_value>
</bookmark>
<h2 id="hd_id941688119315414" localize="false">CreateCurrencyField</h2>
- <paragraph role="paragraph" id="par_id991591005776500">Create a new control
of type CurrencyField in the current dialog.</paragraph>
+ <paragraph role="paragraph" id="par_id991591005776500">Create a new control
of type <literal>CurrencyField</literal> in the current dialog.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
- <paragraph role="paragraph" localize="false"
id="par_CreateCurrency"><input>svc.CreateCurrencyField(opt ControlName: str,
opt Place, Border ="3D", SpinButton = False, MinValue = -1000000, MaxValue =
+1000000, Increment = 1, Accuracy = 2): svc</input></paragraph>
+ <paragraph role="paragraph" localize="false"
id="par_CreateCurrency"><input>svc.CreateCurrencyField(ControlName: str, Place:
any, Border ="3D", SpinButton: bool = False, MinValue: num = -1000000,
MaxValue: num = +1000000, Increment: num = 1, Accuracy: num = 2):
svc</input></paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateSharedParms"/>
<paragraph role="paragraph" id="par_id511688132750220"><emph>Border</emph>:
"3D" (default) or "FLAT" or "NONE"</paragraph>
- <paragraph role="paragraph"
id="par_id751688132750844"><emph>SpinButton</emph>: when True (default =
False), a spin button is present</paragraph>
+ <paragraph role="paragraph"
id="par_id751688132750844"><emph>SpinButton</emph>: when
<literal>True</literal> (default = <literal>False</literal>), a spin button is
present</paragraph>
<paragraph role="paragraph"
id="par_id741688132751443"><emph>MinValue</emph>: the smallest value that can
be entered in the control. Default = -1000000</paragraph>
<paragraph role="paragraph"
id="par_id361688132752004"><emph>MaxValue</emph>: the largest value that can be
entered in the control. Default = +1000000</paragraph>
<paragraph role="paragraph"
id="par_id371688132752523"><emph>Increment</emph>: the step when the spin
button is pressed. Default = 1</paragraph>
@@ -730,11 +737,11 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<embed href="text/sbasic/shared/00000003.xhp#In_Basic"/>
<bascode>
- <paragraph role="bascode" id="bas_id931688391314834">Set myCurrencyField
= oDlg.CreateCurrencyField("CurrencyField1", Array(20, 20, 60, 15),
SpinButton := True)</paragraph>
+ <paragraph role="bascode" id="bas_id931688391314834" localize="false">Set
myCurrencyField = oDlg.CreateCurrencyField("CurrencyField1",
Array(20, 20, 60, 15), SpinButton := True)</paragraph>
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id41688391319204">myCurrencyField =
dlg.CreateCurrencyField('CurrencyField1', (20, 20, 60, 15), SpinButton =
True)</paragraph>
+ <paragraph role="pycode" id="pyc_id41688391319204"
localize="false">myCurrencyField = dlg.CreateCurrencyField('CurrencyField1',
(20, 20, 60, 15), SpinButton = True)</paragraph>
</pycode>
</section>
@@ -744,23 +751,23 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<bookmark_value>Dialog service;CreateDateField</bookmark_value>
</bookmark>
<h2 id="hd_id491598185886346" localize="false">CreateDateField</h2>
- <paragraph role="paragraph" id="par_id199598185776500">Create a new control
of type DateField in the current dialog.</paragraph>
+ <paragraph role="paragraph" id="par_id199598185776500">Create a new control
of type <literal>DateField</literal> in the current dialog.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
- <paragraph role="paragraph" localize="false"
id="par_CreateDate"><input>svc.CreateDateField(opt ControlName: str, opt Place,
Border = "3D", DropDown = False, opt MinDate, opt MaxDate):
svc</input></paragraph>
+ <paragraph role="paragraph" localize="false"
id="par_CreateDate"><input>svc.CreateDateField(ControlName: str, Place: any,
Border: str = "3D", DropDown: bool = False, opt MinDate: datetime, opt MaxDate:
datetime): svc</input></paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateSharedParms"/>
<paragraph role="paragraph" id="par_id831688133418579"><emph>Border</emph>:
"3D" (default) or "FLAT" or "NONE"</paragraph>
- <paragraph role="paragraph"
id="par_id521688133422980"><emph>DropDown</emph>: when True (default = False),
a dropdown button is shown</paragraph>
+ <paragraph role="paragraph"
id="par_id521688133422980"><emph>DropDown</emph>: when <literal>True</literal>
(default = <literal>False</literal>), a dropdown button is shown</paragraph>
<paragraph role="paragraph"
id="par_id361688133423860"><emph>MinDate</emph>: the smallest date that can be
entered in the control. Default = 1900-01-01</paragraph>
- <paragraph role="paragraph"
id="par_id221688133424380"><emph>MaxDate</emph>: the largest Date that can be
entered in the control. Default = 2200-12-31</paragraph>
+ <paragraph role="paragraph"
id="par_id221688133424380"><emph>MaxDate</emph>: the largest date that can be
entered in the control. Default = 2200-12-31</paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateReturn"/>
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<embed href="text/sbasic/shared/00000003.xhp#In_Basic"/>
<bascode>
- <paragraph role="bascode" id="bas_id431688391456485">Set myDateField =
oDlg.CreateDateField("DateField1", Array(20, 20, 60, 15), Dropdown :=
True)</paragraph>
+ <paragraph role="bascode" id="bas_id431688391456485" localize="false">Set
myDateField = oDlg.CreateDateField("DateField1", Array(20, 20, 60,
15), Dropdown := True)</paragraph>
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id491688391462954">myDateField =
dlg.CreateDateField('DateField1', (20, 20, 60, 15), Dropdown = True)</paragraph>
+ <paragraph role="pycode" id="pyc_id491688391462954"
localize="false">myDateField = dlg.CreateDateField('DateField1', (20, 20, 60,
15), Dropdown = True)</paragraph>
</pycode>
</section>
@@ -770,20 +777,20 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<bookmark_value>Dialog service;CreateFileControl</bookmark_value>
</bookmark>
<h2 id="hd_id491598158586436" localize="false">CreateFileControl</h2>
- <paragraph role="paragraph" id="par_id199591885776511">Create a new control
of type FileControl in the current dialog.</paragraph>
+ <paragraph role="paragraph" id="par_id199591885776511">Create a new control
of type <literal>FileControl</literal> in the current dialog.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
- <paragraph role="paragraph" localize="false"
id="par_CreateFileControl"><input>svc.CreateFileControl(opt ControlName: str,
opt Place, Border = "3D"): svc</input></paragraph>
+ <paragraph role="paragraph" localize="false"
id="par_CreateFileControl"><input>svc.CreateFileControl(ControlName: str,
Place: any, Border: str = "3D"): svc</input></paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateSharedParms"/>
<paragraph role="paragraph"
id="par_id1001688133702877"><emph>Border</emph>: "3D" (default) or
"FLAT" or "NONE"</paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateReturn"/>
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<embed href="text/sbasic/shared/00000003.xhp#In_Basic"/>
<bascode>
- <paragraph role="bascode" id="bas_id741688391752376">Set myFileControl =
oDlg.CreateFileControl("FileControl1", Array(20, 20, 60,
15))</paragraph>
+ <paragraph role="bascode" id="bas_id741688391752376" localize="false">Set
myFileControl = oDlg.CreateFileControl("FileControl1", Array(20, 20,
60, 15))</paragraph>
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id181688391760784">myFileControl =
dlg.CreateFileControl('FileControl1', (20, 20, 60, 15))</paragraph>
+ <paragraph role="pycode" id="pyc_id181688391760784"
localize="false">myFileControl = dlg.CreateFileControl('FileControl1', (20, 20,
60, 15))</paragraph>
</pycode>
</section>
@@ -793,20 +800,20 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<bookmark_value>Dialog service;CreateFixedLine</bookmark_value>
</bookmark>
<h2 id="hd_id491598185648836" localize="false">CreateFixedLine</h2>
- <paragraph role="paragraph" id="par_id199195885776500">Create a new control
of type FixedLine in the current dialog.</paragraph>
+ <paragraph role="paragraph" id="par_id199195885776500">Create a new control
of type <literal>FixedLine</literal> in the current dialog.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
- <paragraph role="paragraph" localize="false"
id="par_CreateFixedLine"><input>svc.CreateFixedLine(opt ControlName: str, opt
Place, Orientation: str): svc</input></paragraph>
+ <paragraph role="paragraph" localize="false"
id="par_CreateFixedLine"><input>svc.CreateFixedLine(ControlName: str, Place:
any, Orientation: str): svc</input></paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateSharedParms"/>
<paragraph role="paragraph"
id="par_id351688134656035"><emph>Orientation</emph>: "H[orizontal]"
or "V[ertical]".</paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateReturn"/>
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<embed href="text/sbasic/shared/00000003.xhp#In_Basic"/>
<bascode>
- <paragraph role="bascode" id="bas_id301688392274784">Set myFixedLine =
oDlg.CreateFixedLine("FixedLine1", Array(20, 20, 60, 15), Orientation
:= "vertical")</paragraph>
+ <paragraph role="bascode" id="bas_id301688392274784" localize="false">Set
myFixedLine = oDlg.CreateFixedLine("FixedLine1", Array(20, 20, 60,
15), Orientation := "vertical")</paragraph>
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id491688392278136">myFixedLine =
dlg.CreateFixedLine('FixedLine1', (20, 20, 60, 15), Orientation =
'vertical')</paragraph>
+ <paragraph role="pycode" id="pyc_id491688392278136"
localize="false">myFixedLine = dlg.CreateFixedLine('FixedLine1', (20, 20, 60,
15), Orientation = 'vertical')</paragraph>
</pycode>
</section>
@@ -817,23 +824,23 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<bookmark_value>Dialog service;CreateFixedText</bookmark_value>
</bookmark>
<h2 id="hd_id499998185886436" localize="false">CreateFixedText</h2>
- <paragraph role="paragraph" id="par_id199721885776533">Create a new control
of type FixedText in the current dialog.</paragraph>
+ <paragraph role="paragraph" id="par_id199721885776533">Create a new control
of type <literal>FixedText</literal> in the current dialog.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
- <paragraph role="paragraph" localize="false"
id="par_CreateFixedText"><input>svc.CreateFixedText(opt ControlName: str, opt
Place, Border = "3D", MultiLine = False, Align = "LEFT", VerticalAlign =
"TOP"): svc</input></paragraph>
+ <paragraph role="paragraph" localize="false"
id="par_CreateFixedText"><input>svc.CreateFixedText(ControlName: str, Place:
any, Border: str = "3D", MultiLine: bool = False, Align: str = "LEFT",
VerticalAlign: str = "TOP"): svc</input></paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateSharedParms"/>
<paragraph role="paragraph" id="par_id781688134809419"><emph>Border</emph>:
"NONE" (default) or "FLAT" or "3D"</paragraph>
- <paragraph role="paragraph"
id="par_id311688134819532"><emph>Multiline</emph>: When True (default = False),
the caption may be displayed on more than one line</paragraph>
+ <paragraph role="paragraph"
id="par_id311688134819532"><emph>Multiline</emph>: When <literal>True</literal>
(default = <literal>False</literal>), the caption may be displayed on more than
one line</paragraph>
<paragraph role="paragraph" id="par_id121688134820022"><emph>Align</emph>:
horizontal alignment, "LEFT" (default) or "CENTER" or
"RIGHT"</paragraph>
<paragraph role="paragraph"
id="par_id316881340820555"><emph>VerticalAlign</emph>: vertical alignment,
"TOP" (default) or "MIDDLE" or
"BOTTOM"</paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateReturn"/>
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<embed href="text/sbasic/shared/00000003.xhp#In_Basic"/>
<bascode>
- <paragraph role="bascode" id="bas_id521688392367919">Set myFixedText =
oDlg.CreateFixedText("FixedText1", Array(20, 20, 60, 15), MultiLine
:= True)</paragraph>
+ <paragraph role="bascode" id="bas_id521688392367919" localize="false">Set
myFixedText = oDlg.CreateFixedText("FixedText1", Array(20, 20, 60,
15), MultiLine := True)</paragraph>
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id971688392372871">myFixedText =
dlg.CreateFixedText('FixedText1', (20, 20, 60, 15), MultiLine =
True)</paragraph>
+ <paragraph role="pycode" id="pyc_id971688392372871"
localize="false">myFixedText = dlg.CreateFixedText('FixedText1', (20, 20, 60,
15), MultiLine = True)</paragraph>
</pycode>
</section>
@@ -843,23 +850,23 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<bookmark_value>Dialog service;CreateFormattedField</bookmark_value>
</bookmark>
<h2 id="hd_id491598185997436" localize="false">CreateFormattedField</h2>
- <paragraph role="paragraph" id="par_id199591885776500">Create a new control
of type FormattedField in the current dialog.</paragraph>
+ <paragraph role="paragraph" id="par_id199591885776500">Create a new control
of type <literal>FormattedField</literal> in the current dialog.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
- <paragraph role="paragraph" localize="false"
id="par_CreateFormatFld"><input>svc.CreateFormattedField(opt ControlName: str,
opt Place, Border = "3D", SpinButton = False, MinValue = -1000000, MaxValue =
+1000000): svc</input></paragraph>
+ <paragraph role="paragraph" localize="false"
id="par_CreateFormatFld"><input>svc.CreateFormattedField(ControlName: str,
Place: any, Border: str = "3D", SpinButton: bool = False, MinValue: num =
-1000000, MaxValue: num = +1000000): svc</input></paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateSharedParms"/>
<paragraph role="paragraph" id="par_id561688135183954"><emph>Border</emph>:
"3D" (default) or "FLAT" or "NONE"</paragraph>
- <paragraph role="paragraph"
id="par_id691688135184764"><emph>SpinButton</emph>: when True (default =
False), a spin button is present</paragraph>
+ <paragraph role="paragraph"
id="par_id691688135184764"><emph>SpinButton</emph>: when
<literal>True</literal> (default = <literal>False</literal>), a spin button is
present</paragraph>
<paragraph role="paragraph"
id="par_id941688135185218"><emph>MinValue</emph>: the smallest value that can
be entered in the control. Default = -1000000</paragraph>
<paragraph role="paragraph"
id="par_id881688135185626"><emph>MaxValue</emph>: the largest value that can be
entered in the control. Default = +1000000</paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateReturn"/>
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<embed href="text/sbasic/shared/00000003.xhp#In_Basic"/>
<bascode>
- <paragraph role="bascode" id="bas_id211688392640319">Set myFormattedField
= oDlg.CreateFormattedField("FormattedField1", Array(20, 20, 60, 15),
SpinButton := True)</paragraph>
+ <paragraph role="bascode" id="bas_id211688392640319" localize="false">Set
myFormattedField = oDlg.CreateFormattedField("FormattedField1",
Array(20, 20, 60, 15), SpinButton := True)</paragraph>
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id481688392650918">myFormattedField =
dlg.CreateFormattedField('FormattedField1', (20, 20, 60, 15), SpinButton =
True)</paragraph>
+ <paragraph role="pycode" id="pyc_id481688392650918"
localize="false">myFormattedField = dlg.CreateFormattedField('FormattedField1',
(20, 20, 60, 15), SpinButton = True)</paragraph>
</pycode>
</section>
@@ -869,19 +876,19 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<bookmark_value>Dialog service;CreateGroupBox</bookmark_value>
</bookmark>
<h2 id="hd_id496608185886436" localize="false">CreateGroupBox</h2>
- <paragraph role="paragraph" id="par_id100691885776500">Create a new control
of type GroupBox in the current dialog.</paragraph>
+ <paragraph role="paragraph" id="par_id100691885776500">Create a new control
of type <literal>GroupBox</literal> in the current dialog.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
- <paragraph role="paragraph" localize="false"
id="par_CreateGroupBox"><input>svc.CreateGroupBox(opt ControlName: str, opt
Place): svc</input></paragraph>
+ <paragraph role="paragraph" localize="false"
id="par_CreateGroupBox"><input>svc.CreateGroupBox(ControlName: str, Place:
any): svc</input></paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateSharedParms"/>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateReturn"/>
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<embed href="text/sbasic/shared/00000003.xhp#In_Basic"/>
<bascode>
- <paragraph role="bascode" id="bas_id1001688392702670">Set myGroupBox =
oDlg.CreateGroupBox("GroupBox1", Array(20, 20, 60, 15))</paragraph>
+ <paragraph role="bascode" id="bas_id1001688392702670"
localize="false">Set myGroupBox = oDlg.CreateGroupBox("GroupBox1",
Array(20, 20, 60, 15))</paragraph>
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id941688392712142">myGroupBox =
dlg.CreateGroupBox('GroupBox1', (20, 20, 60, 15))</paragraph>
+ <paragraph role="pycode" id="pyc_id941688392712142"
localize="false">myGroupBox = dlg.CreateGroupBox('GroupBox1', (20, 20, 60,
15))</paragraph>
</pycode>
</section>
@@ -891,23 +898,23 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<bookmark_value>Dialog service;CreateHyperlink</bookmark_value>
</bookmark>
<h2 id="hd_id496608185886547" localize="false">CreateHyperlink</h2>
- <paragraph role="paragraph" id="par_id101701885776500">Create a new control
of type Hyperlink in the current dialog.</paragraph>
+ <paragraph role="paragraph" id="par_id101701885776500">Create a new control
of type <literal>Hyperlink</literal> in the current dialog.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
- <paragraph role="paragraph" localize="false"
id="par_CreateHyperlink"><input>svc.CreateHyperlink(opt ControlName: str, opt
Place, Border = "NONE", MultiLine = False, Align = "LEFT", VerticalAlign =
"TOP"): svc</input></paragraph>
+ <paragraph role="paragraph" localize="false"
id="par_CreateHyperlink"><input>svc.CreateHyperlink(ControlName: str, Place:
any, Border: str = "NONE", MultiLine: bool = False, Align: str = "LEFT",
VerticalAlign: str = "TOP"): svc</input></paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateSharedParms"/>
<paragraph role="paragraph" id="par_id731688542076471"><emph>Border</emph>:
"NONE" (default) or "FLAT" or "3D"</paragraph>
- <paragraph role="paragraph"
id="par_id241688542076988"><emph>MultiLine</emph>: When True (default = False),
the caption may be displayed on more than one line</paragraph>
+ <paragraph role="paragraph"
id="par_id241688542076988"><emph>MultiLine</emph>: When <literal>True</literal>
(default = <literal>False</literal>), the caption may be displayed on more than
one line</paragraph>
<paragraph role="paragraph" id="par_id831688542077407"><emph>Align</emph>:
horizontal alignment, "LEFT" (default) or "CENTER" or
"RIGHT"</paragraph>
<paragraph role="paragraph"
id="par_id941688542077873"><emph>VerticalAlign</emph>: vertical alignment,
"TOP" (default) or "MIDDLE" or
"BOTTOM"</paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateReturn"/>
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<embed href="text/sbasic/shared/00000003.xhp#In_Basic"/>
<bascode>
- <paragraph role="bascode" id="bas_id1012788392702670">Set myHyperlink =
oDlg.CreateHyperlink("Hyperlink1", Array(20, 20, 60, 15), MultiLine
:= True)</paragraph>
+ <paragraph role="bascode" id="bas_id1012788392702670"
localize="false">Set myHyperlink = oDlg.CreateHyperlink("Hyperlink1",
Array(20, 20, 60, 15), MultiLine := True)</paragraph>
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id941688470312142">myHyperlink =
dlg.CreateHyperlink('Hyperlink1', (20, 20, 60, 15), MultiLine =
True)</paragraph>
+ <paragraph role="pycode" id="pyc_id941688470312142"
localize="false">myHyperlink = dlg.CreateHyperlink('Hyperlink1', (20, 20, 60,
15), MultiLine = True)</paragraph>
</pycode>
</section>
@@ -917,9 +924,9 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<bookmark_value>Dialog service;CreateImageControl</bookmark_value>
</bookmark>
<h2 id="hd_id496598185886436" localize="false">CreateImageControl</h2>
- <paragraph role="paragraph" id="par_id199591885776504">Create a new control
of type ImageControl in the current dialog.</paragraph>
+ <paragraph role="paragraph" id="par_id199591885776504">Create a new control
of type <literal>ImageControl</literal> in the current dialog.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
- <paragraph role="paragraph" localize="false"
id="par_CreateImageControl"><input>svc.CreateImageControl(opt ControlName: str,
opt Place, Border = "3D", Scale = "FITTOSIZE"): svc</input></paragraph>
+ <paragraph role="paragraph" localize="false"
id="par_CreateImageControl"><input>svc.CreateImageControl(ControlName: str,
Place: any, Border: str = "3D", Scale: str = "FITTOSIZE"):
svc</input></paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateSharedParms"/>
<paragraph role="paragraph" id="par_id551688135418418"><emph>Border</emph>:
"3D" (default) or "FLAT" or "NONE"</paragraph>
<paragraph role="paragraph" id="par_id431688135405342"><emph>Scale</emph>:
One of next values: "FITTOSIZE" (default), "KEEPRATIO" or
"NO"</paragraph>
@@ -927,11 +934,11 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<embed href="text/sbasic/shared/00000003.xhp#In_Basic"/>
<bascode>
- <paragraph role="bascode" id="bas_id911688392874655">Set myImageControl =
oDlg.CreateImageControl("ImageControl1", Array(20, 20, 60,
15))</paragraph>
+ <paragraph role="bascode" id="bas_id911688392874655" localize="false">Set
myImageControl = oDlg.CreateImageControl("ImageControl1", Array(20,
20, 60, 15))</paragraph>
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id271688392883751">myImageControl =
dlg.CreateImageControl('ImageControl1", (20, 20, 60, 15))</paragraph>
+ <paragraph role="pycode" id="pyc_id271688392883751"
localize="false">myImageControl = dlg.CreateImageControl('ImageControl1", (20,
20, 60, 15))</paragraph>
</pycode>
</section>
@@ -941,23 +948,23 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<bookmark_value>Dialog service;CreateListBox</bookmark_value>
</bookmark>
<h2 id="hd_id497598185886436" localize="false">CreateListBox</h2>
- <paragraph role="paragraph" id="par_id199591885776506">Create a new control
of type ListBox in the current dialog.</paragraph>
+ <paragraph role="paragraph" id="par_id199591885776506">Create a new control
of type <literal>ListBox</literal> in the current dialog.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
- <paragraph role="paragraph" localize="false"
id="par_CreateListBox"><input>svc.CreateListBox(opt ControlName: str, opt
Place, Border = "3D", DropDown = True, LineCount = 5, MultiSelect = False):
svc</input></paragraph>
+ <paragraph role="paragraph" localize="false"
id="par_CreateListBox"><input>svc.CreateListBox(ControlName: str, Place: any,
Border: str = "3D", DropDown: bool = True, LineCount: num = 5, MultiSelect:
bool = False): svc</input></paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateSharedParms"/>
<paragraph role="paragraph"
id="par_id1001688135548955"><emph>Border</emph>: "3D" (default) or
"FLAT" or "NONE"</paragraph>
- <paragraph role="paragraph"
id="par_id11688135550412"><emph>DropDown</emph>: When True (default), a drop
down button is displayed</paragraph>
+ <paragraph role="paragraph"
id="par_id11688135550412"><emph>DropDown</emph>: When <literal>True</literal>
(default), a drop down button is displayed</paragraph>
<paragraph role="paragraph"
id="par_id121688135552418"><emph>LineCount</emph>: Specifies the maximum line
count displayed in the drop down (default = 5)</paragraph>
- <paragraph role="paragraph"
id="par_id661688135552802"><emph>MultiSelect</emph>: When True, more than 1
entry may be selected. Default = False</paragraph>
+ <paragraph role="paragraph"
id="par_id661688135552802"><emph>MultiSelect</emph>: When
<literal>True</literal>, more than 1 entry may be selected. Default =
<literal>False</literal></paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateReturn"/>
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<embed href="text/sbasic/shared/00000003.xhp#In_Basic"/>
<bascode>
- <paragraph role="bascode" id="bas_id771688392940502">Set myListBox =
oDlg.CreateListBox("ListBox1", Array(20, 20, 60, 15), Dropdown :=
True, MultiSelect := True)</paragraph>
+ <paragraph role="bascode" id="bas_id771688392940502" localize="false">Set
myListBox = oDlg.CreateListBox("ListBox1", Array(20, 20, 60, 15),
Dropdown := True, MultiSelect := True)</paragraph>
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id921688392950230">myListBox =
dlg.CreateListBox('ListBox1', (20, 20, 60, 15), Dropdown = True, MultiSelect =
True)</paragraph>
+ <paragraph role="pycode" id="pyc_id921688392950230"
localize="false">myListBox = dlg.CreateListBox('ListBox1', (20, 20, 60, 15),
Dropdown = True, MultiSelect = True)</paragraph>
</pycode>
</section>
@@ -967,12 +974,12 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<bookmark_value>Dialog service;CreateNumericField</bookmark_value>
</bookmark>
<h2 id="hd_id498598185886436" localize="false">CreateNumericField</h2>
- <paragraph role="paragraph" id="par_id199591885776510">Create a new control
of type NumericField in the current dialog.</paragraph>
+ <paragraph role="paragraph" id="par_id199591885776510">Create a new control
of type <literal>NumericField</literal> in the current dialog.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
- <paragraph role="paragraph" localize="false"
id="par_CreateNumFld"><input>svc.CreateNumericField(opt ControlName: str, opt
Place, Border = "3D", SpinButton = False, MinValue = -1000000, MaxValue =
1000000, Increment = 1, Accuracy = 2): svc</input></paragraph>
+ <paragraph role="paragraph" localize="false"
id="par_CreateNumFld"><input>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</input></paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateSharedParms"/>
<paragraph role="paragraph" id="par_id841688135885946"><emph>Border</emph>:
"3D" (default) or "FLAT" or "NONE"</paragraph>
- <paragraph role="paragraph"
id="par_id781688135886499"><emph>SpinButton</emph>: when True (default =
False), a spin button is present</paragraph>
+ <paragraph role="paragraph"
id="par_id781688135886499"><emph>SpinButton</emph>: when
<literal>True</literal> (default = <literal>False</literal>), a spin button is
present</paragraph>
<paragraph role="paragraph"
id="par_id481688135887010"><emph>MinValue</emph>: the smallest value that can
be entered in the control. Default = -1000000</paragraph>
<paragraph role="paragraph"
id="par_id371688135887594"><emph>MaxValue</emph>: the largest value that can be
entered in the control. Default = +1000000</paragraph>
<paragraph role="paragraph"
id="par_id191688135888122"><emph>Increment</emph>: the step when the spin
button is pressed. Default = 1</paragraph>
@@ -981,11 +988,11 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<embed href="text/sbasic/shared/00000003.xhp#In_Basic"/>
<bascode>
- <paragraph role="bascode" id="bas_id1001688393400045">Set myNumericField
= oDlg.CreateNumericField("NumericField1", Array(20, 20, 60, 15),
SpinButton := True)</paragraph>
+ <paragraph role="bascode" id="bas_id1001688393400045"
localize="false">Set myNumericField =
oDlg.CreateNumericField("NumericField1", Array(20, 20, 60, 15),
SpinButton := True)</paragraph>
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id951688393408429">myNumericField =
dlg.CreateNumericField('NumericField1', (20, 20, 60, 15), SpinButton =
True)</paragraph>
+ <paragraph role="pycode" id="pyc_id951688393408429"
localize="false">myNumericField = dlg.CreateNumericField('NumericField1', (20,
20, 60, 15), SpinButton = True)</paragraph>
</pycode>
</section>
@@ -995,9 +1002,9 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<bookmark_value>Dialog service;CreatePatternField</bookmark_value>
</bookmark>
<h2 id="hd_id491598185897536" localize="false">CreatePatternField</h2>
- <paragraph role="paragraph" id="par_id200591996776500">Create a new control
of type PatternField in the current dialog.</paragraph>
+ <paragraph role="paragraph" id="par_id200591996776500">Create a new control
of type <literal>PatternField</literal> in the current dialog.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
- <paragraph role="paragraph" localize="false"
id="par_CreatePattern"><input>svc.CreatePatternField(opt ControlName: str, opt
Place, Border = "3D", EditMask: str, opt LiteralMax: str):
svc</input></paragraph>
+ <paragraph role="paragraph" localize="false"
id="par_CreatePattern"><input>svc.CreatePatternField(ControlName: str, Place:
any, Border: str = "3D", EditMask: str, opt LiteralMax: str):
svc</input></paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateSharedParms"/>
<paragraph role="paragraph" id="par_id251688136173107"><emph>Border</emph>:
"3D" (default) or "FLAT" or "NONE"</paragraph>
<paragraph role="paragraph"
id="par_id631688136173778"><emph>EditMask</emph>: a character code that
determines what the user may enter<br/>Refer to <link
href="https://wiki.documentfoundation.org/Documentation/DevGuide/Graphical_User_Interfaces#Pattern_Field";>Pattern_Field</link>
in the wiki for more information.</paragraph>
@@ -1006,11 +1013,11 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<embed href="text/sbasic/shared/00000003.xhp#In_Basic"/>
<bascode>
- <paragraph role="bascode" id="bas_id1001688393462780">Set myPatternField
= oDlg.CreatePatternField("PatternField1", Array(20, 20, 60, 15),
EditMask := "NNLNNLLLLL", LiteralMask :=
"__.__.2002")</paragraph>
+ <paragraph role="bascode" id="bas_id1001688393462780"
localize="false">Set myPatternField =
oDlg.CreatePatternField("PatternField1", Array(20, 20, 60, 15),
EditMask := "NNLNNLLLLL", LiteralMask :=
"__.__.2002")</paragraph>
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id231688393481925">myPatternField =
dlg.CreatePatternField('PatternField1', (20, 20, 60, 15), EditMask =
'NNLNNLLLLL', LiteralMask = '__.__.2002')</paragraph>
+ <paragraph role="pycode" id="pyc_id231688393481925"
localize="false">myPatternField = dlg.CreatePatternField('PatternField1', (20,
20, 60, 15), EditMask = 'NNLNNLLLLL', LiteralMask = '__.__.2002')</paragraph>
</pycode>
</section>
@@ -1020,9 +1027,9 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<bookmark_value>Dialog service;CreateProgressBar</bookmark_value>
</bookmark>
<h2 id="hd_id492608185886436" localize="false">CreateProgressBar</h2>
- <paragraph role="paragraph" id="par_id311591885776500">Create a new control
of type ProgressBar in the current dialog.</paragraph>
+ <paragraph role="paragraph" id="par_id311591885776500">Create a new control
of type <literal>ProgressBar</literal> in the current dialog.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
- <paragraph role="paragraph" localize="false"
id="par_CreateProgressBar"><input>svc.CreateProgressBar(opt ControlName: str,
opt Place, Border = "3D", MinValue = 0, MaxValue = 100): svc</input></paragraph>
+ <paragraph role="paragraph" localize="false"
id="par_CreateProgressBar"><input>svc.CreateProgressBar(ControlName: str, opt
Place: any, Border: str = "3D", MinValue: num = 0, MaxValue: num = 100):
svc</input></paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateSharedParms"/>
<paragraph role="paragraph" id="par_id551688136587329"><emph>Border</emph>:
"3D" (default) or "FLAT" or "NONE"</paragraph>
<paragraph role="paragraph"
id="par_id411688136587778"><emph>MinValue</emph>: the smallest value that can
be entered in the control. Default = 0</paragraph>
@@ -1031,11 +1038,11 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<embed href="text/sbasic/shared/00000003.xhp#In_Basic"/>
<bascode>
- <paragraph role="bascode" id="bas_id361688393568688">Set myProgressBar =
oDlg.CreateProgressBar("ProgressBar1", Array(20, 20, 60, 15),
MaxValue := 1000)</paragraph>
+ <paragraph role="bascode" id="bas_id361688393568688" localize="false">Set
myProgressBar = oDlg.CreateProgressBar("ProgressBar1", Array(20, 20,
60, 15), MaxValue := 1000)</paragraph>
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id971688393576061">myProgressBar =
dlg.CreateProgressBar('ProgressBar1', (20, 20, 60, 15), MaxValue =
1000)</paragraph>
+ <paragraph role="pycode" id="pyc_id971688393576061"
localize="false">myProgressBar = dlg.CreateProgressBar('ProgressBar1', (20, 20,
60, 15), MaxValue = 1000)</paragraph>
</pycode>
</section>
@@ -1045,11 +1052,11 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<bookmark_value>Dialog service;CreateRadioButton</bookmark_value>
</bookmark>
<h2 id="hd_id491598296886436" localize="false">CreateRadioButton</h2>
- <paragraph role="paragraph" id="par_id200502985776500">Create a new control
of type RadioButton in the current dialog.</paragraph>
+ <paragraph role="paragraph" id="par_id200502985776500">Create a new control
of type <literal>RadioButton</literal> in the current dialog.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
- <paragraph role="paragraph" localize="false"
id="par_CreateRadioBtn"><input>svc.CreateRadioButton(opt ControlName: str, opt
Place, MultiLine = False): svc</input></paragraph>
+ <paragraph role="paragraph" localize="false"
id="par_CreateRadioBtn"><input>svc.CreateRadioButton(ControlName: str, Place:
any, MultiLine: bool = False): svc</input></paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateSharedParms"/>
- <paragraph role="paragraph"
id="par_id211688136829297"><emph>MultiLine</emph>: When True (default = False),
the caption may be displayed on more than one line</paragraph>
+ <paragraph role="paragraph"
id="par_id211688136829297"><emph>MultiLine</emph>: When <literal>True</literal>
(default = <literal>False</literal>), the caption may be displayed on more than
one line</paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateReturn"/>
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<embed href="text/sbasic/shared/00000003.xhp#In_Basic"/>
@@ -1068,9 +1075,9 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<bookmark_value>Dialog service;CreateScrollBar</bookmark_value>
</bookmark>
<h2 id="hd_id491598196886436" localize="false">CreateScrollBar</h2>
- <paragraph role="paragraph" id="par_id200591886886500">Create a new control
of type ScrollBar in the current dialog.</paragraph>
+ <paragraph role="paragraph" id="par_id200591886886500">Create a new control
of type <literal>ScrollBar</literal> in the current dialog.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
- <paragraph role="paragraph" localize="false"
id="par_CreateScrollBar"><input>svc.CreateScrollBar(opt ControlName: str, opt
Place, Orientation: str, Border = "3D", MinValue = 0, MaxValue = 100):
svc</input></paragraph>
+ <paragraph role="paragraph" localize="false"
id="par_CreateScrollBar"><input>svc.CreateScrollBar(ControlName: str, Place,
Orientation: str, Border: str = "3D", MinValue: num = 0, MaxValue: num = 100):
svc</input></paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateSharedParms"/>
<paragraph role="paragraph"
id="par_id731688136882518"><emph>Orientation</emph>: H[orizontal] or
V[ertical]</paragraph>
<paragraph role="paragraph" id="par_id341688136882960"><emph>Border</emph>:
"3D" (default) or "FLAT" or "NONE"</paragraph>
@@ -1080,11 +1087,11 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<embed href="text/sbasic/shared/00000003.xhp#In_Basic"/>
<bascode>
- <paragraph role="bascode" id="bas_id881688393719078">Set myScrollBar =
oDlg.CreateScrollBar("ScrollBar1", Array(20, 20, 60, 15), MaxValue :=
1000)</paragraph>
+ <paragraph role="bascode" id="bas_id881688393719078" localize="false">Set
myScrollBar = oDlg.CreateScrollBar("ScrollBar1", Array(20, 20, 60,
15), MaxValue := 1000)</paragraph>
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id551688393726542">myScrollBar =
dialog.CreateScrollBar('ScrollBar1', (20, 20, 60, 15), MaxValue =
1000)</paragraph>
+ <paragraph role="pycode" id="pyc_id551688393726542"
localize="false">myScrollBar = dialog.CreateScrollBar('ScrollBar1', (20, 20,
60, 15), MaxValue = 1000)</paragraph>
</pycode>
</section>
@@ -1094,24 +1101,24 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<bookmark_value>Dialog service;CreateTableControl</bookmark_value>
</bookmark>
<h2 id="hd_id4918951858TableCtrl" localize="false">CreateTableControl</h2>
- <paragraph role="paragraph" id="par_id200502985776722">Create a new control
of type TableControl in the current dialog.</paragraph>
+ <paragraph role="paragraph" id="par_id200502985776722">Create a new control
of type <literal>TableControl</literal> in the current dialog.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
- <paragraph role="paragraph" localize="false"
id="par_CreateTableCtrl"><input>svc.CreateTableControl(opt ControlName: str,
opt Place, Border, RowHeaders, ColumnHeaders, ScrollBars, GridLines):
svc</input></paragraph>
+ <paragraph role="paragraph" localize="false"
id="par_CreateTableCtrl"><input>svc.CreateTableControl(ControlName: str, Place:
any, Border: str = "3D", RowHeaders: bool = True, ColumnHeaders: bool = True,
ScrollBars: str = "N", GridLines: bool = False): svc</input></paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateSharedParms"/>
<paragraph role="paragraph" id="par_id541688393982300"><emph>Border</emph>:
"3D" (default) or "FLAT" or "NONE"</paragraph>
- <paragraph role="paragraph"
id="par_id351688393983486"><emph>RowHeaders</emph>: when True (default), the
row Headers are shown</paragraph>
- <paragraph role="paragraph"
id="par_id941688393983846"><emph>ColumnHeaders</emph>: when True (default), the
column Headers are shown</paragraph>
+ <paragraph role="paragraph"
id="par_id351688393983486"><emph>RowHeaders</emph>: when
<literal>True</literal> (default), the row Headers are shown</paragraph>
+ <paragraph role="paragraph"
id="par_id941688393983846"><emph>ColumnHeaders</emph>: when
<literal>True</literal> (default), the column Headers are shown</paragraph>
<paragraph role="paragraph"
id="par_id141688393984239"><emph>ScrollBars</emph>: H[orizontal] or V[ertical]
or B[oth] or N[one] (default). Scrollbars appear dynamically when they are
needed.</paragraph>
- <paragraph role="paragraph"
id="par_id741688393984702"><emph>GridLines</emph>: when True (default = False)
horizontal and vertical lines are painted between the grid cells</paragraph>
+ <paragraph role="paragraph"
id="par_id741688393984702"><emph>GridLines</emph>: when <literal>True</literal>
(default = <literal>False</literal>) horizontal and vertical lines are painted
between the grid cells</paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateReturn"/>
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<embed href="text/sbasic/shared/00000003.xhp#In_Basic"/>
<bascode>
- <paragraph role="bascode" id="bas_id901688393903227">Set myTableControl =
oDlg.CreateTableControl("TableControl1", Array(20, 20, 60, 15),
ScrollBars := "B")</paragraph>
+ <paragraph role="bascode" id="bas_id901688393903227" localize="false">Set
myTableControl = oDlg.CreateTableControl("TableControl1", Array(20,
20, 60, 15), ScrollBars := "B")</paragraph>
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id201688393912277">myTableControl =
dlg.CreateTableControl('TableControl1', (20, 20, 60, 15), ScrollBars =
'B')</paragraph>
+ <paragraph role="pycode" id="pyc_id201688393912277"
localize="false">myTableControl = dlg.CreateTableControl('TableControl1', (20,
20, 60, 15), ScrollBars = 'B')</paragraph>
</pycode>
</section>
@@ -1121,22 +1128,22 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<bookmark_value>Dialog service;CreateTextField</bookmark_value>
</bookmark>
<h2 id="hd_id491598186886436" localize="false">CreateTextField</h2>
- <paragraph role="paragraph" id="par_id200591895776500">Create a new control
of type TextField in the current dialog.</paragraph>
+ <paragraph role="paragraph" id="par_id200591895776500">Create a new control
of type <literal>TextField</literal> in the current dialog.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
- <paragraph role="paragraph" localize="false"
id="par_CreateTextFld"><input>svc.CreateTextField(opt ControlName: str, opt
Place, Border, MultiLine, MaximumLength, PasswordCharacter):
svc</input></paragraph>
+ <paragraph role="paragraph" localize="false"
id="par_CreateTextFld"><input>svc.CreateTextField(ControlName: str, Place: any,
Border: str = "3D", MultiLine: bool = False, MaximumLength: num = 0,
PasswordCharacter: str = ""): svc</input></paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateSharedParms"/>
<paragraph role="paragraph" id="par_id281688394635114"><emph>Border</emph>:
"3D" (default) or "FLAT" or "NONE"</paragraph>
- <paragraph role="paragraph"
id="par_id341688394635645"><emph>MultiLine</emph>: When True (default = False),
the caption may be displayed on more than one line</paragraph>
+ <paragraph role="paragraph"
id="par_id341688394635645"><emph>MultiLine</emph>: When <literal>True</literal>
(default = <literal>False</literal>), the caption may be displayed on more than
one line</paragraph>
<paragraph role="paragraph"
id="par_id671688394636092"><emph>MaximumLength</emph>: the maximum character
count (default = 0 meaning unlimited)</paragraph>
<paragraph role="paragraph"
id="par_id231688394641827"><emph>PasswordCharacter</emph>: a single character
specifying the echo for a password text field (default =
"")</paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateReturn"/>
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<embed href="text/sbasic/shared/00000003.xhp#In_Basic"/>
- <bascode><paragraph role="bascode" id="bas_id171688394748227">Set
myTextField = oDlg.CreateTextField("TextField1", Array(20, 20, 120,
50), MultiLine := True)</paragraph>
+ <bascode><paragraph role="bascode" id="bas_id171688394748227"
localize="false">Set myTextField = oDlg.CreateTextField("TextField1",
Array(20, 20, 120, 50), MultiLine := True)</paragraph>
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id651688394757252">myTextField =
dlg.CreateTextField('TextField1', (20, 20, 120, 50), MultiLine =
True)</paragraph>
+ <paragraph role="pycode" id="pyc_id651688394757252"
localize="false">myTextField = dlg.CreateTextField('TextField1', (20, 20, 120,
50), MultiLine = True)</paragraph>
</pycode>
</section>
@@ -1146,9 +1153,9 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<bookmark_value>Dialog service;CreateTimeField</bookmark_value>
</bookmark>
<h2 id="hd_id491598186886547" localize="false">CreateTimeField</h2>
- <paragraph role="paragraph" id="par_id200591895776611">Create a new control
of type TimeField in the current dialog.</paragraph>
+ <paragraph role="paragraph" id="par_id200591895776611">Create a new control
of type <literal>TimeField</literal> in the current dialog.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
- <paragraph role="paragraph" localize="false"
id="par_CreateTimeFld"><input>svc.CreateTimeField(opt ControlName: str, opt
Place, Border, MinTime, MaxTime): svc</input></paragraph>
+ <paragraph role="paragraph" localize="false"
id="par_CreateTimeFld"><input>svc.CreateTimeField(ControlName: str, Place: any,
Border: str = "3D", MinTime: num = 0, MaxTime: num = 24):
svc</input></paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateSharedParms"/>
<paragraph role="paragraph" id="par_id771688394821811"><emph>Border</emph>:
"3D" (default) or "FLAT" or "NONE"</paragraph>
<paragraph role="paragraph"
id="par_id711688394822256"><emph>MinTime</emph>: the smallest time that can be
entered in the control. Default = 0</paragraph>
@@ -1157,11 +1164,11 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<embed href="text/sbasic/shared/00000003.xhp#In_Basic"/>
<bascode>
- <paragraph role="bascode" id="bas_id341688394893210">Set myTimeField =
oDlg.CreateTimeField("TimeField1", Array(20, 20, 60, 15))</paragraph>
+ <paragraph role="bascode" id="bas_id341688394893210" localize="false">Set
myTimeField = oDlg.CreateTimeField("TimeField1", Array(20, 20, 60,
15))</paragraph>
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id31688394900314">myTimeField =
dlog.CreateTimeField('TimeField1', (20, 20, 60, 15))</paragraph>
+ <paragraph role="pycode" id="pyc_id31688394900314"
localize="false">myTimeField = dlog.CreateTimeField('TimeField1', (20, 20, 60,
15))</paragraph>
</pycode>
</section>
@@ -1171,9 +1178,9 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<bookmark_value>Dialog service;CreateTreeControl</bookmark_value>
</bookmark>
<h2 id="hd_id491599195886436" localize="false">CreateTreeControl</h2>
- <paragraph role="paragraph" id="par_id200692885776500">Create a new control
of type TreeControl in the current dialog.</paragraph>
+ <paragraph role="paragraph" id="par_id200692885776500">Create a new control
of type <literal>TreeControl</literal> in the current dialog.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
- <paragraph role="paragraph" localize="false"
id="par_CreateTreeCtrl"><input>svc.CreateTreeControl(opt ControlName: str, opt
Place, Border = "3D"): svc</input></paragraph>
+ <paragraph role="paragraph" localize="false"
id="par_CreateTreeCtrl"><input>svc.CreateTreeControl(ControlName: str, Place:
any, Border = "3D"): svc</input></paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateSharedParms"/>
<paragraph role="paragraph" id="par_id241688394984562"><emph>Border</emph>:
"3D" (default) or "FLAT" or "NONE"</paragraph>
<embed href="text/sbasic/shared/03/sf_dialog.xhp#CreateReturn"/>
@@ -1304,7 +1311,7 @@ in the actual dialog. The duplicated control is left
unchanged and can be reloca
<paragraph role="paragraph" id="par_id21598298953697">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.</paragraph>
<warning id="par_id921688543457317">Controls with an index >= 1 are not
accessible with the TAB key if:<br/>- they are omitted from the given list<br/>
- their type is FixedLine, GroupBox or ProgressBar<br/>- they are
disabled</warning>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
- <paragraph role="paragraph" localize="false"
id="par_id711610738389339"><input>svc.TabsList(TabsList: num, Start = 1,
Increment = 1): bool</input></paragraph>
+ <paragraph role="paragraph" localize="false"
id="par_id711610738389339"><input>svc.TabsList(TabsList: num, Start: num = 1,
Increment: num = 1): bool</input></paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
<paragraph role="paragraph"
id="par_id111688543698861"><emph>TabsList</emph>: an array of valid control
names in the order of tabulation</paragraph>
<paragraph role="paragraph" id="par_id381688543699284"><emph>Start</emph>:
the tab index to be assigned to the 1st control in the list. Default =
1</paragraph>
