AllLangHelp_sbasic.mk | 1 source/auxiliary/sbasic.tree | 1 source/text/sbasic/shared/03/sf_array.xhp | 68 - source/text/sbasic/shared/03/sf_base.xhp | 6 source/text/sbasic/shared/03/sf_basic.xhp | 10 source/text/sbasic/shared/03/sf_calc.xhp | 20 source/text/sbasic/shared/03/sf_chart.xhp | 8 source/text/sbasic/shared/03/sf_database.xhp | 10 source/text/sbasic/shared/03/sf_datasheet.xhp | 40 source/text/sbasic/shared/03/sf_dialog.xhp | 42 source/text/sbasic/shared/03/sf_dialogcontrol.xhp | 57 - source/text/sbasic/shared/03/sf_dictionary.xhp | 28 source/text/sbasic/shared/03/sf_document.xhp | 8 source/text/sbasic/shared/03/sf_exception.xhp | 24 source/text/sbasic/shared/03/sf_filesystem.xhp | 24 source/text/sbasic/shared/03/sf_form.xhp | 24 source/text/sbasic/shared/03/sf_formcontrol.xhp | 42 source/text/sbasic/shared/03/sf_l10n.xhp | 24 source/text/sbasic/shared/03/sf_menu.xhp | 12 source/text/sbasic/shared/03/sf_platform.xhp | 6 source/text/sbasic/shared/03/sf_popupmenu.xhp | 18 source/text/sbasic/shared/03/sf_region.xhp | 15 source/text/sbasic/shared/03/sf_session.xhp | 22 source/text/sbasic/shared/03/sf_string.xhp | 24 source/text/sbasic/shared/03/sf_textstream.xhp | 24 source/text/sbasic/shared/03/sf_timer.xhp | 12 source/text/sbasic/shared/03/sf_toc.xhp | 1013 ++++++++++++++++++++++ source/text/sbasic/shared/03/sf_ui.xhp | 30 source/text/sbasic/shared/03/sf_unittest.xhp | 18 29 files changed, 1398 insertions(+), 233 deletions(-)
New commits: commit bd899b607eed60487a75905a398b751cf5332352 Author: Rafael Lima <rafael.palma.l...@gmail.com> AuthorDate: Fri Dec 16 15:00:21 2022 +0000 Commit: Olivier Hallot <olivier.hal...@libreoffice.org> CommitDate: Sat Dec 17 12:02:57 2022 +0000 Create TOC with all ScriptForge methods and properties Change-Id: I32be401689efce0cba70216458bc7c8ba4a405c5 Reviewed-on: https://gerrit.libreoffice.org/c/help/+/144309 Tested-by: Jenkins Reviewed-by: Olivier Hallot <olivier.hal...@libreoffice.org> diff --git a/AllLangHelp_sbasic.mk b/AllLangHelp_sbasic.mk index 29b4ae9b8e..c864e3d0b9 100644 --- a/AllLangHelp_sbasic.mk +++ b/AllLangHelp_sbasic.mk @@ -107,6 +107,7 @@ $(eval $(call gb_AllLangHelp_add_helpfiles,sbasic,\ helpcontent2/source/text/sbasic/shared/03/sf_string \ helpcontent2/source/text/sbasic/shared/03/sf_textstream \ helpcontent2/source/text/sbasic/shared/03/sf_timer \ + helpcontent2/source/text/sbasic/shared/03/sf_toc \ helpcontent2/source/text/sbasic/shared/03/sf_ui \ helpcontent2/source/text/sbasic/shared/03/sf_unittest \ helpcontent2/source/text/sbasic/shared/03/sf_writer \ diff --git a/source/auxiliary/sbasic.tree b/source/auxiliary/sbasic.tree index 58ac3fb30d..6a97572f6a 100644 --- a/source/auxiliary/sbasic.tree +++ b/source/auxiliary/sbasic.tree @@ -346,6 +346,7 @@ </node> <node id="07010305" title="ScriptForge Library"> <topic id="sbasic/text/sbasic/shared/03/lib_ScriptForge.xhp">Overview of the ScriptForge Library</topic> + <topic id="sbasic/text/sbasic/shared/03/sf_toc.xhp">List of all ScriptForge methods and properties</topic> <topic id="sbasic/text/sbasic/shared/03/sf_intro.xhp">Creating Python Scripts with ScriptForge</topic> <topic id="sbasic/text/sbasic/shared/03/sf_methods.xhp">ScriptForge method signatures</topic> <topic id="sbasic/text/sbasic/shared/03/sf_array.xhp">Array service</topic> diff --git a/source/text/sbasic/shared/03/sf_array.xhp b/source/text/sbasic/shared/03/sf_array.xhp index e1fe560429..d1de918774 100644 --- a/source/text/sbasic/shared/03/sf_array.xhp +++ b/source/text/sbasic/shared/03/sf_array.xhp @@ -50,38 +50,46 @@ <paragraph role="bascode" localize="false" id="bas_id81586595097173">arr = svc.Append(arr, 4)</paragraph> </bascode> <warning id="par_id571609956486468">Because Python has built-in list and tuple support, most of the methods in the <literal>Array</literal> service are available for Basic scripts only. The only exception is <literal>ImportFromCSVFile</literal> which is supported in both Basic and Python.</warning> + <section id="methods_toc"> <table id="tab_id221606235233835"> <tablerow> - <tablecell colspan="3"><paragraph id="par_id651606319520519" role="tablehead">List of Methods in the Array Service</paragraph></tablecell> + <tablecell colspan="3"> + <paragraph id="par_id651606319520519" role="tablehead">List of Methods in the Array Service</paragraph> + </tablecell> </tablerow> <tablerow> - <tablecell><paragraph id="par_id361606235233835" role="tablecontent" localize="false"> - <link href="text/sbasic/shared/03/sf_array.xhp#Append">Append</link><br/> - <link href="text/sbasic/shared/03/sf_array.xhp#AppendColumn">AppendColumn</link><br/> - <link href="text/sbasic/shared/03/sf_array.xhp#AppendRow">AppendRow</link><br/> - <link href="text/sbasic/shared/03/sf_array.xhp#Contains">Contains</link><br/> - <link href="text/sbasic/shared/03/sf_array.xhp#ConvertToDictionary">ConvertToDictionary</link><br/> - <link href="text/sbasic/shared/03/sf_array.xhp#Copy">Copy</link><br/> - <link href="text/sbasic/shared/03/sf_array.xhp#CountDims">CountDims</link><br/> - <link href="text/sbasic/shared/03/sf_array.xhp#Difference">Difference</link><br/> - <link href="text/sbasic/shared/03/sf_array.xhp#ExportToTextFile">ExportToTextFile</link><br/> - <link href="text/sbasic/shared/03/sf_array.xhp#ExtractColumn">ExtractColumn</link><br/> - <link href="text/sbasic/shared/03/sf_array.xhp#ExtractRow">ExtractRow</link><br/> - </paragraph></tablecell> - <tablecell><paragraph id="par_id231606235233835" role="tablecontent" localize="false"> - <link href="text/sbasic/shared/03/sf_array.xhp#Flatten">Flatten</link><br/> - <link href="text/sbasic/shared/03/sf_array.xhp#ImportFromCSVFile">ImportFromCSVFile</link><br/> - <link href="text/sbasic/shared/03/sf_array.xhp#IndexOf">IndexOf</link><br/> - <link href="text/sbasic/shared/03/sf_array.xhp#Insert">Insert</link><br/> - <link href="text/sbasic/shared/03/sf_array.xhp#InsertSorted">InsertSorted</link><br/> - <link href="text/sbasic/shared/03/sf_array.xhp#Intersection">Intersection</link><br/> - <link href="text/sbasic/shared/03/sf_array.xhp#Join2D">Join2D</link><br/> - <link href="text/sbasic/shared/03/sf_array.xhp#Prepend">Prepend</link><br/> - <link href="text/sbasic/shared/03/sf_array.xhp#PrependColumn">PrependColumn</link><br/> - <link href="text/sbasic/shared/03/sf_array.xhp#PrependRow">PrependRow</link><br/> - <link href="text/sbasic/shared/03/sf_array.xhp#RangeInit">RangeInit</link><br/> - </paragraph></tablecell> - <tablecell><paragraph id="par_id831606235233835" role="tablecontent" localize="false"> + <tablecell> + <paragraph id="par_id361606235233835" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_array.xhp#Append">Append</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#AppendColumn">AppendColumn</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#AppendRow">AppendRow</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#Contains">Contains</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#ConvertToDictionary">ConvertToDictionary</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#Copy">Copy</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#CountDims">CountDims</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#Difference">Difference</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#ExportToTextFile">ExportToTextFile</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#ExtractColumn">ExtractColumn</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#ExtractRow">ExtractRow</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id231606235233835" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_array.xhp#Flatten">Flatten</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#ImportFromCSVFile">ImportFromCSVFile</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#IndexOf">IndexOf</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#Insert">Insert</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#InsertSorted">InsertSorted</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#Intersection">Intersection</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#Join2D">Join2D</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#Prepend">Prepend</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#PrependColumn">PrependColumn</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#PrependRow">PrependRow</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#RangeInit">RangeInit</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831606235233835" role="tablecontent" localize="false"> <link href="text/sbasic/shared/03/sf_array.xhp#Reverse">Reverse</link><br/> <link href="text/sbasic/shared/03/sf_array.xhp#Shuffle">Shuffle</link><br/> <link href="text/sbasic/shared/03/sf_array.xhp#Slice">Slice</link><br/> @@ -92,9 +100,11 @@ <link href="text/sbasic/shared/03/sf_array.xhp#TrimArray">TrimArray</link><br/> <link href="text/sbasic/shared/03/sf_array.xhp#Union">Union</link><br/> <link href="text/sbasic/shared/03/sf_array.xhp#Unique">Unique</link><br/><br/> - </paragraph></tablecell> + </paragraph> + </tablecell> </tablerow> </table> + </section> <tip id="par_id191582454485250">The first argument of most methods is the array object to be considered. It is always passed by reference and left unchanged. Methods such as Append, Prepend, etc return a new array object after their execution.</tip> <section id="Append"> diff --git a/source/text/sbasic/shared/03/sf_base.xhp b/source/text/sbasic/shared/03/sf_base.xhp index 2fa83cb3ee..9ef4987f76 100644 --- a/source/text/sbasic/shared/03/sf_base.xhp +++ b/source/text/sbasic/shared/03/sf_base.xhp @@ -76,7 +76,8 @@ </pycode> <note id="par_id281619619980185">The use of the <emph>"SFDocuments."</emph> substring in the previous example is optional.</note> -<table id="tab_id101619034669263"> + <section id="methods_toc"> + <table id="tab_id101619034669263"> <tablerow> <tablecell colspan="3"> <paragraph id="par_id451619034669263" role="tablehead">List of Methods in the Base Service</paragraph> @@ -106,7 +107,8 @@ </paragraph> </tablecell> </tablerow> -</table> + </table> + </section> <section id="CloseFormDocument"> <comment> CloseFormDocument ------------------------------------------------------------------------------------- </comment> diff --git a/source/text/sbasic/shared/03/sf_basic.xhp b/source/text/sbasic/shared/03/sf_basic.xhp index da0e45cc9c..2dbd3a0292 100644 --- a/source/text/sbasic/shared/03/sf_basic.xhp +++ b/source/text/sbasic/shared/03/sf_basic.xhp @@ -37,6 +37,7 @@ <paragraph role="pycode" localize="false" id="pyc_id121618496552817">bas = CreateScriptService("Basic")</paragraph> </pycode> <h2 id="hd_id201618922972557">Properties</h2> + <section id="properties_toc"> <table id="tab_id991618922991909"> <tablerow> <tablecell><paragraph id="par_id401618922991909" role="tablehead">Name</paragraph></tablecell> @@ -115,9 +116,13 @@ </tablecell> </tablerow> </table> + </section> + <section id="methods_toc"> <table id="tab_id901611086279902"> <tablerow> - <tablecell colspan="3"><paragraph id="par_id651606319520519" role="tablehead">List of Methods in the Basic Service</paragraph></tablecell> + <tablecell colspan="3"> + <paragraph id="par_id651606319520519" role="tablehead">List of Methods in the Basic Service</paragraph> + </tablecell> </tablerow> <tablerow> <tablecell> @@ -159,6 +164,7 @@ </tablecell> </tablerow> </table> + </section> <section id="CDate"> <comment> CDate ------------------------------------------------------------------------- </comment> @@ -300,7 +306,7 @@ <paragraph role="paragraph" id="par_id3615892001216366"><emph>unostructure</emph>: A fully qualified structure name such as <literal>com.sun.star.beans.Property</literal> or <literal>com.sun.star.util.DateTime</literal>.</paragraph> <embed href="text/sbasic/shared/00000003.xhp#functexample"/> <pycode> - <paragraph role="pycode" localize="false" id="pyc_id891589200121516">date_struct = bas.CreateUnoStruct('com.sun.star.util.DateTime')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id891589200121516">date_struct = CreateUnoStruct('com.sun.star.util.DateTime')</paragraph> </pycode> </section> diff --git a/source/text/sbasic/shared/03/sf_calc.xhp b/source/text/sbasic/shared/03/sf_calc.xhp index ce64c6b9fd..3fb471e40a 100644 --- a/source/text/sbasic/shared/03/sf_calc.xhp +++ b/source/text/sbasic/shared/03/sf_calc.xhp @@ -219,7 +219,8 @@ <h2 id="hd_id351582885195476" xml-lang="en-US">Properties</h2> <paragraph role="paragraph" id="par_id151591018231905" xml-lang="en-US">All the properties generic to any document are implicitly applicable also to Calc documents. For more information, read the <link href="text/sbasic/shared/03/sf_document.xhp">Document service Help page</link>.</paragraph> <paragraph role="paragraph" id="par_id911591018242565" xml-lang="en-US">The properties specifically available for Calc documents are:</paragraph> - <table id="tab_id971582885195582"> + <section id="properties_toc"> + <table id="tab_id971582885195582"> <tablerow> <tablecell> <paragraph id="par_id41582885195836" role="tablehead" xml-lang="en-US">Name</paragraph> @@ -526,14 +527,18 @@ <paragraph id="par_id41592315560095" role="tablecontent" xml-lang="en-US">A <literal>com.sun.star.sheet.XSpreadsheet</literal> UNO object.</paragraph> </tablecell> </tablerow> -</table> + </table> + </section> <tip id="par_id321611613059105">Visit %PRODUCTNAME API Documentation's website to learn more about <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1table_1_1XCellRange.html">XCellRange</link>, <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1sheet_1_1XSheetCellCursor.html">XSheetCellCursor</link> and <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1sheet_1_1XSpreadsheet.html">XSpreadsheet</link> UNO objects.</tip> <h2 id="hd_id501582887473754" xml-lang="en-US">Methods</h2> + <section id="methods_toc"> <table id="tab_id501611613601554"> <tablerow> - <tablecell colspan="3"><paragraph id="par_id891611613601554" role="tablehead" xml-lang="en-US">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> @@ -593,7 +598,8 @@ </paragraph> </tablecell> </tablerow> -</table> + </table> + </section> <section id="A1Style"> <comment> A1Style ----------------------------------------------------------------------------------------------- </comment> @@ -788,7 +794,7 @@ <pycode> <paragraph role="pycode" localize="false" id="pyc_id501621536545590">myDoc.ClearFormats("SheetX.*")</paragraph> </pycode> - <tip id="par_id461670942481008">Refer to the <link href="text/sbasic/shared/03/sf_calc.xhp#ClearAll" name="ClearAll_link3"><literal>ClearAll</literal></link> method documentation available above for examples on how to use the arguments <literal>filterformula</literal> and <literal>filterscope</literal>.</tip> + <tip id="par_id461670942481018">Refer to the <link href="text/sbasic/shared/03/sf_calc.xhp#ClearAll" name="CHANGE ME"><literal>ClearAll</literal></link> method documentation for examples on how to use the arguments <literal>filterformula</literal> and <literal>filterscope</literal>.</tip> </section> <section id="ClearValues"> @@ -815,7 +821,7 @@ <pycode> <paragraph role="pycode" localize="false" id="pyc_id451621536678434">myDoc.ClearValues("SheetX.A1:F10")</paragraph> </pycode> - <tip id="par_id461670942481009">Refer to the <link href="text/sbasic/shared/03/sf_calc.xhp#ClearAll" name="ClearAll_link3"><literal>ClearAll</literal></link> method documentation available above for examples on how to use the arguments <literal>filterformula</literal> and <literal>filterscope</literal>.</tip> + <tip id="par_id461670942483664">Refer to the <link href="text/sbasic/shared/03/sf_calc.xhp#ClearAll" name="CHANGE ME"><literal>ClearAll</literal>literal></link> method documentation for examples on how to use the arguments <literal>filterformula</literal> and <literal>filterscope</literal>.</tip> </section> <section id="CompactLeft"> @@ -1800,7 +1806,7 @@ <paragraph role="pycode" localize="false" id="pyc_id731621622966995">myDoc.SetCellStyle("A1:J1", "Heading 1")</paragraph> <paragraph role="pycode" localize="false" id="pyc_id931621622967434">myDoc.SetCellStyle("A2:J100", "Neutral")</paragraph> </pycode> - <tip id="par_id461670942481010">Refer to the <link href="text/sbasic/shared/03/sf_calc.xhp#ClearAll" name="ClearAll_link3"><literal>ClearAll</literal></link> method documentation available above for examples on how to use the arguments <literal>filterformula</literal> and <literal>filterscope</literal>.</tip> + <tip id="par_id461670942481294">Refer to the <link href="text/sbasic/shared/03/sf_calc.xhp#ClearAll" name="CHANGE ME"><literal>ClearAll</literal></link> method documentation for examples on how to use the arguments <literal>filterformula</literal> and <literal>filterscope</literal>.</tip> </section> <section id="SetFormula"> diff --git a/source/text/sbasic/shared/03/sf_chart.xhp b/source/text/sbasic/shared/03/sf_chart.xhp index 01f113a517..3b608a2fd7 100644 --- a/source/text/sbasic/shared/03/sf_chart.xhp +++ b/source/text/sbasic/shared/03/sf_chart.xhp @@ -99,6 +99,7 @@ <bookmark_value>Chart service;XTableChart</bookmark_value> </bookmark> <h2 id="hd_id711600788076834">Properties</h2> + <section id="properties_toc"> <table id="tab_id701600788076583"> <tablerow> <tablecell> @@ -327,6 +328,7 @@ </tablecell> </tablerow> </table> + </section> <h2 id="hd_id581635335807782">Creating a chart</h2> <paragraph role="paragraph" id="par_id231635335826090">Consider the following data in the range "A1:B6" of a sheet named "Report".</paragraph> @@ -418,9 +420,12 @@ <tip id="par_id931635338174647">The chart does not need to be created in the same sheet where the data is located. It can be created in any existing sheet in the current file by specifying the sheet name in the second argument of the <literal>CreateChart</literal> method.</tip> <h2 id="hd_id501582887473754" xml-lang="en-US">Methods</h2> + <section id="methods_toc"> <table id="tab_id501611613601554"> <tablerow> - <tablecell colspan="2"><paragraph id="par_id891611613601554" role="tablehead" xml-lang="en-US">List of Methods in the Chart Service</paragraph></tablecell> + <tablecell colspan="2"> + <paragraph id="par_id891611613601554" role="tablehead" xml-lang="en-US">List of Methods in the Chart Service</paragraph> + </tablecell> </tablerow> <tablerow> <tablecell> @@ -435,6 +440,7 @@ </tablecell> </tablerow> </table> + </section> <section id="ExportToFile"> <comment> ExportToFile ----------------------------------------------------------------------------------------- </comment> diff --git a/source/text/sbasic/shared/03/sf_database.xhp b/source/text/sbasic/shared/03/sf_database.xhp index d5636fc509..d3335ef008 100644 --- a/source/text/sbasic/shared/03/sf_database.xhp +++ b/source/text/sbasic/shared/03/sf_database.xhp @@ -107,6 +107,7 @@ <bookmark_value>Database Service;Tables</bookmark_value> </bookmark> <h2 id="hd_id841587913266618" xml-lang="en-US">Properties</h2> + <section id="properties_toc"> <table id="tab_id291587913266435"> <tablerow> <tablecell> @@ -179,8 +180,10 @@ </tablecell> </tablerow> </table> + </section> -<table id="tab_id551614360519973"> + <section id="methods_toc"> + <table id="tab_id551614360519973"> <tablerow> <tablecell colspan="3"> <paragraph id="par_id231614360519973" role="tablehead">List of Methods in the Database Service</paragraph> @@ -212,7 +215,8 @@ </paragraph> </tablecell> </tablerow> -</table> + </table> + </section> <section id="CloseDatabase"> <comment> CloseDatabase ---------------------------------------------------------------------------------- </comment> @@ -450,7 +454,7 @@ <bookmark_value>Database Service;RunSql</bookmark_value> </bookmark> <h2 id="hd_id80159949060917" localize="false">RunSql</h2> - <paragraph role="paragraph" id="par_id31599490609759">Executes an action query or an SQL statement such as creating a table, as well as inserting, updating and deleting records.</paragraph> + <paragraph role="paragraph" id="par_id31599490609759">Executes an action query of an SQL statement such as creating a table, as well as inserting, updating and deleting records.</paragraph> <paragraph role="paragraph" id="par_id331615385491925">The method returns <literal>True</literal> when successful.</paragraph> <tip id="par_id21599490810021">The <literal>RunSql</literal> method is rejected with an error message in case the database was previously opened in read-only mode.</tip> <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> diff --git a/source/text/sbasic/shared/03/sf_datasheet.xhp b/source/text/sbasic/shared/03/sf_datasheet.xhp index ca6dbd8775..c201f8a1d1 100644 --- a/source/text/sbasic/shared/03/sf_datasheet.xhp +++ b/source/text/sbasic/shared/03/sf_datasheet.xhp @@ -22,7 +22,7 @@ <bookmark_value>Datasheet service</bookmark_value> </bookmark> <h1 id="bm_id781582391760253" xml-lang="en-US"><variable id="ctrls_h1"><link href="text/sbasic/shared/03/sf_datasheet.xhp" name="SFDatabases.Datasheet service"><literal>SFDatabases</literal>.<literal>Datasheet</literal> service</link></variable></h1> - <paragraph role="paragraph" id="par_id901619031958273">The <literal>Datasheet</literal> service allows to visualize the contents of database tables as well as the results of queries and SQL statements using Base's Data View. Additionally, this service allows to:</paragraph> + <paragraph role="paragraph" id="par_id901619031958273">The <literal>Datasheet</literal> service allows to visualize the contents of database tables using Base's Data View. Additionally, this service allows to:</paragraph> <list type="unordered"> <listitem> <paragraph id="par_id241619032289964" role="listitem">Add custom menus to the data view.</paragraph> @@ -41,7 +41,7 @@ <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#importLibs"/> <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> <paragraph role="paragraph" id="par_id311619033224680">The <literal>Datasheet</literal> service can be invoked in two different ways depending on whether the database file is open.</paragraph> - <paragraph role="paragraph" id="par_id781671108693239">The example below considers that the database file is open, hence the <literal>UI</literal> service can be used to retrieve the document and the <literal>OpenTable</literal> method from the <literal>Database</literal> service is used to get a <literal>Datasheet</literal> service instance.</paragraph> + <paragraph role="paragraph" id="par_id781671108693239">The example below considers that the database file is open, hence the <literal>UI</literal> service can be used to retireve the document and the <literal>OpenTable</literal> method from the <literal>Database</literal> service is used to get a <literal>Datasheet</literal> service instance.</paragraph> <bascode> <paragraph role="bascode" id="bas_id561671040218003">Dim ui As Object, oBase As Object, oSheet As Object</paragraph> <paragraph role="bascode" localize="false" id="bas_id791619033406225">Set ui = CreateScriptService("UI")</paragraph> @@ -51,7 +51,7 @@ <paragraph role="bascode" localize="false" id="bas_id101619033409330">Set oSheet = oBase.OpenTable("Customers")</paragraph> </bascode> <paragraph role="paragraph" id="par_id721671040093835">In the example above it is also possible to use the method <literal>OpenQuery</literal> from the <literal>Base</literal> service to get a <literal>Datasheet</literal> instance.</paragraph> - <paragraph role="paragraph" id="par_id281619033570656">To invoke the <literal>Datasheet</literal> service when the database file is not open, use the <literal>OpenTable</literal>, <literal>OpenQuery</literal> or <literal>OpenSql</literal> methods from the <literal>Database</literal> service. The example below uses the <literal>OpenTable</literal> method to open an existing table in the database file:</paragraph> + <paragraph role="paragraph" id="par_id281619033570656">To invoke the <literal>Datasheet</literal> service when the database file is not open, use the <literal>OpenTable</literal> method of the <literal>Database</literal> service as illustrated next:</paragraph> <bascode> <paragraph role="bascode" localize="false" id="bas_id941619033409619">Dim oDatabase As Object, oSheet As Object</paragraph> <paragraph role="bascode" id="bas_id451671040032621">' Object oDatabase is an instance of the Database service</paragraph> @@ -72,9 +72,10 @@ <paragraph role="pycode" localize="false" id="pyc_id861671040733796">sheet = database.OpenTable("Customers")</paragraph> </pycode> -<h2 id="hd_id711600788076834">Properties</h2> + <h2 id="hd_id711600788076834">Properties</h2> <paragraph role="paragraph" id="par_id31671041470077">The following properties are available in the <literal>Datasheet</literal> service:</paragraph> - <table id="tab_id701600788076583"> + <section id="properties_toc"> + <table id="tab_id701600788076583"> <tablerow> <tablecell> <paragraph id="par_id461600788076917" role="tablehead">Name</paragraph> @@ -271,10 +272,12 @@ <paragraph id="par_id631600789527859" role="tablecontent">Returns the <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1XTabControllerModel.html" name="XTabControllerModel">com.sun.star.awt.XTabControllerModel</link> UNO object that represents the datasheet.</paragraph> </tablecell> </tablerow> - </table> + </table> + </section> <h2 id="hd_id501582887473754">Methods</h2> - <table id="tab_id101619034669263"> + <section id="methods_toc"> + <table id="tab_id101619034669263"> <tablerow> <tablecell colspan="3"> <paragraph id="par_id451619034669263" role="tablehead">List of Methods in the Datasheet Service</paragraph> @@ -301,7 +304,8 @@ </paragraph> </tablecell> </tablerow> - </table> + </table> + </section> <section id="Activate"> <comment> Activate -------------------------------------------------------------------------------------------- </comment> @@ -394,10 +398,10 @@ <note id="par_id161671050245887">This method does not change the position of the cursor in the data view window.</note> <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> <paragraph role="paragraph" localize="false" id="par_id71615225513340"> - <input>svc.GetText(column: any): str</input> + <input>svc.GetText(opt column: any): str</input> </paragraph> <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> - <paragraph role="paragraph" id="par_id941619079997693"><emph>column:</emph> The name of the column as a String or the column position (starting at 1). If a position greater than the number of columns is given, the last column is returned.</paragraph> + <paragraph role="paragraph" id="par_id941619079997693"><emph>column:</emph> The name of the column as a String or the column position (starting at 1). If a position greater than the number of columns is given, the last column is returned. If this argument is not specified then the currently selected column is returned.</paragraph> <embed href="text/sbasic/shared/00000003.xhp#functexample"/> <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> <bascode> @@ -416,16 +420,16 @@ </bookmark> <h2 id="hd_id61161309633547" localize="false">GetValue</h2> <paragraph role="paragraph" id="par_id801916099747177">Returns the value in a given column of the current row as a valid Basic type.</paragraph> - <paragraph role="paragraph" id="par_id91671050315349">The types that can be returned are: <literal>String</literal>, <literal>Integer</literal>, <literal>Long</literal>, <literal>Single</literal>, <literal>Double</literal>, <literal>Date</literal> and <literal>Null</literal>.</paragraph> - <paragraph role="paragraph" id="par_id411671050476363">Binary types are returned as a <literal>Long</literal> value indicating the length of the binary field.</paragraph> + <paragraph role="paragraph" id="par_id91671050315349">The types that can be returned are: <literal>String</literal>, <literal>Integer</literal>, <literal>Long</literal>, <literal>Double</literal>, <literal>Date</literal> and <literal>Null</literal>.</paragraph> + <paragraph role="paragraph" id="par_id411671050476363">Binary types are returned as a <literal>Long</literal> value.</paragraph> <paragraph role="paragraph" id="par_id141671050559691">An <literal>Empty</literal> value is returned if the required value could not be retrieved.</paragraph> <note id="par_id161671050245365">This method does not change the position of the cursor in the data view window.</note> <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> <paragraph role="paragraph" localize="false" id="par_id71615225513355"> - <input>svc.GetValue(column: any): any</input> + <input>svc.GetValue(opt column: any): any</input> </paragraph> <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> - <paragraph role="paragraph" id="par_id941619079997253"><emph>column:</emph> The name of the column as a String or the column position (starting at 1). If a position greater than the number of columns is given, the last column is returned.</paragraph> + <paragraph role="paragraph" id="par_id941619079997253"><emph>column:</emph> The name of the column as a String or the column position (starting at 1). If a position greater than the number of columns is given, the last column is returned. If this argument is not specified then the currently selected column is returned.</paragraph> <embed href="text/sbasic/shared/00000003.xhp#functexample"/> <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> <bascode> @@ -461,16 +465,16 @@ <paragraph role="bascode" localize="false" id="bas_id461619100382302">oSheet.GoToCell(Column := 3)</paragraph> <paragraph role="bascode" id="bas_id611671106014685">' Moves cursor one row down leaving it in the same column</paragraph> <paragraph role="bascode" localize="false" id="bas_id301671106059707">oSheet.GoToCell(Row := oSheet.CurrentRow + 1)</paragraph> - <paragraph role="bascode" id="bas_id711671107842042">' Moves to the last column of the last row</paragraph> - <paragraph role="bascode" localize="false" id="bas_id101671107871019">Dim LastColumn As Integer : LastColumn = UBound(oSheet.ColumnHeaders) + 1</paragraph> - <paragraph role="bascode" localize="false" id="bas_id721671107903292">oSheet.GoToCell(oSheet.LastRow, LastColumn)</paragraph> + <paragraph role="bascode" id="bas_id711671107842042">' Moves to the first column of the last row</paragraph> + <paragraph role="bascode" localize="false" id="bas_id101671107871019">Dim LastRow As Integer : LastRow = UBound(oSheet.ColumnHeaders) + 1</paragraph> + <paragraph role="bascode" localize="false" id="bas_id721671107903292">oSheet.GoToCell(LastRow, 1)</paragraph> </bascode> <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> <pycode> <paragraph role="pycode" id="pyc_id361623165059099">sheet.GoToCell(4, "LastName")</paragraph> <paragraph role="pycode" localize="false" id="pyc_id971671106400005">sheet.GoToCell(column=3)</paragraph> <paragraph role="pycode" localize="false" id="pyc_id351671106399053">sheet.GoToCell(row=sheet.CurrentRow + 1)</paragraph> - <paragraph role="pycode" localize="false" id="pyc_id231671107978407">sheet.GoToCell(sheet.LastRow, len(sheet.ColumnHeaders))</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id231671107978407">sheet.GoToCell(len(sheet.ColumnHeaders), 1)</paragraph> </pycode> </section> diff --git a/source/text/sbasic/shared/03/sf_dialog.xhp b/source/text/sbasic/shared/03/sf_dialog.xhp index dcf120daef..bda2fd4265 100644 --- a/source/text/sbasic/shared/03/sf_dialog.xhp +++ b/source/text/sbasic/shared/03/sf_dialog.xhp @@ -106,7 +106,8 @@ </pycode> <h2 id="hd_id651583668365757" xml-lang="en-US">Properties</h2> - <table id="tab_id381583668386455"> + <section id="properties_toc"> + <table id="tab_id381583668386455"> <tablerow> <tablecell> <paragraph id="par_id871583668386455" role="tablehead" xml-lang="en-US">Name</paragraph> @@ -406,31 +407,40 @@ <paragraph id="par_id35161262983642" role="tablecontent" xml-lang="en-US">Mouse button released</paragraph> </tablecell> </tablerow> - </table> - <table id="tab_id891606472825856"> + </table> + </section> + <section id="methods_toc"> + <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> + <tablecell colspan="3"> + <paragraph id="par_id891611613601554" role="tablehead" xml-lang="en-US">List of Methods in the Dialog Service</paragraph> + </tablecell> </tablerow> <tablerow> - <tablecell><paragraph id="par_id381606472825856" role="tablecontent" localize="false"> + <tablecell> + <paragraph id="par_id381606472825856" role="tablecontent" localize="false"> <link href="text/sbasic/shared/03/sf_dialog.xhp#Activate">Activate</link><br/> <link href="text/sbasic/shared/03/sf_dialog.xhp#Center">Center</link><br/> <link href="text/sbasic/shared/03/sf_dialog.xhp#Controls">Controls</link><br/> - </paragraph></tablecell> - <tablecell><paragraph id="par_id451606472825856" role="tablecontent" localize="false"> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id451606472825856" role="tablecontent" localize="false"> <link href="text/sbasic/shared/03/sf_dialog.xhp#EndExecute">EndExecute</link><br/> <link href="text/sbasic/shared/03/sf_dialog.xhp#Execute">Execute</link><br/> <link href="text/sbasic/shared/03/sf_dialog.xhp#GetTextsFromL10N">GetTextsFromL10N</link><br/> - </paragraph></tablecell> - <tablecell><paragraph id="par_id161606472825856" role="tablecontent" localize="false"> - <link href="text/sbasic/shared/03/sf_dialog.xhp#Resize">Resize</link><br/> - <link href="text/sbasic/shared/03/sf_dialog.xhp#SetPageManager">SetPageManager</link><br/> - <link href="text/sbasic/shared/03/sf_dialog.xhp#Terminate">Terminate</link><br/> - </paragraph></tablecell> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id161606472825856" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_dialog.xhp#Resize">Resize</link><br/> + <link href="text/sbasic/shared/03/sf_dialog.xhp#SetPageManager">SetPageManager</link><br/> + <link href="text/sbasic/shared/03/sf_dialog.xhp#Terminate">Terminate</link><br/> + </paragraph> + </tablecell> </tablerow> - </table> + </table> + </section> <section id="Activate"> <comment> Activate -------------------------------------------------------------------------------------------------------------------------- </comment> diff --git a/source/text/sbasic/shared/03/sf_dialogcontrol.xhp b/source/text/sbasic/shared/03/sf_dialogcontrol.xhp index 642acfeaa8..d2045aa855 100644 --- a/source/text/sbasic/shared/03/sf_dialogcontrol.xhp +++ b/source/text/sbasic/shared/03/sf_dialogcontrol.xhp @@ -162,7 +162,8 @@ </listitem> </list> <h2 id="hd_id651583668365757" xml-lang="en-US">Properties</h2> - <table id="tab_id381583668386455"> + <section id="properties_toc"> + <table id="tab_id381583668386455"> <tablerow> <tablecell> <paragraph id="par_id871583668386455" role="tablehead" xml-lang="en-US">Name</paragraph> @@ -607,8 +608,9 @@ <paragraph id="par_id691612699446892" role="tablecontent" xml-lang="en-US">The UNO object representing the tree control data model. Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1tree_1_1XMutableTreeDataModel.html">XMutableTreeDataModel</link> in Application Programming Interface (API) documentation for detailed information.</paragraph> </tablecell> </tablerow> - </table> - + </table> + </section> + <h2 id="hd_id81598540704978" xml-lang="en-US">The <variable id="ValueProperty">Value property</variable></h2> <table id="tab_id48159854325479"> <tablerow> @@ -984,29 +986,38 @@ </tablecell> </tablerow> </table> - - <h2 id="hd_id421583670049913" xml-lang="en-US">Methods</h2> - - <table id="tab_id891606472825856"> + + <h2 id="hd_id421583670049913" xml-lang="en-US">Methods</h2> + <section id="methods_toc"> + <table id="tab_id891606472825856"> <tablerow> - <tablecell colspan="3"><paragraph id="par_id891611613601554" role="tablehead" xml-lang="en-US">List of Methods in the DialogControl Service</paragraph></tablecell> + <tablecell colspan="3"> + <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_id751612709117248" role="tablecontent" localize="false"> - <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#AddSubNode">AddSubNode</link><br/> - <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#AddSubTree">AddSubTree</link><br/> - <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#CreateRoot">CreateRoot</link><br/> - </paragraph></tablecell> - <tablecell><paragraph id="par_id63161270911712" role="tablecontent" localize="false"> - <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#FindNode">FindNode</link><br/> - <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#SetFocus">SetFocus</link><br/><br/> - </paragraph></tablecell> - <tablecell><paragraph id="par_id651612709117457" role="tablecontent" localize="false"> - <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#SetTableData">SetTableData</link><br/> - <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#WriteLine">WriteLine</link><br/><br/> - </paragraph></tablecell> + <tablerow> + <tablecell> + <paragraph id="par_id751612709117248" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#AddSubNode">AddSubNode</link><br/> + <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#AddSubTree">AddSubTree</link><br/> + <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#CreateRoot">CreateRoot</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id63161270911712" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#FindNode">FindNode</link><br/> + <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#SetFocus">SetFocus</link><br/><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id651612709117457" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#SetTableData">SetTableData</link><br/> + <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#WriteLine">WriteLine</link><br/><br/> + </paragraph> + </tablecell> </tablerow> - </table> + </table> + </section> <section id="AddSubNode"> <comment> AddSubNode -------------------------------------------------------------------------------------------- </comment> diff --git a/source/text/sbasic/shared/03/sf_dictionary.xhp b/source/text/sbasic/shared/03/sf_dictionary.xhp index f92d13d5a5..66ea38f8a4 100644 --- a/source/text/sbasic/shared/03/sf_dictionary.xhp +++ b/source/text/sbasic/shared/03/sf_dictionary.xhp @@ -70,6 +70,7 @@ <note id="par_id211626699007613">Because Python has built-in dictionary support, most of the methods in the <literal>Dictionary</literal> service are available for Basic scripts only. Exceptions are <literal>ConvertToPropertyValues</literal> and <literal>ImportFromPropertyValues</literal> that are supported in both Basic and Python.</note> <h2 id="hd_id351582885195476" xml-lang="en-US">Properties</h2> + <section id="properties_toc"> <table id="tab_id971582885195582"> <tablerow> <tablecell> @@ -128,6 +129,7 @@ </tablecell> </tablerow> </table> + </section> <paragraph role="tip" id="par_id461582886731495" xml-lang="en-US">The <literal>Keys</literal> and <literal>Items</literal> properties return their respective contents, using an identical ordering. The order is unrelated to the creation sequence.</paragraph> @@ -141,33 +143,41 @@ <paragraph role="bascode" localize="false" id="bas_id571606473148931">Next b</paragraph> </bascode> + <section id="methods_toc"> <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> + <tablecell colspan="3"> + <paragraph id="par_id891611613601554" role="tablehead" xml-lang="en-US">List of Methods in the Dictionary Service</paragraph> + </tablecell> </tablerow> <tablerow> - <tablecell><paragraph id="par_id381606472825856" role="tablecontent" localize="false"> + <tablecell> + <paragraph id="par_id381606472825856" role="tablecontent" localize="false"> <link href="text/sbasic/shared/03/sf_dictionary.xhp#Add">Add</link><br/> <link href="text/sbasic/shared/03/sf_dictionary.xhp#ConvertToArray">ConvertToArray</link><br/> <link href="text/sbasic/shared/03/sf_dictionary.xhp#ConvertToJson">ConvertToJson</link><br/> <link href="text/sbasic/shared/03/sf_dictionary.xhp#ConvertToPropertyValues">ConvertToPropertyValues</link> - </paragraph></tablecell> - <tablecell><paragraph id="par_id451606472825856" role="tablecontent" localize="false"> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id451606472825856" role="tablecontent" localize="false"> <link href="text/sbasic/shared/03/sf_dictionary.xhp#Exists">Exists</link><br/> <link href="text/sbasic/shared/03/sf_dictionary.xhp#ImportFromJson">ImportFromJson</link><br/> <link href="text/sbasic/shared/03/sf_dictionary.xhp#ImportFromPropertyValues">ImportFromPropertyValues</link><br/> <link href="text/sbasic/shared/03/sf_dictionary.xhp#Item">Item</link> - </paragraph></tablecell> - <tablecell><paragraph id="par_id161606472825856" role="tablecontent" localize="false"> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id161606472825856" role="tablecontent" localize="false"> <link href="text/sbasic/shared/03/sf_dictionary.xhp#Remove">Remove</link><br/> <link href="text/sbasic/shared/03/sf_dictionary.xhp#RemoveAll">RemoveAll</link><br/> <link href="text/sbasic/shared/03/sf_dictionary.xhp#ReplaceItem">ReplaceItem</link><br/> <link href="text/sbasic/shared/03/sf_dictionary.xhp#ReplaceKey">ReplaceKey</link> - </paragraph></tablecell> + </paragraph> + </tablecell> </tablerow> </table> + </section> <section id="Add"> <comment> Add ---------------------------------------------------------------------------------------------------- </comment> diff --git a/source/text/sbasic/shared/03/sf_document.xhp b/source/text/sbasic/shared/03/sf_document.xhp index ea3af55c15..9f19d28b5d 100644 --- a/source/text/sbasic/shared/03/sf_document.xhp +++ b/source/text/sbasic/shared/03/sf_document.xhp @@ -113,6 +113,7 @@ <bookmark_value>API;ODatabaseDocument</bookmark_value> </bookmark> <h2 id="hd_id351582885195476" xml-lang="en-US">Properties</h2> + <section id="properties_toc"> <table id="tab_id971582885195582"> <tablerow> <tablecell> @@ -295,8 +296,9 @@ <tablecell> <paragraph id="par_id881582885195976" role="tablecontent" xml-lang="en-US" >The UNO object <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1lang_1_1XComponent.html"><literal>com.sun.star.lang.XComponent</literal></link> or <link href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1sdb_1_1OfficeDatabaseDocument.html"><literal>com.sun.star.comp.dba.ODatabaseDocument</literal></link> representing the document</paragraph> </tablecell> - </tablerow> -</table> + </tablerow> + </table> + </section> <embed href="text/sbasic/shared/00000003.xhp#functexample"/> <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> @@ -325,6 +327,7 @@ <paragraph role="pycode" localize="false" id="pyc_id71622827327225">doc.CloseDocument()</paragraph> </pycode> + <section id="methods_toc"> <table id="tab_id901611086279902"> <tablerow> <tablecell colspan="3"><paragraph id="par_id651606319520519" role="tablehead">List of Methods in the Document Service</paragraph></tablecell> @@ -355,6 +358,7 @@ </tablecell> </tablerow> </table> + </section> <section id="Activate"> <comment> Activate -------------------------------------------------------------------- </comment> diff --git a/source/text/sbasic/shared/03/sf_exception.xhp b/source/text/sbasic/shared/03/sf_exception.xhp index decfbd2809..46a5e3525c 100644 --- a/source/text/sbasic/shared/03/sf_exception.xhp +++ b/source/text/sbasic/shared/03/sf_exception.xhp @@ -74,7 +74,8 @@ <h2 id="hd_id651584978211886" xml-lang="en-US">Properties</h2> <paragraph role="paragraph" id="par_id911621036526404">The properties listed below are only available for <emph>Basic</emph> scripts.</paragraph> - <table id="tab_id761584978211275"> + <section id="properties_toc"> + <table id="tab_id761584978211275"> <tablerow> <tablecell> <paragraph id="par_id271584978211792" role="tablehead">Name</paragraph> @@ -122,11 +123,13 @@ <paragraph role="paragraph" id="par_id681610652723345">Default value is 0 or the code line number for a standard Basic run-time error.</paragraph> </tablecell> </tablerow> - </table> - <tip id="par_id461584978880380" xml-lang="en-US">Raising or clearing an <literal>Exception</literal> resets its properties.</tip> + </table> + </section> + <tip id="par_id461584978880380">Raising or clearing an <literal>Exception</literal> resets its properties.</tip> <embed href="text/sbasic/shared/ErrVBA.xhp#RestrictedErrorCodes"/> - <table id="tab_id441608131596153"> + <section id="methods_toc"> + <table id="tab_id441608131596153"> <tablerow> <tablecell colspan="3"><paragraph id="par_id881608131596153" role="tablehead">List of Methods in the Exception Service</paragraph></tablecell> </tablerow> @@ -135,26 +138,27 @@ <paragraph id="par_id461608131596153" role="tablecontent" localize="false"> <link href="text/sbasic/shared/03/sf_exception.xhp#Clear">Clear</link><br/> <link href="text/sbasic/shared/03/sf_exception.xhp#Console">Console</link><br/> - <link href="text/sbasic/shared/03/sf_exception.xhp#ConsoleClear">ConsoleClear</link> + <link href="text/sbasic/shared/03/sf_exception.xhp#ConsoleClear">ConsoleClear</link><br/> + <link href="text/sbasic/shared/03/sf_exception.xhp#ConsoleToFile">ConsoleToFile</link> </paragraph> </tablecell> <tablecell> <paragraph role="tablecontent" id="par_id871608132025242" localize="false"> - <link href="text/sbasic/shared/03/sf_exception.xhp#ConsoleToFile">ConsoleToFile</link><br/> <link href="text/sbasic/shared/03/sf_exception.xhp#DebugDisplay">DebugDisplay</link><br/> - <link href="text/sbasic/shared/03/sf_exception.xhp#DebugPrint">DebugPrint</link><br/><br/> + <link href="text/sbasic/shared/03/sf_exception.xhp#DebugPrint">DebugPrint</link><br/> + <link href="text/sbasic/shared/03/sf_exception.xhp#PythonPrint">PythonPrint</link><br/><br/> </paragraph> </tablecell> <tablecell> <paragraph role="tablecontent" id="par_id831608132069033" localize="false"> - <link href="text/sbasic/shared/03/sf_exception.xhp#PythonPrint">PythonPrint</link><br/> <link href="text/sbasic/shared/03/sf_exception.xhp#PythonShell">PythonShell</link><br/> <link href="text/sbasic/shared/03/sf_exception.xhp#Raise">Raise</link><br/> - <link href="text/sbasic/shared/03/sf_exception.xhp#RaiseWarning">RaiseWarning</link><br/> + <link href="text/sbasic/shared/03/sf_exception.xhp#RaiseWarning">RaiseWarning</link><br/><br/> </paragraph> </tablecell> </tablerow> - </table> + </table> + </section> <section id="Clear"> <comment> Clear -------------------------------------------------------------------------------------------------------------------------- </comment> diff --git a/source/text/sbasic/shared/03/sf_filesystem.xhp b/source/text/sbasic/shared/03/sf_filesystem.xhp index 0a697ce0d4..3dfb6a5e33 100644 --- a/source/text/sbasic/shared/03/sf_filesystem.xhp +++ b/source/text/sbasic/shared/03/sf_filesystem.xhp @@ -107,7 +107,7 @@ <h3 id="hd_id991612918109871">File Naming Notation</h3> <paragraph role="paragraph" id="par_id791612918141083">The notation used to express file and folder names, both for arguments and returned values, is defined by the <literal>FileNaming</literal> property of the <literal>FileSystem</literal> service.</paragraph> - <paragraph role="paragraph" id="par_id951612918220255">In short, the possible representation types are "URL" (URL file notation), "SYS" (operating system notation) and "ANY" (default). See more information <link href="text/sbasic/shared/03/sf_filesystem.xhp#properties">below</link>.</paragraph> + <paragraph role="paragraph" id="par_id951612918220255">In short, the possible representation types are "URL" (URL file notation), "SYS" (operating system notation) and "ANY" (default). See more information <link href="text/sbasic/shared/03/sf_filesystem.xhp#properties_toc">below</link>.</paragraph> <tip id="par_id861583589907100" xml-lang="en-US">An example of the URL notation is <emph>file:///C:/Documents/my_file.odt</emph>. Whenever possible consider using the URL notation because it is a more portable alternative.</tip> <warning id="par_id931626652451855">The use of the shortcut "~" (tilde), which is common in Linux-based operating systems, is not supported to express a path to a folder and file name. Instead of using <emph>"~/Documents/my_file.odt"</emph> use the full path <emph>"/home/user/Documents/my_file.odt"</emph>.</warning> @@ -138,7 +138,7 @@ <bookmark_value>FileSystem service;UserTemplatesFolder property</bookmark_value> </bookmark> <h2 id="hd_id651583668365757" xml-lang="en-US">Properties</h2> - <section id="properties"> + <section id="properties_toc"> <table id="tab_id381583668386455"> <tablerow> <tablecell> @@ -278,14 +278,15 @@ <paragraph id="par_id251588334016874" role="tablecontent" xml-lang="en-US">Returns the folder containing the user-defined template files.</paragraph> </tablecell> </tablerow> - </table> + </table> </section> -<table id="tab_id501611613601554"> - <tablerow> - <tablecell colspan="3"><paragraph id="par_id891611613601554" role="tablehead">List of Methods in the FileSystem Service</paragraph></tablecell> - </tablerow> - <tablerow> + <section id="methods_toc"> + <table id="tab_id501611613601554"> + <tablerow> + <tablecell colspan="3"><paragraph id="par_id891611613601554" role="tablehead">List of Methods in the FileSystem Service</paragraph></tablecell> + </tablerow> + <tablerow> <tablecell> <paragraph id="par_id891611613601556" role="tablecontent" localize="false"> <link href="text/sbasic/shared/03/sf_filesystem.xhp#BuildPath">BuildPath</link><br/> @@ -325,8 +326,9 @@ <link href="text/sbasic/shared/03/sf_filesystem.xhp#SubFolders">SubFolders</link><br/> </paragraph> </tablecell> - </tablerow> -</table> + </tablerow> + </table> + </section> <section id="BuildPath"> <comment> BuildPath ----------------------------------------------------------------------------------- </comment> @@ -825,7 +827,7 @@ <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> <paragraph role="paragraph" localize="false" id="par_id601626179529154"> <input>svc.GetName(filename: str): str</input> - </paragraph> + </paragraph> <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> <paragraph role="paragraph" id="par_id671584032366193"><emph>filename</emph>: A string representing the file name and its path.</paragraph> <embed href="text/sbasic/shared/00000003.xhp#functexample"/> diff --git a/source/text/sbasic/shared/03/sf_form.xhp b/source/text/sbasic/shared/03/sf_form.xhp index 01ebbbf503..163c32e390 100644 --- a/source/text/sbasic/shared/03/sf_form.xhp +++ b/source/text/sbasic/shared/03/sf_form.xhp @@ -156,6 +156,7 @@ <paragraph role="paragraph" id="par_id221623150547406">This operation is done implicitly when a form document is closed with the <literal>CloseFormDocument()</literal> method described below.</paragraph> </section> <h2 id="hd_id651583668365757" xml-lang="en-US">Properties</h2> + <section id="properties_toc"> <table id="tab_id381583668386455"> <tablerow> <tablecell> @@ -367,10 +368,12 @@ <paragraph id="par_id191598177924897" role="tablecontent" xml-lang="en-US">The UNO object representing interactions with the form. Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1form_1_1XForm.html">XForm</link> and <link href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1form_1_1component_1_1DataForm.html">DataForm</link> in the API documentation for detailed information.</paragraph> </tablecell> </tablerow> - </table> + </table> + </section> <h2 id="hd_id421612628828054" xml-lang="en-US">Event properties</h2> <paragraph role="paragraph" id="par_id41612629140856" xml-lang="en-US">The properties below return or set URI strings that define the script triggered by the event.</paragraph> - <table id="tab_id951612628879819"> + <section id="event_properties_toc"> + <table id="tab_id951612628879819"> <tablerow> <tablecell> <paragraph id="par_id961612628879819" role="tablehead" xml-lang="en-US">Name</paragraph> @@ -547,11 +550,15 @@ <paragraph id="par_id511616778529291" role="tablecontent" xml-lang="en-US">Before unloading</paragraph> </tablecell> </tablerow> - </table> + </table> + </section> <tip id="par_id961618181634322">To learn more about URI strings, refer to the <link href="https://wiki.documentfoundation.org/Documentation/DevGuide/Scripting_Framework#Scripting_Framework_URI_Specification">Scripting Framework URI Specification</link>.</tip> - <table id="tab_id891606472825856"> - <tablerow> - <tablecell colspan="3"><paragraph id="par_id921606472825856" role="tablehead">List of methods in the Form service</paragraph></tablecell> + <section id="methods_toc"> + <table id="tab_id891606472825856"> + <tablerow> + <tablecell colspan="3"> + <paragraph id="par_id921606472825856" role="tablehead">List of methods in the Form service</paragraph> + </tablecell> </tablerow> <tablerow> <tablecell><paragraph id="par_id381606472825856" role="tablecontent" localize="false"> @@ -572,7 +579,8 @@ <link href="text/sbasic/shared/03/sf_form.xhp#Subforms">SubForms</link><br/><br/> </paragraph></tablecell> </tablerow> - </table> + </table> + </section> <section id="Activate"> <comment> Activate -------------------------------------------------------------------------------------------------------------------------- </comment> <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id721583933076548"> @@ -838,4 +846,4 @@ <embed href="text/sbasic/shared/03/sf_ui.xhp#UIService"/> </section> </body> -</helpdocument> \ No newline at end of file +</helpdocument> diff --git a/source/text/sbasic/shared/03/sf_formcontrol.xhp b/source/text/sbasic/shared/03/sf_formcontrol.xhp index 0cc2d18b02..32f2e16a14 100644 --- a/source/text/sbasic/shared/03/sf_formcontrol.xhp +++ b/source/text/sbasic/shared/03/sf_formcontrol.xhp @@ -161,7 +161,8 @@ </listitem> </list> <h2 id="hd_id651583668365757" xml-lang="en-US">Properties</h2> - <table id="tab_id381583668386455"> + <section id="properties_toc"> + <table id="tab_id381583668386455"> <tablerow> <tablecell> <paragraph id="par_id871583668386455" role="tablehead" xml-lang="en-US">Name</paragraph> @@ -606,7 +607,8 @@ <paragraph id="par_id731598178083442" role="tablecontent" xml-lang="en-US">The UNO object representing the control view. Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1XControl.html">XControl</link> and <link href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1awt_1_1UnoControl.html">UnoControl</link> in the API documentation for more information.</paragraph> </tablecell> </tablerow> - </table> + </table> + </section> <h2 id="hd_id81598540704978" xml-lang="en-US">The <variable id="ValueProperty"><literal>Value</literal> property</variable></h2> <table id="tab_id48159854325479"> <tablerow> @@ -799,7 +801,8 @@ </table> <h2 id="hd_id421612628828054" xml-lang="en-US">Event properties</h2> <paragraph role="paragraph" id="par_id41612629140856" xml-lang="en-US">The properties below return or set URI strings that define the script triggered by the event.</paragraph> - <table id="tab_id951612628879819"> + <section id="event_properties_toc"> + <table id="tab_id951612628879819"> <tablerow> <tablecell> <paragraph id="par_id961612628879819" role="tablehead" xml-lang="en-US">Name</paragraph> @@ -1042,21 +1045,30 @@ <paragraph id="par_id311616948721872" role="tablecontent" xml-lang="en-US">After updating</paragraph> </tablecell> </tablerow> - </table> + </table> + </section> <tip id="par_id961618181634181">To learn more about URI strings, refer to the <link href="https://wiki.documentfoundation.org/Documentation/DevGuide/Scripting_Framework#Scripting_Framework_URI_Specification">Scripting Framework URI Specification</link>.</tip> - <table id="tab_id891606472825856"> - <tablerow> - <tablecell colspan="2"><paragraph id="par_id891611613601554" role="tablehead" xml-lang="en-US">List of Methods in the FormControl Service</paragraph></tablecell> - </tablerow> + <section id="methods_toc"> + <table id="tab_id891606472825856"> + <tablerow> + <tablecell colspan="2"> + <paragraph id="par_id891611613601554" role="tablehead" xml-lang="en-US">List of Methods in the FormControl Service</paragraph> + </tablecell> + </tablerow> <tablerow> - <tablecell><paragraph id="par_id751612709117248" role="tablecontent" localize="false"> + <tablecell> + <paragraph id="par_id751612709117248" role="tablecontent" localize="false"> <link href="text/sbasic/shared/03/sf_formcontrol.xhp#Controls">Controls</link><br/> - </paragraph></tablecell> - <tablecell><paragraph id="par_id63161270911712" role="tablecontent" localize="false"> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id63161270911712" role="tablecontent" localize="false"> <link href="text/sbasic/shared/03/sf_formcontrol.xhp#SetFocus">SetFocus</link><br/> - </paragraph></tablecell> - </tablerow> - </table> + </paragraph> + </tablecell> + </tablerow> + </table> + </section> <section id="Controls"> <comment> Controls -------------------------------------------------------------------------------------------------------------------------- </comment> @@ -1170,4 +1182,4 @@ <embed href="text/sbasic/shared/03/sf_document.xhp#DocumentService"/> </section> </body> -</helpdocument> \ No newline at end of file +</helpdocument> diff --git a/source/text/sbasic/shared/03/sf_l10n.xhp b/source/text/sbasic/shared/03/sf_l10n.xhp index 5ae50229f6..317be9c8c0 100644 --- a/source/text/sbasic/shared/03/sf_l10n.xhp +++ b/source/text/sbasic/shared/03/sf_l10n.xhp @@ -120,8 +120,10 @@ <bookmark_value>L10N service;Languages</bookmark_value> <bookmark_value>L10N service;Locale</bookmark_value> </bookmark> -<h2 id="hd_id561585843652465" xml-lang="en-US">Properties</h2> - <table id="tab_id711585843652120"> + + <h2 id="hd_id561585843652465" xml-lang="en-US">Properties</h2> + <section id="properties_toc"> + <table id="tab_id711585843652120"> <tablerow> <tablecell> <paragraph id="par_id181585843652958" role="tablehead" xml-lang="en-US">Name</paragraph> @@ -179,14 +181,16 @@ </tablecell> </tablerow> </table> + </section> -<table id="tab_id551614360519973"> - <tablerow> + <section id="methods_toc"> + <table id="tab_id551614360519973"> + <tablerow> <tablecell colspan="3"> <paragraph id="par_id231614360519973" role="tablehead">List of Methods in the L10N Service</paragraph> </tablecell> - </tablerow> - <tablerow> + </tablerow> + <tablerow> <tablecell> <paragraph id="par_id611614360519255" role="tablecontent" localize="false"> <link href="text/sbasic/shared/03/sf_l10n.xhp#AddText">AddText</link><br/> @@ -203,9 +207,9 @@ <link href="text/sbasic/shared/03/sf_l10n.xhp#GetText">GetText</link><br/><br/> </paragraph> </tablecell> - </tablerow> -</table> - + </tablerow> + </table> + </section> <section id="AddText"> <comment> AddText ----------------------------------------------------------------------------------------------- </comment> @@ -239,7 +243,7 @@ <paragraph role="pycode" localize="false" id="pyc_id521625856443322">myPO.AddText(msgid = 'Provide a String value', comment = 'Do not translate the word String')</paragraph> </pycode> </section> - + <section id="AddTextsFromDialog"> <comment> AddTextsFromDialog ------------------------------------------------------------------------------------- </comment> <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id951585843650024"> diff --git a/source/text/sbasic/shared/03/sf_menu.xhp b/source/text/sbasic/shared/03/sf_menu.xhp index 629fd053a4..9cfcfe9e32 100644 --- a/source/text/sbasic/shared/03/sf_menu.xhp +++ b/source/text/sbasic/shared/03/sf_menu.xhp @@ -112,7 +112,8 @@ <bookmark_value>PopupService service;SubmenuCharacter</bookmark_value> </bookmark> <h2 id="hd_id711600788076834">Properties</h2> - <table id="tab_id701600788076583"> + <section id="properties_toc"> + <table id="tab_id701600788076583"> <tablerow> <tablecell> <paragraph id="par_id461600788076917" role="tablehead">Name</paragraph> @@ -155,7 +156,8 @@ <paragraph id="par_id441600788076826" role="tablecontent">Character or string that defines how menu items are nested. The default character is ">".</paragraph> </tablecell> </tablerow> - </table> + </table> + </section> <h2 id="hd_id181636719707892">Menu and Submenus</h2> <paragraph role="paragraph" id="par_id741636719725402">To create a menu with submenus, use the character defined in the <literal>SubmenuCharacter</literal> property while creating the menu entry to define where it will be placed. For instance, consider the following menu/submenu hierarchy.</paragraph> @@ -190,7 +192,8 @@ <embed href="text/sbasic/shared/03/sf_popupmenu.xhp#using_icons"/> <h2 id="hd_id501582887473754" xml-lang="en-US">Methods</h2> - <table id="tab_id501611613601554"> + <section id="methods_toc"> + <table id="tab_id501611613601554"> <tablerow> <tablecell colspan="3"><paragraph id="par_id891611613601554" role="tablehead" xml-lang="en-US">List of Methods in the Menu Service</paragraph></tablecell> </tablerow> @@ -211,7 +214,8 @@ </paragraph> </tablecell> </tablerow> - </table> + </table> + </section> <section id="AddCheckBox"> <comment> AddCheckBox ----------------------------------------------------------------------------------------- </comment> diff --git a/source/text/sbasic/shared/03/sf_platform.xhp b/source/text/sbasic/shared/03/sf_platform.xhp index 911dee0600..bbd38a4ca9 100644 --- a/source/text/sbasic/shared/03/sf_platform.xhp +++ b/source/text/sbasic/shared/03/sf_platform.xhp @@ -80,7 +80,8 @@ <bookmark_value>Platform service;SystemLocale</bookmark_value> </bookmark> <h2 id="hd_id711600788076834">Properties</h2> - <table id="tab_id701600788076583"> + <section id="properties_toc"> + <table id="tab_id701600788076583"> <tablerow> <tablecell> <paragraph id="par_id461600788076917" role="tablehead">Name</paragraph> @@ -380,7 +381,8 @@ <paragraph id="par_id831633021741336" role="tablecontent">Returns the locale of the operating system as a string in the format "la-CO" (language-COUNTRY). This is equivalent to the <literal>Locale</literal> property.</paragraph> </tablecell> </tablerow> - </table> + </table> + </section> <embed href="text/sbasic/shared/00000003.xhp#functexample"/> <paragraph role="paragraph" id="par_id311633022159446">The following examples in Basic and Python illustrate how to use the <literal>Fonts</literal> property to write the names of all available fonts to the current Calc sheet starting at cell "A1":</paragraph> <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> diff --git a/source/text/sbasic/shared/03/sf_popupmenu.xhp b/source/text/sbasic/shared/03/sf_popupmenu.xhp index 2f4ea51e0e..88cbbacd82 100644 --- a/source/text/sbasic/shared/03/sf_popupmenu.xhp +++ b/source/text/sbasic/shared/03/sf_popupmenu.xhp @@ -105,7 +105,8 @@ <bookmark_value>PopupService service;SubmenuCharacter</bookmark_value> </bookmark> <h2 id="hd_id711600788076834">Properties</h2> - <table id="tab_id701600788076583"> + <section id="properties_toc"> + <table id="tab_id701600788076583"> <tablerow> <tablecell> <paragraph id="par_id461600788076917" role="tablehead">Name</paragraph> @@ -148,7 +149,8 @@ <paragraph id="par_id441600788076826" role="tablecontent">Character or string that defines how menu items are nested. The default character is <literal>></literal>.</paragraph> </tablecell> </tablerow> - </table> + </table> + </section> <h2 id="hd_id181636719707892">Menu and Submenus</h2> <paragraph role="paragraph" id="par_id741636719725402">To create a popup menu with submenus, use the character defined in the <literal>SubmenuCharacter</literal> property while creating the menu entry to define where it will be placed. For instance, consider the following menu/submenu hierarchy.</paragraph> @@ -199,10 +201,13 @@ <note id="par_id691636725233961">All icon sets have the same internal structure. The actual icon displayed depends on the icon set currently in use.</note> </section> - <h2 id="hd_id501582887473754" xml-lang="en-US">Methods</h2> - <table id="tab_id501611613601554"> + <h2 id="hd_id501582887473754">Methods</h2> + <section id="methods_toc"> + <table id="tab_id501611613601554"> <tablerow> - <tablecell colspan="3"><paragraph id="par_id891611613601554" role="tablehead" xml-lang="en-US">List of Methods in the PopupMenu Service</paragraph></tablecell> + <tablecell colspan="3"> + <paragraph id="par_id891611613601554" role="tablehead" xml-lang="en-US">List of Methods in the PopupMenu Service</paragraph> + </tablecell> </tablerow> <tablerow> <tablecell> @@ -222,7 +227,8 @@ </paragraph> </tablecell> </tablerow> - </table> + </table> + </section> <section id="AddCheckBox"> <comment> AddCheckBox ----------------------------------------------------------------------------------------- </comment> diff --git a/source/text/sbasic/shared/03/sf_region.xhp b/source/text/sbasic/shared/03/sf_region.xhp index 7942ef1618..412fa4aeb2 100644 --- a/source/text/sbasic/shared/03/sf_region.xhp +++ b/source/text/sbasic/shared/03/sf_region.xhp @@ -88,8 +88,8 @@ <h2 id="hd_id711600788076834">Properties</h2> <paragraph role="paragraph" id="par_id601656018689690">All properties listed below accept a <literal>locale</literal> argument, provided as a string. Some properties require this argument to be in the format "la-CO", whereas others may receive "la" or "CO" as input.</paragraph> - - <table id="tab_id701600788076583"> + <section id="properties_toc"> + <table id="tab_id701600788076583"> <tablerow> <tablecell> <paragraph id="par_id461600788076917" role="tablehead">Name</paragraph> @@ -362,9 +362,11 @@ <paragraph id="par_id301600789141619" role="tablecontent">Returns the separator used to format times in the specified region.</paragraph> </tablecell> </tablerow> - </table> + </table> + </section> - <table id="tab_id901611086279902"> + <section id="methods_toc"> + <table id="tab_id901611086279902"> <tablerow> <tablecell colspan="3"><paragraph id="par_id651606319520519" role="tablehead">List of Methods in the Region Service</paragraph></tablecell> </tablerow> @@ -387,8 +389,9 @@ <link href="text/sbasic/shared/03/sf_region.xhp#UTCNow">UTCNow</link><br/> </paragraph> </tablecell> - </tablerow> - </table> + </tablerow> + </table> + </section> <section id="DSTOffset"> <comment> DSTOffset ---------------------------------------------------------------------------------------------- </comment> diff --git a/source/text/sbasic/shared/03/sf_session.xhp b/source/text/sbasic/shared/03/sf_session.xhp index f2505b1cb8..8b9715223e 100644 --- a/source/text/sbasic/shared/03/sf_session.xhp +++ b/source/text/sbasic/shared/03/sf_session.xhp @@ -52,7 +52,7 @@ </pycode> <h2 id="hd_id291582814720762" xml-lang="en-US">Constants</h2> <paragraph role="paragraph" id="par_id82158281472034" xml-lang="en-US">Below is a list of constants available to ease the designation of the library containing a Basic or Python script to invoke. Use them as <literal>session.CONSTANT</literal>.</paragraph> - <section id="constants"> + <section id="properties_toc"> <table id="tab_id291582814720160"> <tablerow> <tablecell> @@ -169,11 +169,14 @@ </table> </section> -<table id="tab_id501611613601554"> - <tablerow> - <tablecell colspan="3"><paragraph id="par_id891611613601554" role="tablehead" xml-lang="en-US">List of Methods in the Session Service</paragraph></tablecell> - </tablerow> - <tablerow> + <section id="methods_toc"> + <table id="tab_id501611613601554"> + <tablerow> + <tablecell colspan="3"> + <paragraph id="par_id891611613601554" role="tablehead" xml-lang="en-US">List of Methods in the Session Service</paragraph> + </tablecell> + </tablerow> + <tablerow> <tablecell> <paragraph id="par_id891611613601556" role="tablecontent" localize="false"> <link href="text/sbasic/shared/03/sf_session.xhp#ExecuteBasicScript">ExecuteBasicScript</link><br/> @@ -200,8 +203,9 @@ <link href="text/sbasic/shared/03/sf_session.xhp#WebService">WebService</link><br/><br/> </paragraph> </tablecell> - </tablerow> -</table> + </tablerow> + </table> + </section> <tip id="par_id491613061572993"><literal>Execute...</literal> methods in <literal>Session</literal> service behave as follows: <br/>Arguments are passed by value. Changes made by the called function to the arguments do not update their values in the calling script. @@ -311,7 +315,7 @@ <input>session.ExecutePythonScript(scope: str, script: str, args: any[0..*]): any</input> </paragraph> <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> - <paragraph role="paragraph" id="par_id791582818023246"><emph>scope</emph>: One of the applicable constants listed <link href="text/sbasic/shared/03/sf_session.xhp#constants">above</link>. The default value is <literal>session.SCRIPTISSHARED</literal>.</paragraph> + <paragraph role="paragraph" id="par_id791582818023246"><emph>scope</emph>: One of the applicable constants listed <link href="text/sbasic/shared/03/sf_session.xhp#properties_toc">above</link>. The default value is <literal>session.SCRIPTISSHARED</literal>.</paragraph> <paragraph role="paragraph" id="par_id71582818023247"><emph>script</emph>: Either "library/module.py$method" or "module.py$method" or "myExtension.oxt|myScript|module.py$method" as a case-sensitive string.</paragraph> <list type="unordered"> <listitem><paragraph id="par_id501613061041313" role="listitem">library: The folder path to the Python module.</paragraph></listitem> diff --git a/source/text/sbasic/shared/03/sf_string.xhp b/source/text/sbasic/shared/03/sf_string.xhp index 5ca181ee23..f5150f7a6d 100644 --- a/source/text/sbasic/shared/03/sf_string.xhp +++ b/source/text/sbasic/shared/03/sf_string.xhp @@ -196,7 +196,8 @@ <h2 id="hd_id651584978211886">Properties</h2> <paragraph role="paragraph" id="par_id241611950267068">The <literal>SF_String</literal> object provides the following properties for Basic scripts:</paragraph> - <table id="tab_id761584978211275"> + <section id="properties_toc"> + <table id="tab_id761584978211275"> <tablerow> <tablecell> <paragraph id="par_id271584978211792" role="tablehead">Name</paragraph> @@ -266,14 +267,18 @@ </tablecell> </tablerow> </table> + </section> <tip id="par_id461584978880380">You can use the properties above to identify or insert the corresponding characters inside strings. For example, the Linefeed can be replaced by <literal>SF_String.sfLF</literal>.</tip> -<table id="tab_id501611613601554"> - <tablerow> - <tablecell colspan="3"><paragraph id="par_id891611613601554" role="tablehead" xml-lang="en-US">List of Methods in the String Service</paragraph></tablecell> - </tablerow> - <tablerow> - <tablecell> + <section id="methods_toc"> + <table id="tab_id501611613601554"> + <tablerow> + <tablecell colspan="3"> + <paragraph id="par_id891611613601554" role="tablehead" xml-lang="en-US">List of Methods in the String Service</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> <paragraph id="par_id891611613601556" role="tablecontent" localize="false"> <link href="text/sbasic/shared/03/sf_string.xhp#Capitalize">Capitalize</link><br/> <link href="text/sbasic/shared/03/sf_string.xhp#Count">Count</link><br/> @@ -329,8 +334,9 @@ <link href="text/sbasic/shared/03/sf_string.xhp#Wrap">Wrap</link><br/><br/> </paragraph> </tablecell> - </tablerow> -</table> + </tablerow> + </table> + </section> <note id="par_id151611951803163">The first argument of most methods is the string to be considered. It is always passed by reference and left unchanged. Methods such as <literal>Capitalize</literal>, <literal>Escape</literal>, etc return a new string after their execution.</note> <warning id="par_id371627158142730">Because Python has comprehensive built-in string support, most of the methods in the <literal>String</literal> service are available for Basic scripts only. The methods available for Basic and Python are: <literal>HashStr</literal>, <literal>IsADate</literal>, <literal>IsEmail</literal>, <literal>IsFileName</literal>, <literal>IsIBAN</literal>, <literal>IsIPv4</literal>, <literal>IsLike</literal>, <literal>IsSheetName</literal>, <literal>IsUrl</literal>, <literal>SplitNotQuoted</literal> and <literal>Wrap</literal>.</warning> diff --git a/source/text/sbasic/shared/03/sf_textstream.xhp b/source/text/sbasic/shared/03/sf_textstream.xhp index 81282376c0..6a76fecd9f 100644 --- a/source/text/sbasic/shared/03/sf_textstream.xhp +++ b/source/text/sbasic/shared/03/sf_textstream.xhp @@ -70,7 +70,8 @@ <bookmark_value>TextStream service;Line</bookmark_value> <bookmark_value>TextStream service;NewLine</bookmark_value> </bookmark> - <table id="tab_id81585330787547"> + <section id="properties_toc"> + <table id="tab_id81585330787547"> <tablerow> <tablecell> <paragraph id="par_id631585330787267" role="tablehead">Name</paragraph> @@ -169,13 +170,17 @@ <paragraph id="par_id691585330787279" role="tablecontent">Sets or returns the current delimiter to be inserted between two successive written lines. The default value is the native line delimiter in the current operating system.</paragraph> </tablecell> </tablerow> - </table> + </table> + </section> <note id="par_id141613001281573">To learn more about the names of character sets, visit <link href="https://www.iana.org/assignments/character-sets/character-sets.xhtml">IANA's Character Set</link> page. Be aware that %PRODUCTNAME does not implement all existing character sets.</note> -<table id="tab_id501611613601554"> - <tablerow> - <tablecell colspan="3"><paragraph id="par_id891611613601554" role="tablehead">List of Methods in the TextStream Service</paragraph></tablecell> - </tablerow> - <tablerow> + <section id="methods_toc"> + <table id="tab_id501611613601554"> + <tablerow> + <tablecell colspan="3"> + <paragraph id="par_id891611613601554" role="tablehead">List of Methods in the TextStream Service</paragraph> + </tablecell> + </tablerow> + <tablerow> <tablecell> <paragraph id="par_id891611613601556" role="tablecontent" localize="false"> <link href="text/sbasic/shared/03/sf_textstream.xhp#CloseFile">CloseFile</link><br/> @@ -194,8 +199,9 @@ <link href="text/sbasic/shared/03/sf_textstream.xhp#WriteLine">WriteLine</link><br/> </paragraph> </tablecell> - </tablerow> -</table> + </tablerow> + </table> + </section> <section id="CloseFile"> <comment> CloseFile ------------------------------------------------------------------------------------------ </comment> diff --git a/source/text/sbasic/shared/03/sf_timer.xhp b/source/text/sbasic/shared/03/sf_timer.xhp index 5956c267ea..012b375a3e 100644 --- a/source/text/sbasic/shared/03/sf_timer.xhp +++ b/source/text/sbasic/shared/03/sf_timer.xhp @@ -69,7 +69,8 @@ </pycode> <h2 id="hd_id521582733781450" xml-lang="en-US">Properties</h2> - <table id="tab_id761582733781447"> + <section id="properties_toc"> + <table id="tab_id761582733781447"> <tablerow> <tablecell> <paragraph id="par_id71582733781260" role="tablehead" xml-lang="en-US">Name</paragraph> @@ -154,8 +155,9 @@ <paragraph id="par_id411582733781932" role="tablecontents" xml-lang="en-US" >The actual time elapsed since start or between start and stop (including suspensions and running time)</paragraph> </tablecell> </tablerow> - </table> - <paragraph role="tip" id="par_id9158273378151" xml-lang="en-US">Note that the <literal>TotalDuration</literal> property is equivalent to summing the <literal>Duration</literal> and <literal>SuspendDuration</literal> properties.</paragraph> + </table> + </section> + <paragraph role="tip" id="par_id9158273378151">Note that the <literal>TotalDuration</literal> property is equivalent to summing the <literal>Duration</literal> and <literal>SuspendDuration</literal> properties.</paragraph> <h2 id="hd_id141582734141895" xml-lang="en-US">Methods</h2> <paragraph role="paragraph" id="par_id291582734377752" xml-lang="en-US">All methods do not require arguments and return a <literal>Boolean</literal> value.</paragraph> @@ -167,6 +169,7 @@ <bookmark_value>Timer service;Suspend</bookmark_value> <bookmark_value>Timer service;Terminate</bookmark_value> </bookmark> + <section id="methods_toc"> <table id="tab_id231582734180676"> <tablerow> <tablecell> @@ -234,7 +237,8 @@ <paragraph id="par_id381582734996722" role="tablecontent" xml-lang="en-US"><literal>False</literal> if the timer is neither started nor suspended</paragraph> </tablecell> </tablerow> - </table> + </table> + </section> <embed href="text/sbasic/shared/00000003.xhp#functexample"/> <paragraph role="paragraph" id="par_id731626871820490">The examples below in Basic and Python illustrate the use of the methods and properties in the <literal>Timer</literal> service.</paragraph> diff --git a/source/text/sbasic/shared/03/sf_toc.xhp b/source/text/sbasic/shared/03/sf_toc.xhp new file mode 100644 index 0000000000..0b1bf21c78 --- /dev/null +++ b/source/text/sbasic/shared/03/sf_toc.xhp @@ -0,0 +1,1013 @@ +<?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_TableOfContents" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">List of all ScriptForge methods and properties</title> + <filename>/text/sbasic/shared/03/sf_toc.xhp</filename> + </topic> +</meta> + +<body> + <bookmark localize="false" branch="index" id="bm_id41582391760334"> + <bookmark_value>ScriptForge; list of methods</bookmark_value> + <bookmark_value>ScriptForge; list of properties</bookmark_value> + </bookmark> + <h1 id="hd_id461623364876507"><variable id="title"><link href="text/sbasic/shared/03/sf_toc.xhp">List of all <literal>ScriptForge</literal> methods and properties</link></variable></h1> + <paragraph role="paragraph" id="par_id691671192231981">This help page shows all methods and properties available in the <literal>ScriptForge</literal> library by service witl links to the corresponding documentation.</paragraph> + + <h2 id="hd_id101671192601663"><literal>ScriptForge</literal>.<literal>Array</literal> service</h2> + <embed href="text/sbasic/shared/03/sf_array.xhp#methods_toc"/> + <tip id="par_id401671192686859">The source code for the <literal>Array</literal> service is available in the <literal>SF_Array</literal> module of the <menuitem>Application Macros and Dialogs - ScriptForge</menuitem> library.</tip> + + <h2 id="hd_id101671192601553"><literal>SFDocuments</literal>.<literal>Base</literal> service</h2> + <embed href="text/sbasic/shared/03/sf_base.xhp#methods_toc"/> + <tip id="par_id401671192686811">The source code for the <literal>Base</literal> service is available in the <literal>SF_Base</literal> module of the <menuitem>Application Macros and Dialogs - SFDocuments</menuitem> library.</tip> + + <h2 id="hd_id101671192609363"><literal>ScriptForge</literal>.<literal>Basic</literal> service</h2> + <embed href="text/sbasic/shared/03/sf_basic.xhp#methods_toc"/> + <section id="SF_Basic_properties"> + <table id="tab_id901611086279902"> + <tablerow> + <tablecell colspan="3"> + <paragraph id="par_id651606319520519" role="tablehead">List of Properties in the Basic Service</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id761611086279772" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_basic.xhp#properties_toc">IDABORT</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#properties_toc">IDCANCEL</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#properties_toc">IDIGNORE</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#properties_toc">IDNO</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#properties_toc">IDOK</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#properties_toc">IDRETRY</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#properties_toc">IDYES</link> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id141611086279222" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_basic.xhp#properties_toc">MB_ABORTRETRYIGNORE</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#properties_toc">MB_DEFBUTTON1</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#properties_toc">MB_DEFBUTTON2</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#properties_toc">MB_DEFBUTTON3</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#properties_toc">MB_ICONEXCLAMATION</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#properties_toc">MB_ICONINFORMATION</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#properties_toc">MB_ICONQUESTION</link> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761611086279676" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_basic.xhp#properties_toc">MB_ICONSTOP</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#properties_toc">MB_OK</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#properties_toc">MB_OKCANCEL</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#properties_toc">MB_RETRYCANCEL</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#properties_toc">MB_YESNO</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#properties_toc">MB_YESNOCANCEL</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#properties_toc">StarDesktop</link> + </paragraph> + </tablecell> + </tablerow> + </table> + </section> + <tip id="par_id401671192686397">The <literal>Basic</literal> service is available only in Python and its source code is available in the <emph>program\scriptforge.py</emph> file under %PRODUCTNAME instalation directory.</tip> + + <h2 id="hd_id101671192601502"><literal>SFDocuments</literal>.<literal>Calc</literal> service</h2> + <embed href="text/sbasic/shared/03/sf_calc.xhp#methods_toc"/> + <section id="SF_Calc_properties"> + <table id="tab_id901611086279882"> + <tablerow> + <tablecell colspan="3"> + <paragraph id="par_id651606319520654" role="tablehead">List of Properties in the Calc Service</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id761611086279902" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_calc.xhp#properties_toc">CurrentSelection</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#properties_toc">FirstCell</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#properties_toc">FirstColumn</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#properties_toc">FirstRow</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#properties_toc">Height</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#properties_toc">LastCell</link> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id141611086279902" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_calc.xhp#properties_toc">LastColumn</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#properties_toc">LastRow</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#properties_toc">Range</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#properties_toc">Region</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#properties_toc">Sheet</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#properties_toc">SheetName</link> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761611086279903" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_calc.xhp#properties_toc">Sheets</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#properties_toc">Width</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#properties_toc">XCellRange</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#properties_toc">XSheetCellCursor</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#properties_toc">XSpreadsheet</link><br/><br/> + </paragraph> + </tablecell> + </tablerow> + </table> + </section> + <tip id="par_id401671192687641">The source code for the <literal>Calc</literal> service is available in the <literal>SF_Calc</literal> module of the <menuitem>Application Macros and Dialogs - SFDocuments</menuitem> library.</tip> + + <h2 id="hd_id101671192601677"><literal>SFDocuments</literal>.<literal>Chart</literal> service</h2> + <embed href="text/sbasic/shared/03/sf_chart.xhp#methods_toc"/> + <section id="SF_Chart_properties"> + <table id="tab_id901611086279719"> + <tablerow> + <tablecell colspan="3"> + <paragraph id="par_id651606319523634" role="tablehead">List of Properties in the Chart Service</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id761611086277362" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_chart.xhp#properties_toc">ChartType</link><br/> + <link href="text/sbasic/shared/03/sf_chart.xhp#properties_toc">Deep</link><br/> + <link href="text/sbasic/shared/03/sf_chart.xhp#properties_toc">Dim3D</link><br/> + <link href="text/sbasic/shared/03/sf_chart.xhp#properties_toc">Exploded</link><br/> + <link href="text/sbasic/shared/03/sf_chart.xhp#properties_toc">Filled</link> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id141611086278835" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_chart.xhp#properties_toc">Legend</link><br/> + <link href="text/sbasic/shared/03/sf_chart.xhp#properties_toc">Percent</link><br/> + <link href="text/sbasic/shared/03/sf_chart.xhp#properties_toc">Stacked</link><br/> + <link href="text/sbasic/shared/03/sf_chart.xhp#properties_toc">Title</link><br/> + <link href="text/sbasic/shared/03/sf_chart.xhp#properties_toc">XTitle</link> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761611086279506" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_chart.xhp#properties_toc">YTitle</link><br/> + <link href="text/sbasic/shared/03/sf_chart.xhp#properties_toc">XChartObj</link><br/> + <link href="text/sbasic/shared/03/sf_chart.xhp#properties_toc">XDiagram</link><br/> + <link href="text/sbasic/shared/03/sf_chart.xhp#properties_toc">XShape</link><br/> + <link href="text/sbasic/shared/03/sf_chart.xhp#properties_toc">XTableChart</link> + </paragraph> + </tablecell> + </tablerow> + </table> + </section> + <tip id="par_id401671192687759">The source code for the <literal>Chart</literal> service is available in the <literal>SF_Chart</literal> module of the <menuitem>Application Macros and Dialogs - SFDocuments</menuitem> library.</tip> + + <h2 id="hd_id101671192601147"><literal>SFDatabases</literal>.<literal>Database</literal> service</h2> + <embed href="text/sbasic/shared/03/sf_database.xhp#methods_toc"/> + <section id="SF_Database_properties"> + <table id="tab_id901611086279904"> + <tablerow> + <tablecell colspan="3"> + <paragraph id="par_id651606319520332" role="tablehead">List of Properties in the Database Service</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id761611086279662" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_database.xhp#properties_toc">Queries</link><br/> + <link href="text/sbasic/shared/03/sf_database.xhp#properties_toc">Tables</link> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id141611086277032" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_database.xhp#properties_toc">XConnection</link><br/><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761611086278818" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_database.xhp#properties_toc">XMetaData</link><br/><br/> + </paragraph> + </tablecell> + </tablerow> + </table> + </section> + <tip id="par_id40167119268715">The source code for the <literal>Database</literal> service is available in the <literal>SF_Database</literal> module of the <menuitem>Application Macros and Dialogs - SFDatabases</menuitem> library.</tip> + + <h2 id="hd_id101671192690807"><literal>SFDatabases</literal>.<literal>Datasheet</literal> service</h2> + <embed href="text/sbasic/shared/03/sf_datasheet.xhp#methods_toc"/> + <section id="SF_Datasheet_properties"> + <table id="tab_id901611086275022"> + <tablerow> + <tablecell colspan="3"> + <paragraph id="par_id651606319510928" role="tablehead">List of Properties in the Datasheet Service</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id761611086273372" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_datasheet.xhp#properties_toc">ColumnHeaders</link><br/> + <link href="text/sbasic/shared/03/sf_datasheet.xhp#properties_toc">CurrentColumn</link><br/> + <link href="text/sbasic/shared/03/sf_datasheet.xhp#properties_toc">CurrentRow</link><br/> + <link href="text/sbasic/shared/03/sf_datasheet.xhp#properties_toc">DatabaseFileName</link><br/> + <link href="text/sbasic/shared/03/sf_datasheet.xhp#properties_toc">Filter</link> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id14161108688384" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_datasheet.xhp#properties_toc">LastRow</link><br/> + <link href="text/sbasic/shared/03/sf_datasheet.xhp#properties_toc">OrderBy</link><br/> + <link href="text/sbasic/shared/03/sf_datasheet.xhp#properties_toc">ParentDatabase</link><br/> + <link href="text/sbasic/shared/03/sf_datasheet.xhp#properties_toc">Source</link><br/><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761611086270413" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_datasheet.xhp#properties_toc">SourceType</link><br/> + <link href="text/sbasic/shared/03/sf_datasheet.xhp#properties_toc">XComponent</link><br/> + <link href="text/sbasic/shared/03/sf_datasheet.xhp#properties_toc">XControlModel</link><br/> + <link href="text/sbasic/shared/03/sf_datasheet.xhp#properties_toc">XTabControllerModel</link><br/><br/> + </paragraph> + </tablecell> + </tablerow> + </table> + </section> + <tip id="par_id40167119268664">The source code for the <literal>Datasheet</literal> service is available in the <literal>SF_Datasheet</literal> module of the <menuitem>Application Macros and Dialogs - SFDatabases</menuitem> library.</tip> + + <h2 id="hd_id101671192601308"><literal>SFDialogs</literal>.<literal>Dialog</literal> service</h2> + <embed href="text/sbasic/shared/03/sf_dialog.xhp#methods_toc"/> + <section id="SF_Dialog_properties"> + <table id="tab_id901611086279544"> + <tablerow> + <tablecell colspan="3"> + <paragraph id="par_id651606319527165" role="tablehead">List of Properties in the Dialog Service</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id761611086279039" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_dialog.xhp#properties_toc">CANCELBUTTON</link><br/> + <link href="text/sbasic/shared/03/sf_dialog.xhp#properties_toc">Caption</link><br/> + <link href="text/sbasic/shared/03/sf_dialog.xhp#properties_toc">Height</link><br/> + <link href="text/sbasic/shared/03/sf_dialog.xhp#properties_toc">Modal</link><br/> + <link href="text/sbasic/shared/03/sf_dialog.xhp#properties_toc">Name</link><br/> + <link href="text/sbasic/shared/03/sf_dialog.xhp#properties_toc">OKBUTTON</link><br/> + <link href="text/sbasic/shared/03/sf_dialog.xhp#properties_toc">OnFocusGained</link><br/> + <link href="text/sbasic/shared/03/sf_dialog.xhp#properties_toc">OnFocusLost</link><br/> + <link href="text/sbasic/shared/03/sf_dialog.xhp#properties_toc">OnKeyPressed</link> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id141611086279065" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_dialog.xhp#properties_toc">OnKeyReleased</link><br/> + <link href="text/sbasic/shared/03/sf_dialog.xhp#properties_toc">OnMouseDragged</link><br/> + <link href="text/sbasic/shared/03/sf_dialog.xhp#properties_toc">OnMouseEntered</link><br/> + <link href="text/sbasic/shared/03/sf_dialog.xhp#properties_toc">OnMouseExited</link><br/> + <link href="text/sbasic/shared/03/sf_dialog.xhp#properties_toc">OnMouseMoved</link><br/> + <link href="text/sbasic/shared/03/sf_dialog.xhp#properties_toc">OnMousePressed</link><br/> ... etc. - the rest is truncated