summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlain Romedenne <LibreOfficiant@sfr.fr>2021-01-20 09:48:49 +0100
committerOlivier Hallot <olivier.hallot@libreoffice.org>2021-02-03 23:37:42 +0100
commit268d92a454d7839eefb1c4c97bba805141bb874f (patch)
tree8938dbc63ad9e1bff6b9106ed64b20204c8a505c
parentd8f033af4128be4d70172988ef9389a85673e1ef (diff)
(ScriptForge) SFDialogs library sf_Dialog sf_control new pages
- sf_calc unmuting L10N Change-Id: I3799952c29f21570e6faa81c5b1b27bc28786fb5 Reviewed-on: https://gerrit.libreoffice.org/c/help/+/109674 Tested-by: Jenkins Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
-rw-r--r--AllLangHelp_sbasic.mk2
-rw-r--r--source/auxiliary/sbasic.tree2
-rw-r--r--source/text/sbasic/shared/03/lib_ScriptForge.xhp56
-rw-r--r--source/text/sbasic/shared/03/sf_calc.xhp2
-rw-r--r--source/text/sbasic/shared/03/sf_dialog.xhp389
-rw-r--r--source/text/sbasic/shared/03/sf_dialogcontrol.xhp770
6 files changed, 1212 insertions, 9 deletions
diff --git a/AllLangHelp_sbasic.mk b/AllLangHelp_sbasic.mk
index 57cfed0d98..2fad16c6d7 100644
--- a/AllLangHelp_sbasic.mk
+++ b/AllLangHelp_sbasic.mk
@@ -79,6 +79,8 @@ $(eval $(call gb_AllLangHelp_add_helpfiles,sbasic,\
helpcontent2/source/text/sbasic/shared/03/lib_ScriptForge \
helpcontent2/source/text/sbasic/shared/03/sf_array \
helpcontent2/source/text/sbasic/shared/03/sf_calc \
+ helpcontent2/source/text/sbasic/shared/03/sf_dialog \
+ helpcontent2/source/text/sbasic/shared/03/sf_dialogcontrol \
helpcontent2/source/text/sbasic/shared/03/sf_dictionary \
helpcontent2/source/text/sbasic/shared/03/sf_exception \
helpcontent2/source/text/sbasic/shared/03/sf_ui \
diff --git a/source/auxiliary/sbasic.tree b/source/auxiliary/sbasic.tree
index c10b8e7718..fdd05f76fb 100644
--- a/source/auxiliary/sbasic.tree
+++ b/source/auxiliary/sbasic.tree
@@ -330,7 +330,7 @@
<topic id="sbasic/text/sbasic/shared/03/lib_importwiz.xhp">ImportWizard Library</topic>
<topic id="sbasic/text/sbasic/shared/03/lib_schedule.xhp">Schedule Library</topic>
<topic id="sbasic/text/sbasic/shared/03/lib_script.xhp">ScriptBindingLibrary Library</topic>
- <topic id="sbasic/text/sbasic/shared/03/lib_ScriptForge.xhp">ScriptForge Library</topic>
+ <topic id="sbasic/text/sbasic/shared/03/lib_ScriptForge.xhp">ScriptForge Libraries</topic>
<topic id="sbasic/text/sbasic/shared/03/lib_template.xhp">Template Library</topic>
<topic id="sbasic/text/sbasic/shared/03/lib_wikieditor.xhp">WikiEditor Library</topic>
</node>
diff --git a/source/text/sbasic/shared/03/lib_ScriptForge.xhp b/source/text/sbasic/shared/03/lib_ScriptForge.xhp
index 2813a026d4..98db6187d1 100644
--- a/source/text/sbasic/shared/03/lib_ScriptForge.xhp
+++ b/source/text/sbasic/shared/03/lib_ScriptForge.xhp
@@ -10,7 +10,7 @@
-->
<meta>
<topic id="toolsbasiclibrary" indexer="include" status="PUBLISH">
- <title id="tit" xml-lang="en-US">ScriptForge Library</title>
+ <title id="tit" xml-lang="en-US">ScriptForge Libraries</title>
<filename>/text/sbasic/shared/03/lib_ScriptForge.xhp</filename>
</topic>
</meta>
@@ -24,17 +24,60 @@
</section>
<note id="par_id901528999850603"><embedvar href="text/sbasic/shared/00000003.xhp#basiclibrarynote" markup="keep"/><br/>
<item type="literal">GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")</item></note>
-
<paragraph role="paragraph" id="par_id781606153472028">The described modules and classes are invoked from user scripts as "Services". A generic constructor of those services has been designed for that purpose:</paragraph>
<bascode>
<paragraph role="bascode" localize="false" id="bas_id201606153529501">[ScriptForge.][Services.]CreateScriptService("servicename"[, arg0, Arg1, ...])</paragraph>
</bascode>
-
<paragraph role="paragraph" id="par_id891606153700196">Services from external libraries can be registered with the <literal>RegisterScriptServices(...)</literal> method in order to extend the set of available services.</paragraph>
<note id="par_id851605659675843"><literal>ScriptForge</literal> Basic library is available from %PRODUCTNAME 7.1 onwards.</note>
-
+ <paragraph role="paragraph" id="par_id589160613700196">ScriptForge services are organized in the following categories:</paragraph>
+ <table id="tab_id501611613601554">
+ <tablerow>
+ <tablecell><paragraph id="par_id891611613601554" role="tablehead" xml-lang="en-US">%PRODUCTNAME Basic</paragraph></tablecell>
+ <tablecell><paragraph id="par_id891116610631554" role="tablehead" xml-lang="en-US">Document content</paragraph></tablecell>
+ <tablecell><paragraph id="par_id896111613601554" role="tablehead" xml-lang="en-US">User interface (UI)</paragraph></tablecell>
+ <tablecell><paragraph id="par_id681911613601554" role="tablehead" xml-lang="en-US">Utilities</paragraph></tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id891611613601556" role="tablecontent" localize="false">
+ Array<br/>
+ Dictionary<br/>
+ Exception<br/>
+ FileSystem<br/>
+ String<br/>
+ TextStream
+ </paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id541611613601554" role="tablecontent" localize="false">
+ Document<br/>
+ Calc<br/>
+ Database
+ </paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id107611613601554" role="tablecontent" localize="false">
+ UI<br/>
+ Dialog<br/>
+ DialogControls
+ </paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id701611613106554" role="tablecontent" localize="false">
+ <br/>
+ Localization (L10N)<br/>
+ Platform<br/>
+ Services<br/>
+ Session
+ </paragraph>
+ </tablecell>
+ </tablerow>
+ </table>
<embed href="text/sbasic/shared/03/sf_array.xhp#abstract"/>
<embed href="text/sbasic/shared/03/sf_calc.xhp#abstract"/>
+ <embed href="text/sbasic/shared/03/sf_dialogcontrol.xhp#abstract"/>
+ <embed href="text/sbasic/shared/03/sf_dialog.xhp#abstract"/>
<embed href="text/sbasic/shared/03/sf_dictionary.xhp#abstract"/>
<embed href="text/sbasic/shared/03/sf_document.xhp#abstract"/>
<embed href="text/sbasic/shared/03/sf_exception.xhp#abstract"/>
@@ -47,11 +90,10 @@
<paragraph role="paragraph" id="par_id791606151259895" localize="false">TextStream class Service</paragraph>
<embed href="text/sbasic/shared/03/sf_timer.xhp#abstract"/>
<embed href="text/sbasic/shared/03/sf_ui.xhp#abstract"/>
-
<comment>Restricted use for SF_Root, SF_Utils modules as well as internal methods</comment>
<paragraph role="paragraph" id="par_id331608220104798"><emph>Note:</emph> Other <literal>ScriptForge</literal> undescribed modules are reserved for internal use. Their content is subject to change without notice.</paragraph>
<section id="SF_InternalUse">
- <warning id="par_id851506659675843">All <literal>ScriptForge</literal> Basic routines or identifiers that are prefixed with an underscore character "_" are reserved for internal use. They are not meant be used in Basic macros.</warning>
+ <warning id="par_id851506659675843">All <literal>ScriptForge</literal> Basic routines or identifiers that are prefixed with an underscore character "_" are reserved for internal use. They are not meant be used in Basic macros.</warning>
</section>
</body>
-</helpdocument>
+</helpdocument> \ No newline at end of file
diff --git a/source/text/sbasic/shared/03/sf_calc.xhp b/source/text/sbasic/shared/03/sf_calc.xhp
index 2f1a3e78ae..156ef6a8e6 100644
--- a/source/text/sbasic/shared/03/sf_calc.xhp
+++ b/source/text/sbasic/shared/03/sf_calc.xhp
@@ -382,7 +382,7 @@
<h2 id="hd_id501582887473754" xml-lang="en-US">Methods</h2>
<table id="tab_id501611613601554">
<tablerow>
- <tablecell colspan="3"><paragraph id="par_id891611613601554" role="tablehead" localize="false">List of Methods in the Calc Service</paragraph></tablecell>
+ <tablecell colspan="3"><paragraph id="par_id891611613601554" role="tablehead" xml-lang="en-US">List of Methods in the Calc Service</paragraph></tablecell>
</tablerow>
<tablerow>
<tablecell>
diff --git a/source/text/sbasic/shared/03/sf_dialog.xhp b/source/text/sbasic/shared/03/sf_dialog.xhp
new file mode 100644
index 0000000000..ce5db1b146
--- /dev/null
+++ b/source/text/sbasic/shared/03/sf_dialog.xhp
@@ -0,0 +1,389 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<helpdocument version="1.0">
+<!--
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+-->
+
+<meta>
+ <topic id="SF_Dialog" indexer="include" status="PUBLISH">
+ <title id="tit" xml-lang="en-US">SFDialogs.Dialog service</title>
+ <filename>/text/sbasic/shared/03/sf_dialog.xhp</filename>
+ </topic>
+ </meta>
+
+<body>
+<section id="SFDocuments-sf_Dialog">
+ <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id41582391760252">
+ <bookmark_value>Dialog service</bookmark_value>
+ </bookmark>
+</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" name="SFDialogs.Dialog"><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" name="Dialog Editor">Dialog Editor</link>. 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, other user actions executed on the box can trigger specific actions.</paragraph>
+ <paragraph role="paragraph" id="par_id981598110463521" xml-lang="en-US">In non-modal mode, the dialog box is "floating" on the user desktop and the execution of the macro process continues normally. Regardless of its status, the dialog closes when the macro that displayed it finishes running.</paragraph>
+ <paragraph role="paragraph" id="par_id721598110472337" xml-lang="en-US">A dialog box disappears from memory after its explicit termination.</paragraph>
+ <tip id="par_id891598188164936" xml-lang="en-US">The <literal>SFDialogs.Dialog</literal> service is closely related to the <literal>SFDialogs.DialogControl</literal> service.</tip>
+
+ <h2 id="hd_id581582885621841" xml-lang="en-US">Service invocation and usage</h2>
+ <paragraph role="paragraph" id="par_id361598174756160" xml-lang="en-US">The dialog service is invoked through the <literal>CreateScriptService</literal> method. It requires three arguments to specify the dialog box to activate:</paragraph>
+ <paragraph role="paragraph" id="par_id31612271944733"><emph>Container</emph>: "<link href="text/sbasic/shared/03131900.xhp" name="GlobalScope specifier"><literal>GlobalScope</literal></link>" for preinstalled libraries or a window name as defined by <link href="text/sbasic/shared/03/sf_ui.xhp" name="ScriptForge.UI"><literal>ScriptForge.UI</literal></link> service. Empty string "" default value stands for the current document.</paragraph>
+ <paragraph role="paragraph" id="par_id311612271947124"><emph>Library</emph>: The case-sensitive name of a library contained in the container. Default value is "Standard".</paragraph>
+ <paragraph role="paragraph" id="par_id821612271946316"><emph>DialogName</emph>: A case-sensitive string designating the dialog.</paragraph>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id471598171198389">Dim oDlg As Object, lButton As Long</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id611598171572062">Dim Container As String, Library As String, DialogName As String</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id571598171205739">Set oDlg = CreateScriptService("SFDialogs.Dialog", Container, Library, DialogName)</paragraph>
+ <paragraph role="bascode" id="bas_id321598171269873">'... controls initialization goes here...</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id991598171277414">lButton = oDlg.Execute()</paragraph>
+ <paragraph role="bascode" id="bas_id471598176518738">'Default mode = Modal</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id271598171282891">If lButton = oDlg.OKBUTTON Then</paragraph>
+ <paragraph role="bascode" id="bas_id551598171288547">'... Process controls and do what is needed here</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id741598171294507">End If</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id591598171300285">oDlg.Terminate()</paragraph>
+ </bascode>
+ <paragraph role="paragraph" id="par_id951598174966322" xml-lang="en-US">Alternatively a dialog instance can be retrieved via the dialog event manager, providing the dialog was initiated with the <literal>SFDialog.Dialog</literal> service. Events often require to identify the dialog class instance that triggered the event.</paragraph>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id311598175259794">Sub SomeEvent(ByRef poEvent As Object)</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id781598175253859"> Dim oDlg As Object</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id921598175248581"> Set oDlg = CreateScriptService("SFDialogs.DialogEvent", poEvent)</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id801598175242937"> ' oDlg represents now the instance of the Dialog class having triggered the current event</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id711598175146308"> ' ...</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id421598175139021">End Sub</paragraph>
+ </bascode>
+ <paragraph role="paragraph" id="par_id251598176312571" xml-lang="en-US">Note that in previous examples, the prefix <literal>"SFDialogs."</literal> may be omitted.</paragraph>
+
+ <h2 id="hd_id651583668365757" xml-lang="en-US">Properties</h2>
+ <table id="tab_id381583668386455">
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id871583668386455" role="tablehead" xml-lang="en-US">Name</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id491583668386455" role="tablehead" xml-lang="en-US">ReadOnly</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id271583668474014" role="tablehead" xml-lang="en-US">Type</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id401583668386455" role="tablehead" xml-lang="en-US">Description</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id151583668386455" role="tablecontent" xml-lang="en-US" localize="false">OKBUTTON</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id371583668519172" role="tablecontent " xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id271583668386455" role="tablecontent" xml-lang="en-US" localize="false">Integer</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id771583668386455" role="tablecontent" xml-lang="en-US">Value = 1. An OK button was pressed.</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id951583839708571" role="tablecontent" xml-lang="en-US" localize="false">CANCELBUTTON</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id541583839708548" role="tablecontent " xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id751583839708362" role="tablecontent" xml-lang="en-US" localize="false">Integer</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id731583839708412" role="tablecontent" xml-lang="en-US">Value = 0. A Cancel button was pressed.</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id511584027709311" role="tablecontent" xml-lang="en-US" localize="false">Caption</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id761584027709516" role="tablecontent " xml-lang="en-US">No</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id491584027709825" role="tablecontent" xml-lang="en-US" localize="false">String</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id971584027709752" role="tablecontent" xml-lang="en-US">Specify the title of the dialog.</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id491583839767611" role="tablecontent" xml-lang="en-US" localize="false">Height</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id31583839767743" role="tablecontent " xml-lang="en-US">No</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id741583839767926" role="tablecontent" xml-lang="en-US" localize="false">Long</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id111583839767195" role="tablecontent" xml-lang="en-US">Specify the height of the dialog box.</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id83158383992056" role="tablecontent" xml-lang="en-US" localize="false">Modal</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id771583839920487" role="tablecontent " xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id971583839920282" role="tablecontent" xml-lang="en-US" localize="false">Boolean</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id451583839920858" role="tablecontent" xml-lang="en-US">Specifies if the dialog box is currently in execution in modal mode.</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id751588333908795" role="tablecontent" xml-lang="en-US" localize="false">Name</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id571588333908716" role="tablecontent " xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id781588333908500" role="tablecontent" xml-lang="en-US" localize="false">String</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id721588333908708" role="tablecontent" xml-lang="en-US">The name of the dialog</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id251583774433989" role="tablecontent" xml-lang="en-US" localize="false">Page</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id501583774433513" role="tablecontent " xml-lang="en-US">No</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id411583774433779" role="tablecontent" xml-lang="en-US" localize="false">Integer</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph role="paragraph" id="par_id151598177605296" xml-lang="en-US">A dialog may have several pages that can be traversed by the user step by step. The Page property of the Dialog object defines which page of the dialog is active.</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id731588334016220" role="tablecontent" xml-lang="en-US" localize="false">Visible</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id271588334016191" role="tablecontent " xml-lang="en-US">No</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id991588334016273" role="tablecontent" xml-lang="en-US" localize="false">Boolean</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id251588334016874" role="tablecontent" xml-lang="en-US">Specify if the dialog box is visible on the desktop. By default it is not visible until the Execute() method is run and visible afterwards.</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id741598177924441" role="tablecontent" xml-lang="en-US" localize="false">XDialogModel</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id451598177924437" role="tablecontent " xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id141598187953729">
+ <bookmark_value>API;UnoControlDialogModel</bookmark_value>
+ </bookmark>
+ <paragraph id="par_id94159817792441" role="tablecontent" xml-lang="en-US" localize="false">com.sun.star.awt.XControlModel<br /><link href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1awt_1_1UnoControlDialogModel-members.html" name="css.awt.UnoControlDialogModel">..awt.UnoControlDialogModel</link></paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id191598177924897" role="tablecontent" xml-lang="en-US">The UNO object representing the dialog model.</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id801598178083859" role="tablecontent" xml-lang="en-US" localize="false">XDialogView</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id811598178083501" role="tablecontent " xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id141598187953729">
+ <bookmark_value>API;UnoControlDialog</bookmark_value>
+ </bookmark>
+ <paragraph id="par_id981598178083938" role="tablecontent" xml-lang="en-US" localize="false">com.sun.star.awt.XControl<br /><link href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1awt_1_1UnoControlDialog-members.html" name="UnoControlDialog interface">..awt.UnoControlDialog</link></paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id731598178083442" role="tablecontent" xml-lang="en-US">The UNO object representing the dialog view.</paragraph>
+ </tablecell>
+ </tablerow>
+ </table>
+
+ <table id="tab_id891606472825856">
+ <tablerow>
+ <tablecell><paragraph id="par_id581606472825856" role="tablehead" localize="false"></paragraph></tablecell>
+ <tablecell><paragraph id="par_id921606472825856" role="tablehead">Methods</paragraph></tablecell>
+ <tablecell><paragraph id="par_id781606472825856" role="tablehead" localize="false"></paragraph></tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell><paragraph id="par_id381606472825856" role="tablecontent" localize="false">
+ <link href="text/sbasic/shared/03/sf_dialog.xhp#Activate" name="Activate method">Activate</link><br/>
+ <link href="text/sbasic/shared/03/sf_dialog.xhp#Controls" name="Controls method">Controls</link><br/>
+ </paragraph></tablecell>
+ <tablecell><paragraph id="par_id451606472825856" role="tablecontent" localize="false">
+ <link href="text/sbasic/shared/03/sf_dialog.xhp#EndExecute" name="EndExecute method">EndExecute</link><br/>
+ <link href="text/sbasic/shared/03/sf_dialog.xhp#Execute" name="Execute method">Execute</link><br/>
+ </paragraph></tablecell>
+ <tablecell><paragraph id="par_id161606472825856" role="tablecontent" localize="false">
+ <link href="text/sbasic/shared/03/sf_dialog.xhp#Terminate" name="Terminate method">Terminate</link><br/>
+ </paragraph></tablecell>
+ </tablerow>
+ </table>
+
+ <section id="Activate">
+ <comment> Activate -------------------------------------------------------------------------------------------------------------------------- </comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id721583933076548">
+ <bookmark_value>Dialog service;Activate</bookmark_value>
+ </bookmark>
+ <h2 id="hd _id681583933076692" localize="false">Activate</h2>
+ <paragraph role="paragraph" id="par_id871583933076448">Set the focus on the current dialog instance. Return <literal>True</literal> if focusing was successful.</paragraph>
+ <paragraph role="paragraph" id="par_id151598178880227" xml-lang="en-US">This method is probably called from a dialog or control event, or even more likely, when a dialog is displayed in non-modal mode.</paragraph>
+ <h3 id="hd _id61583933076171"><embedvar href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id731583933076815">oDlg.Activate() As Boolean</paragraph>
+ </bascode>
+ <h3 id="hd _id26158393307687"><embedvar href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id221598179105596">Dim oDlg As Object</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id171598179111121">Set oDlg = CreateScriptService(,, "myDialog")</paragraph>
+ <paragraph role="bascode" id="bas_id841598179117184">' Dialog stored in current document's standard library</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id681598179123436">oDlg.Execute(Modal := False)</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id371598179128761">' ...</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id361598179135096">oDlg.Activate()</paragraph>
+ </bascode>
+ </section>
+
+ <section id="Controls">
+ <comment> Controls -------------------------------------------------------------------------------------------------------------------------- </comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id41584541257826">
+ <bookmark_value>Dialog service;Controls</bookmark_value>
+ </bookmark>
+ <h2 id="hd _id95158454125767" localize="false">Controls</h2>
+ <paragraph role="paragraph" id="par_id161584541257982">Return either:</paragraph>
+ <list type="unordered">
+ <listitem>
+ <paragraph id="par_id421598179770993" role="listitem" xml-lang="en-US">the list of the controls contained in the dialog</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id81598185229301" role="listitem" xml-lang="en-US">a dialog control class instance based on its name</paragraph>
+ </listitem>
+ </list>
+ <h3 id="hd _id601584541257443"><embedvar href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id201584541257726">oDlg.Controls([ControlName As String]) As Variant</paragraph>
+ </bascode>
+ <h3 id="hd _id291584541257237"><embedvar href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph" id="par_id1001584541257789"><emph>ControlName</emph> : A valid control name as a case-sensitive string. If absent, the list of control names is returned as a zero-based array.</paragraph>
+ <h3 id="hd _id32158454125769"><embedvar href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id151598185478904">Dim myDialog As Object, myList As Variant, myControl As Object</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id21598185484092">Set myDialog = CreateScriptService("SFDialogs.Dialog", , "Standard", "Dialog1")</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id641598185489492">myList = myDialog.Controls()</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id921598185495193">Set myControl = myDialog.Controls("myTextBox")</paragraph>
+ </bascode>
+ </section>
+
+ <section id="EndExecute">
+ <comment> EndExecute -------------------------------------------------------------------------------------------------------------------------- </comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id171598185776261">
+ <bookmark_value>Dialog service;EndExecute</bookmark_value>
+ </bookmark>
+ <h2 id="hd _id491598185776436" localize="false">EndExecute</h2>
+ <paragraph role="paragraph" id="par_id381598185776500">Ends the display of a modal dialog and gives back the argument as return value for the current <literal>Execute()</literal> running action.</paragraph>
+ <paragraph role="paragraph" id="par_id551598185953362" xml-lang="en-US"><literal>EndExecute()</literal> is usually contained in the processing of a macro triggered by a dialog or control event.</paragraph>
+ <h3 id="hd _id16159818577649" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id811598185776225">oDlg.EndExecute(ReturnValue As Long)</paragraph>
+ </bascode>
+ <h3 id="hd _id721598185776413" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph" id="par_id451598185776957"><emph>ReturnValue</emph> : The value passed to the running <literal>Execute()</literal> method.</paragraph>
+ <h3 id="hd _id771598185776435" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id521598186134426">Sub OnEvent(poEvent As Variant)</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id631598186139835"> Dim oDlg As Object</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id251598186144483"> Set oDlg = CreateScriptService("SFDialogs.DialogEvent", poEvent)</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id191598186150509"> oDlg.EndExecute(ReturnValue := 25)</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id91598186155632">End Sub</paragraph>
+ </bascode>
+ </section>
+
+ <section id="Execute">
+ <comment> Execute -------------------------------------------------------------------------------------------------------------------------- </comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id351598186461621">
+ <bookmark_value>Dialog service;Execute</bookmark_value></bookmark>
+ <h2 id="hd _id531598186461915" localize="false">Execute</h2>
+ <paragraph role="paragraph" id="par_id29159818646178">Display the dialog box and, when modal, wait for its termination by the user. The returned value is either:</paragraph>
+ <list type="unordered">
+ <listitem>
+ <paragraph id="par_id541598186676277" role="listitem" xml-lang="en-US">0 : <literal>Cancel</literal> button pressed</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id821598186716345" role="listitem" xml-lang="en-US">1 : <literal>OK</literal> button pressed</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id951598186738346" role="listitem" xml-lang="en-US">Otherwise the dialog stopped with an <literal>EndExecute()</literal> statement issued by a dialog or control event</paragraph>
+ </listitem>
+ </list>
+ <paragraph role="paragraph" id="par_id741598187335869" xml-lang="en-US">For non-modal dialog boxes the method always returns 0 and the execution of the macro continues.</paragraph>
+ <h3 id="hd _id491598186461869" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id841598186461491">oDlg.Execute([Modal As Boolean]) As Long</paragraph>
+ </bascode>
+ <h3 id="hd _id331598186461152" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph" id="par_id11598186461227"><emph>Modal</emph> : <literal>False</literal> when non-modal dialog. Default = <literal>True</literal>.</paragraph>
+ <h3 id="hd _id28159818646198" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id591598186461923">Dim oDlg As Object, lReturn As Long</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id681598186461370">Set oDlg = CreateScriptService(("SFDialogs.Dialog", , , "myDialog")</paragraph>
+ <paragraph role="bascode" id="bas_id211598187104866">' Dialog stored in current document's standard library</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id281598186461514">lReturn = oDlg.Execute()</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id291598186461410">Select Case lReturn</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id741598187182079">' ...</paragraph>
+ <paragraph role="bascode" id="bas_id781612273203518">End Select</paragraph>
+ </bascode>
+ </section>
+
+ <section id="Terminate">
+ <comment> Terminate -------------------------------------------------------------------------------------------------------------------------- </comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id141598187953729">
+ <bookmark_value>Dialog service;Terminate</bookmark_value>
+ </bookmark>
+ <h2 id="hd _id101598187953201" localize="false">Terminate</h2>
+ <paragraph role="paragraph" id="par_id21598187953679">Terminate the dialog service for the current instance. Return <literal>True</literal> if the termination was successful.</paragraph>
+ <h3 id="hd _id221598187953425" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id231598187953624">oDlg.Terminate() As Boolean</paragraph>
+ </bascode>
+ <h3 id="hd _id361598187953840" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id121598187953168">oDlg.Terminate()</paragraph>
+ </bascode>
+ </section>
+
+ <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#SF_InternalUse"/>
+
+ <section id="relatedtopics">
+ <embed href="text/sbasic/shared/03/sf_dialogcontrol.xhp#ctrls_h1"/>
+ <embed href="text/sbasic/shared/03/sf_ui.xhp#UIService"/>
+ </section>
+
+</body>
+</helpdocument>
diff --git a/source/text/sbasic/shared/03/sf_dialogcontrol.xhp b/source/text/sbasic/shared/03/sf_dialogcontrol.xhp
new file mode 100644
index 0000000000..ee79d66315
--- /dev/null
+++ b/source/text/sbasic/shared/03/sf_dialogcontrol.xhp
@@ -0,0 +1,770 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<helpdocument version="1.0">
+<!--
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+-->
+
+<meta>
+ <topic id="SF_DialogControl" indexer="include" status="PUBLISH">
+ <title id="tit" xml-lang="en-US">SFDialogs.DialogControl service</title>
+ <filename>/text/sbasic/shared/03/sf_dialogcontrol.xhp</filename>
+ </topic>
+ </meta>
+
+<body>
+<section id="abstract">
+ <bookmark localize="false" branch="index" id="bm_id41582391760252">
+ <bookmark_value>DialogControl service</bookmark_value>
+ </bookmark>
+
+ <h1 id="bm_id781582391760253" xml-lang="en-US"><variable id="ctrls_h1"><link href="text/sbasic/shared/03/sf_dialogcontrol.xhp" name="SFDialogs.DialogControl service"><literal>SFDialogs</literal>.<literal>DialogControl</literal> service</link></variable></h1>
+
+ <paragraph role="paragraph" id="par_id931583589764919" xml-lang="en-US">The <literal>DialogControl</literal> service manages the controls belonging to a dialog defined with the Basic <link href="text/sbasic/guide/create_dialog.xhp" name="Dialog Editor">Dialog Editor</link>. Each instance of the current service represents a single control within a dialog box.</paragraph>
+
+ <bookmark xml-lang="en-US" branch="index" id="bm_id331612167249331">
+ <bookmark_value>API;awt.XControl</bookmark_value>
+ <bookmark_value>API;awt.XControlModel</bookmark_value>
+ </bookmark>
+ <paragraph role="paragraph" id="par_id701598191157426" xml-lang="en-US">The focus is set on getting and setting the values displayed by the controls of the dialog box. Formatting is accessible via the <literal>XControlModel</literal> and <literal>XControlView</literal> properties.</paragraph>
+ <paragraph role="paragraph" id="par_id981598191184526" xml-lang="en-US">Note that <literal>DialogControl.Value</literal> property content varies according to UNO control types.</paragraph>
+</section>
+
+ <tip id="par_id891598188164936" xml-lang="en-US">The <literal>SFDialogs.DialogControl</literal> service is closely related to the <link href="text/sbasic/shared/03/sf_dialog.xhp" name="Dialog service"><literal>SFDialogs.Dialog</literal></link> service.</tip>
+
+ <h2 id="hd_id581582885621841" xml-lang="en-US">Service invocation</h2>
+ <paragraph role="paragraph" id="par_id361598174756160" xml-lang="en-US">The <literal>DialogControl</literal><literal></literal> service is invoked from an existing <literal>Dialog</literal> service instance thru its <literal>Controls()</literal> method. The dialog must be initiated with the <literal>SFDialogs.Dialog</literal> service.</paragraph>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id791598453192421">Dim myDialog As Object, myControl As Object</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id251598453197473">Set myDialog = CreateScriptService("SFDialogs.Dialog", "GlobalScope", myLibrary, DialogName)</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id421598453203458">Set myControl = myDialog.Controls("myTextBox")</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id581598453210170">myControl.Value = "Dialog started at " &amp; Now()</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id11598453215943">myDialog.Execute()</paragraph>
+ <paragraph role="bascode" xml-lang="en-US" id="bas_id961598453222539">' ... process the controls actual values</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id981598453230245">myDialog.Terminate()</paragraph>
+ </bascode>
+ <paragraph role="paragraph" id="par_id951598174966322" xml-lang="en-US">Alternatively a control instance can be retrieved via the dialog event manager, providing the dialog was initiated with the <literal>SFDialog.Dialog</literal> service. Events often require to identify the control class instance that triggered the event.</paragraph>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id311598175259794">Sub SomeEvent(ByRef poEvent As Object)</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id781598175253859"> Dim oControl As Object</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id921598175248581"> Set oControl = CreateScriptService("SFDialogs.DialogEvent", poEvent)</paragraph>
+ <paragraph role="bascode" xml-lang="en-US" id="bas_id801598175242937"> ' oControl represents now the instance of the Control class having triggered the current event</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id711598175146308"> ' ...</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id421598175139021">End Sub</paragraph>
+ </bascode>
+ <paragraph role="paragraph" id="par_id251598176312571" xml-lang="en-US">Note that in previous examples, the prefix <literal>"SFDialogs."</literal> may be omitted.</paragraph>
+
+ <h2 id="hd_id71598455687512" xml-lang="en-US">Control types</h2>
+ <paragraph role="paragraph" id="par_id851598455863395" xml-lang="en-US">The <literal>DialogControl</literal> service is available for these control types:</paragraph>
+ <list type="unordered">
+ <listitem>
+ <paragraph id="par_id121598455880500" localize="false" role="listitem">Button</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id441598455934376" localize="false" role="listitem">CheckBox</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id471598455940400" localize="false" role="listitem">ComboBox</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id181598455945642" localize="false" role="listitem">CurrencyField</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id181598455949653" localize="false" role="listitem">DateField</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id541598455953714" localize="false" role="listitem">FileControl</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id441598455957858" localize="false" role="listitem">FixedLine</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id971598455961404" localize="false" role="listitem">FixedText</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id721598455965612" localize="false" role="listitem">FormattedField</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id291598455969826" localize="false" role="listitem">GroupBox</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id861598455974724" localize="false" role="listitem">ImageControl</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id851598455979572" localize="false" role="listitem">ListBox</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id321598455984243" localize="false" role="listitem">NumericField</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id981598455990524" localize="false" role="listitem">PatternField</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id991598455998589" localize="false" role="listitem">ProgressBar</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id281598456002561" localize="false" role="listitem">RadioButton</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id91598456007438" localize="false" role="listitem">ScrollBar</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id271598456011504" localize="false" role="listitem">TextField</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id661598456015339" localize="false" role="listitem">TimeField</paragraph>
+ </listitem>
+ </list>
+
+ <h2 id="hd_id651583668365757" xml-lang="en-US">Properties</h2>
+ <table id="tab_id381583668386455">
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id871583668386455" role="tablehead" xml-lang="en-US">Name</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id491583668386455" role="tablehead" xml-lang="en-US">ReadOnly</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id271583668474014" role="tablehead" xml-lang="en-US">Type</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id291598538799794" role="tablehead" xml-lang="en-US">Applicable to</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id401583668386455" role="tablehead" xml-lang="en-US">Description</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id151583668386455" role="tablecontent" localize="false">Cancel</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id371583668519172" role="tablecontent" xml-lang="en-US">No</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id271583668386455" role="tablecontent" localize="false">Boolean</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id231598538847029" role="tablecontent" xml-lang="en-US">Button</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id771583668386455" role="tablecontent" xml-lang="en-US">Specifies if a command button has or not the behaviour of a Cancel button.</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id951583839708571" role="tablecontent" localize="false">Caption</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id541583839708548" role="tablecontent" xml-lang="en-US">No</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id751583839708362" role="tablecontent" localize="false">String</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id351598538934413" role="tablecontent" xml-lang="en-US">Button, CheckBox, FixedLine, FixedText, GroupBox, RadioButton</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id731583839708412" role="tablecontent" xml-lang="en-US">Specifies the text associated with the control.</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id511584027709311" role="tablecontent" localize="false">ControlType</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id761584027709516" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id491584027709825" role="tablecontent" localize="false">String</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id261598539120502" role="tablecontent" xml-lang="en-US">All</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id971584027709752" role="tablecontent" xml-lang="en-US">One of the types listed above.</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id491583839767611" role="tablecontent" localize="false">Default</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id31583839767743" role="tablecontent" xml-lang="en-US">No</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id741583839767926" role="tablecontent" localize="false">Boolean</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id71598539168348" role="tablecontent" xml-lang="en-US">Button</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id111583839767195" role="tablecontent" xml-lang="en-US">Specifies whether a command button is the default (OK) button.</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id83158383992056" role="tablecontent" localize="false">Enabled</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id771583839920487" role="tablecontent" xml-lang="en-US">No</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id971583839920282" role="tablecontent" localize="false">Boolean</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id891598539196786" role="tablecontent" xml-lang="en-US">All</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id451583839920858" role="tablecontent" xml-lang="en-US">Specifies if the control is accessible with the cursor.</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id751588333908795" role="tablecontent" localize="false">Format</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id571588333908716" role="tablecontent" xml-lang="en-US">No</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id781588333908500" role="tablecontent" localize="false">String</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id491598539231618" role="tablecontent" xml-lang="en-US">DateField, TimeField, FormattedField (read-only)</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id721588333908708" role="tablecontent" xml-lang="en-US">Specifies the format used to display dates and times. It must be one these strings:</paragraph>
+ <paragraph role="paragraph" id="par_id891598456980194" xml-lang="en-US">For dates: "Standard (short)", "Standard (short YY)", "Standard (short YYYY)", "Standard (long)", "DD/MM/YY", "MM/DD/YY", "YY/MM/DD", "DD/MM/YYYY", "MM/DD/YYYY" , "YYYY/MM/DD", "YY-MM-DD", "YYYY-MM-DD".</paragraph>
+ <paragraph role="paragraph" id="par_id221598456991070" xml-lang="en-US">For times: "24h short", "24h long", "12h short", "12h long".</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id251583774433989" role="tablecontent" localize="false">ListCount</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id501583774433513" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id411583774433779" role="tablecontent" localize="false">Long</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id531598539561342" role="tablecontent" xml-lang="en-US">ComboBox, ListBox</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph role="paragraph" id="par_id151598177605296" xml-lang="en-US">Specifies the number of rows in a list box or a combo box.</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id731588334016220" role="tablecontent" localize="false">ListIndex</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id271588334016191" role="tablecontent" xml-lang="en-US">No</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id991588334016273" role="tablecontent" localize="false">Long</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id451598539598242" role="tablecontent" xml-lang="en-US">ComboBox, ListBox</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id251588334016874" role="tablecontent" xml-lang="en-US">Specifies which item is selected in a list box or combo box.</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id451598457655392" role="tablecontent" localize="false">Locked</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id961598457655506" role="tablecontent" xml-lang="en-US">No</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id571598457655365" role="tablecontent" localize="false">Boolean</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id111598539631340" role="tablecontent" xml-lang="en-US">ComboBox, CurrencyField, DateField, FileControl, FormattedField, ListBox, NumericField, PatternField, TextField, TimeField</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id2159845765568" role="tablecontent" xml-lang="en-US">Specifies if the control is read-only.</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id21159845795140" role="tablecontent" localize="false">MultiSelect</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id621598457951781" role="tablecontent" xml-lang="en-US">No</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id311598457951281" role="tablecontent" localize="false">Boolean</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id361598539747680" role="tablecontent" xml-lang="en-US">ListBox</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id821598457951782" role="tablecontent" xml-lang="en-US">Specifies whether a user can make multiple selections in a listbox.</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id421598458170141" role="tablecontent" localize="false">Name</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id351598458170114" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id391598458170757" role="tablecontent" localize="false">String</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id151598539764402" role="tablecontent" xml-lang="en-US">All</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id621598458170392" role="tablecontent" xml-lang="en-US">The name of the control.</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id281598458357593" role="tablecontent" localize="false">Page</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id80159845835726" role="tablecontent" xml-lang="en-US">No</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id191598458357402" role="tablecontent" localize="false">Integer</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id841598539781888" role="tablecontent" xml-lang="en-US">All</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id791598458357756" role="tablecontent" xml-lang="en-US">A dialog may have several pages that can be traversed by the user step by step. The Page property of the Dialog object defines which page of the dialog is active.</paragraph>
+ <paragraph role="paragraph" id="par_id441598458459145" xml-lang="en-US">The Page property of a control defines the page of the dialog on which the control is visible.</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id2915984585802" role="tablecontent" localize="false">Parent</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id161598458580581" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id921598458580608" role="tablecontent" localize="false">Object</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id181598539807426" role="tablecontent" xml-lang="en-US">All</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id801598458580456" role="tablecontent" xml-lang="en-US">The parent dialog instance.</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id181598458773220" role="tablecontent" localize="false">Picture</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id971598458773352" role="tablecontent" xml-lang="en-US">No</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id471598458773993" role="tablecontent" localize="false">String</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id831598539848472" role="tablecontent" xml-lang="en-US">Button, ImageControl</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id451598458773588" role="tablecontent" xml-lang="en-US">Specifies the file name containing a bitmap or other type of graphic to be displayed on the specified control. The filename must comply with the <literal>FileNaming</literal> attribute of the <literal>ScriptForge.FileSystem</literal> service.</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id681598516577774" role="tablecontent" localize="false">RowSource</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id401598516577225" role="tablecontent" xml-lang="en-US">No</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id59159851657754" role="tablecontent" localize="false">Array of strings</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id131598539880024" role="tablecontent" xml-lang="en-US">ComboBox, ListBox</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id311598516577712" role="tablecontent" xml-lang="en-US">Specifies the data contained in a combobox or a listbox.</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id491598516764653" role="tablecontent" localize="false">Text</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id781598516764550" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id741598516764696" role="tablecontent" localize="false">String</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id761598539912452" role="tablecontent" xml-lang="en-US">ComboBox, FileControl, FormattedField, PatternField, TextField</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id11159851676440" role="tablecontent" xml-lang="en-US">Gives access to the text being displayed by the control.</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id311598517275908" role="tablecontent" localize="false">TipText</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id411598517275112" role="tablecontent" xml-lang="en-US">No</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id971598517275920" role="tablecontent" localize="false">String</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id171598539985022" role="tablecontent" xml-lang="en-US">All</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id651598517275384" role="tablecontent" xml-lang="en-US">Specifies the text that appears as a tooltip when you hold the mouse pointer over the control.</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id951598517418614" role="tablecontent" localize="false">TripleState</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id821598517418463" role="tablecontent" xml-lang="en-US">No</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id231598517418608" role="tablecontent" localize="false">Boolean</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id81598540007035" role="tablecontent" xml-lang="en-US">CheckBox</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id141598517418822" role="tablecontent" xml-lang="en-US">Specifies if the checkbox control may appear dimmed (grayed) or not.</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id31598517671415" role="tablecontent" localize="false">Value</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id701598517671373" role="tablecontent" xml-lang="en-US">No</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id2159851767113" role="tablecontent" localize="false">Any</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id1001598540024225" role="tablecontent" xml-lang="en-US"></paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id991598517671916" role="tablecontent" xml-lang="en-US">Read below.</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id571598517730264" role="tablecontent" localize="false">Visible</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id661598517730941" role="tablecontent" xml-lang="en-US">No</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id981598517730694" role="tablecontent" localize="false">Boolean</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id761598540042290" role="tablecontent" xml-lang="en-US">All</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id881598517730836" role="tablecontent" xml-lang="en-US">Specifies if the control is hidden or visible.</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id741598177924441" role="tablecontent" localize="false">XControlModel</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id451598177924437" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id94159817792441" role="tablecontent" localize="false"><link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1XControlModel.html" name="awt.XControlModel">…awt.XControlModel</link><br /><link href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1awt_1_1UnoControlDialogModel.html)" name="awt.XControlDialogModel">…awt.UnoControlDialogModel</link></paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id311598540066789" role="tablecontent" xml-lang="en-US">All</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id191598177924897" role="tablecontent" xml-lang="en-US">The UNO object representing the control model.</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id801598178083859" role="tablecontent" localize="false">XControlView</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id811598178083501" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id981598178083938" role="tablecontent" localize="false"><link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1XControl.html" name="awt.XControl">…awt.XControl</link><br /><link href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1awt_1_1UnoControlDialog.html)" name="awt.UnoControlDialog">…awt.UnoControlDialog</link></paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id551598540079329" role="tablecontent" xml-lang="en-US">All</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id731598178083442" role="tablecontent" xml-lang="en-US">The UNO object representing the control view.</paragraph>
+ </tablecell>
+ </tablerow>
+ </table>
+
+ <h2 id="hd_id81598540704978" xml-lang="en-US">The Value property</h2>
+ <table id="tab_id48159854325479">
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id10159854325492" role="tablehead" xml-lang="en-US">Control type</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id741598543254158" role="tablehead" xml-lang="en-US">Type</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id961598543254444" role="tablehead" xml-lang="en-US">Description</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id461598543254494" role="tablecontent" xml-lang="en-US">Button</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id271598543254590" role="tablecontent" xml-lang="en-US">Boolean</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id741598543254108" role="tablecontent" xml-lang="en-US">For toggle buttons only</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id131598543254931" role="tablecontent" xml-lang="en-US">CheckBox</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id741598543254376" role="tablecontent" xml-lang="en-US">Boolean or Integer</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id521598543254630" role="tablecontent" xml-lang="en-US">0, False: not checked<br />1, True: checked<br />2: grayed, don't know</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id891598543254563" role="tablecontent" xml-lang="en-US">ComboBox</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id781598543254887" role="tablecontent" xml-lang="en-US">String</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id331598543254947" role="tablecontent" xml-lang="en-US">The selected value. The <literal>ListIndex</literal> property is an alternate option.</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id58159854325446" role="tablecontent" xml-lang="en-US">CurrencyField</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id5159854325443" role="tablecontent" xml-lang="en-US">Numeric</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id90159854325450" role="tablecontent" xml-lang="en-US"></paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id241598543254415" role="tablecontent" xml-lang="en-US">DateField</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id401598543254743" role="tablecontent" xml-lang="en-US">Date</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id421598543254587" role="tablecontent" xml-lang="en-US"></paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id851598543254508" role="tablecontent" xml-lang="en-US">FileControl</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id731598543254544" role="tablecontent" xml-lang="en-US">String</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id971598543254757" role="tablecontent" xml-lang="en-US">A file name formatted in accordance with the <literal>FileNaming</literal> property of the <literal>ScriptForge.FileSystem</literal> service</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id921598543254323" role="tablecontent" xml-lang="en-US">FormattedField</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id221598543254760" role="tablecontent" xml-lang="en-US">String or Numeric</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id651598543254212" role="tablecontent" xml-lang="en-US"></paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id151598543254318" role="tablecontent" xml-lang="en-US">ListBox</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id42159854325422" role="tablecontent" xml-lang="en-US">String or array of strings</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id601598543254780" role="tablecontent" xml-lang="en-US">The selected row(s) as a scalar or as an array depending on the <literal>MultiSelect</literal> attribute</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id771598543254973" role="tablecontent" xml-lang="en-US">NumericField</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id461598543254909" role="tablecontent" xml-lang="en-US">Numeric</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id161598543254662" role="tablecontent" xml-lang="en-US"></paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id38159854325480" role="tablecontent" xml-lang="en-US">PatternField</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id81598543254625" role="tablecontent" xml-lang="en-US">String</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id911598543254335" role="tablecontent" xml-lang="en-US"></paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id951598543254998" role="tablecontent" xml-lang="en-US">ProgressBar</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id631598543254771" role="tablecontent" xml-lang="en-US">Numeric</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id91598543254766" role="tablecontent" xml-lang="en-US">Must be within the predefined bounds</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id791598543254779" role="tablecontent" xml-lang="en-US">RadioButton</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id561598543254115" role="tablecontent" xml-lang="en-US">Boolean</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id851598543254624" role="tablecontent" xml-lang="en-US">Each button has its own name. They are linked together if their TAB positions are contiguous. If a radiobutton is set to <literal>True</literal>, the other related buttons are automatically set to <literal>False</literal></paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id141598543254361" role="tablecontent" xml-lang="en-US">ScrollBar</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id531598543254869" role="tablecontent" xml-lang="en-US">Numeric</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id21598543254994" role="tablecontent" xml-lang="en-US">Must be within the predefined bounds</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id811598543254140" role="tablecontent" xml-lang="en-US">TextField</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id751598543254299" role="tablecontent" xml-lang="en-US">String</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id441598543254738" role="tablecontent" xml-lang="en-US">The text appearing in the field</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id89159854325478" role="tablecontent" xml-lang="en-US">TimeField</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id341598543254600" role="tablecontent" xml-lang="en-US">Date</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id881598543254964" role="tablecontent" xml-lang="en-US"></paragraph>
+ </tablecell>
+ </tablerow>
+ </table>
+
+ <h2 id="hd_id421583670049913" xml-lang="en-US">Methods</h2>
+
+ <table id="tab_id891606472825856">
+ <tablerow>
+ <tablecell colspan="2"><paragraph id="par_id891611613601554" role="tablehead" xml-lang="en-US">List of Methods in the DialogControl Service</paragraph></tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell><paragraph id="par_id381606472825856" role="tablecontent" localize="false">
+ <link href="text/sbasic/shared/03/sf_control.xhp#SetFocus" name="SetFocus method">SetFocus</link>
+ </paragraph></tablecell>
+ <tablecell><paragraph id="par_id161606472825856" role="tablecontent" localize="false">
+ <link href="text/sbasic/shared/03/sf_control.xhp#WriteLine" name="WriteLine method">WriteLine</link><br/>
+ </paragraph></tablecell>
+ </tablerow>
+ </table>
+
+ <section id="SetFocus">
+ <comment> SetFocus -------------------------------------------------------------------------------------------------------------------------- </comment>
+ <bookmark localize="false" branch="index" id="bm_id721583933076548">
+ <bookmark_value>DialogControl service;SetFocus</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id681583933076692" localize="false">SetFocus</h2>
+ <paragraph role="paragraph" id="par_id871583933076448">Set the focus on the control. Return <literal>True</literal> if focusing was successful.</paragraph>
+ <paragraph role="paragraph" id="par_id151598178880227" xml-lang="en-US">This method is often called from a dialog or control event.</paragraph>
+ <h3 id="hd_id61583933076171" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id731583933076815">oControl.SetFocus() As Boolean</paragraph>
+ </bascode>
+ <h3 id="hd_id26158393307687" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id221598179105596">Dim oDlg As Object, oControl As Object</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id171598179111121">Set oDlg = CreateScriptService(,, "myDialog")</paragraph>
+ <paragraph role="bascode" id="bas_id841598179117184">'Dialog stored in current document's standard library</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id681598179123436">Set oControl = oDlg.Controls("thisControl")</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id361598179135096">oControl.SetFocus()</paragraph>
+ </bascode>
+ </section>
+
+ <section id="WriteLine">
+ <comment> WriteLine -------------------------------------------------------------------------------------------------------------------------- </comment>
+ <bookmark localize="false" branch="index" id="bm_id761598619892798">
+ <bookmark_value>DialogControl service;WriteLine</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id961598619892816" localize="false">WriteLine</h2>
+ <paragraph role="paragraph" id="par_id671598619892378">Add a new line at the end of a multiline text field. A newline character will be inserted when appropriate. The method returns <literal>True</literal> when successful.</paragraph>
+ <paragraph role="paragraph" id="par_id941598619892915" xml-lang="en-US">An error is raised if the actual control is not of the type <literal>TextField</literal> or is not multiline.</paragraph>
+ <h3 id="hd_id761598619892682" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id821598619892939">oControl.WriteLine([Line As String]) As Boolean</paragraph>
+ </bascode>
+ <h3 id="hd_id291584541257237" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph" id="par_id1001584541257789"><emph>Line</emph> : The string to insert. Default = an empty line.</paragraph>
+ <h3 id="hd_id391598619892559" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id681598619892624">Dim oDlg As Object, oControl As Object</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id521598619892148">Set oDlg = CreateScriptService(,, "myDialog")</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id391598619892465">Set oControl = oDlg.Controls("thisControl")</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id281598619892850">oControl.WriteLine("a new line")</paragraph>
+ </bascode>
+ </section>
+
+ <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#SF_InternalUse"/>
+
+ <section id="relatedtopics">
+ <embed href="text/sbasic/shared/03/sf_dialog.xhp#dlg_h1"/>
+ <embed href="text/sbasic/shared/03/sf_ui.xhp#UIService"/>
+ </section>
+
+</body>
+</helpdocument>