From bd899b607eed60487a75905a398b751cf5332352 Mon Sep 17 00:00:00 2001 From: Rafael Lima Date: Fri, 16 Dec 2022 15:00:21 +0000 Subject: 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 --- 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 +- 27 files changed, 1396 insertions(+), 233 deletions(-) create mode 100644 source/text/sbasic/shared/03/sf_toc.xhp (limited to 'source/text/sbasic') 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 @@ arr = svc.Append(arr, 4) Because Python has built-in list and tuple support, most of the methods in the Array service are available for Basic scripts only. The only exception is ImportFromCSVFile which is supported in both Basic and Python. +
- List of Methods in the Array Service + + List of Methods in the Array Service + - - Append
- AppendColumn
- AppendRow
- Contains
- ConvertToDictionary
- Copy
- CountDims
- Difference
- ExportToTextFile
- ExtractColumn
- ExtractRow
- - - Flatten
- ImportFromCSVFile
- IndexOf
- Insert
- InsertSorted
- Intersection
- Join2D
- Prepend
- PrependColumn
- PrependRow
- RangeInit
- - + + + Append
+ AppendColumn
+ AppendRow
+ Contains
+ ConvertToDictionary
+ Copy
+ CountDims
+ Difference
+ ExportToTextFile
+ ExtractColumn
+ ExtractRow
+ + + + + Flatten
+ ImportFromCSVFile
+ IndexOf
+ Insert
+ InsertSorted
+ Intersection
+ Join2D
+ Prepend
+ PrependColumn
+ PrependRow
+ RangeInit
+ + + + Reverse
Shuffle
Slice
@@ -92,9 +100,11 @@ TrimArray
Union
Unique

- + +
+
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.
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 @@ The use of the "SFDocuments." substring in the previous example is optional. - +
+
List of Methods in the Base Service @@ -106,7 +107,8 @@ -
+ +
CloseFormDocument ------------------------------------------------------------------------------------- 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 @@ bas = CreateScriptService("Basic")

Properties

+
Name @@ -115,9 +116,13 @@
+
+
- List of Methods in the Basic Service + + List of Methods in the Basic Service + @@ -159,6 +164,7 @@
+
CDate ------------------------------------------------------------------------- @@ -300,7 +306,7 @@ unostructure: A fully qualified structure name such as com.sun.star.beans.Property or com.sun.star.util.DateTime. - date_struct = bas.CreateUnoStruct('com.sun.star.util.DateTime') + date_struct = CreateUnoStruct('com.sun.star.util.DateTime')
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 @@

Properties

All the properties generic to any document are implicitly applicable also to Calc documents. For more information, read the Document service Help page. The properties specifically available for Calc documents are: - +
+
Name @@ -526,14 +527,18 @@ A com.sun.star.sheet.XSpreadsheet UNO object. -
+ +
Visit %PRODUCTNAME API Documentation's website to learn more about XCellRange, XSheetCellCursor and XSpreadsheet UNO objects.

Methods

+
- List of Methods in the Calc Service + + List of Methods in the Calc Service + @@ -593,7 +598,8 @@ -
+ +
A1Style ----------------------------------------------------------------------------------------------- @@ -788,7 +794,7 @@ myDoc.ClearFormats("SheetX.*") - Refer to the ClearAll method documentation available above for examples on how to use the arguments filterformula and filterscope. + Refer to the ClearAll method documentation for examples on how to use the arguments filterformula and filterscope.
@@ -815,7 +821,7 @@ myDoc.ClearValues("SheetX.A1:F10") - Refer to the ClearAll method documentation available above for examples on how to use the arguments filterformula and filterscope. + Refer to the ClearAllliteral> method documentation for examples on how to use the arguments filterformula and filterscope.
@@ -1800,7 +1806,7 @@ myDoc.SetCellStyle("A1:J1", "Heading 1") myDoc.SetCellStyle("A2:J100", "Neutral") - Refer to the ClearAll method documentation available above for examples on how to use the arguments filterformula and filterscope. + Refer to the ClearAll method documentation for examples on how to use the arguments filterformula and filterscope.
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 @@ Chart service;XTableChart

Properties

+
@@ -327,6 +328,7 @@
+

Creating a chart

Consider the following data in the range "A1:B6" of a sheet named "Report". @@ -418,9 +420,12 @@ 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 CreateChart method.

Methods

+
- List of Methods in the Chart Service + + List of Methods in the Chart Service + @@ -435,6 +440,7 @@
+
ExportToFile ----------------------------------------------------------------------------------------- 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 @@ Database Service;Tables

Properties

+
@@ -179,8 +180,10 @@
+
- +
+
List of Methods in the Database Service @@ -212,7 +215,8 @@ -
+ +
CloseDatabase ---------------------------------------------------------------------------------- @@ -450,7 +454,7 @@ Database Service;RunSql

RunSql

- Executes an action query or an SQL statement such as creating a table, as well as inserting, updating and deleting records. + Executes an action query of an SQL statement such as creating a table, as well as inserting, updating and deleting records. The method returns True when successful. The RunSql method is rejected with an error message in case the database was previously opened in read-only mode. 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 @@ Datasheet service

SFDatabases.Datasheet service

- The Datasheet 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: + The Datasheet service allows to visualize the contents of database tables using Base's Data View. Additionally, this service allows to: Add custom menus to the data view. @@ -41,7 +41,7 @@ The Datasheet service can be invoked in two different ways depending on whether the database file is open. - The example below considers that the database file is open, hence the UI service can be used to retrieve the document and the OpenTable method from the Database service is used to get a Datasheet service instance. + The example below considers that the database file is open, hence the UI service can be used to retireve the document and the OpenTable method from the Database service is used to get a Datasheet service instance. Dim ui As Object, oBase As Object, oSheet As Object Set ui = CreateScriptService("UI") @@ -51,7 +51,7 @@ Set oSheet = oBase.OpenTable("Customers") In the example above it is also possible to use the method OpenQuery from the Base service to get a Datasheet instance. - To invoke the Datasheet service when the database file is not open, use the OpenTable, OpenQuery or OpenSql methods from the Database service. The example below uses the OpenTable method to open an existing table in the database file: + To invoke the Datasheet service when the database file is not open, use the OpenTable method of the Database service as illustrated next: Dim oDatabase As Object, oSheet As Object ' Object oDatabase is an instance of the Database service @@ -72,9 +72,10 @@ sheet = database.OpenTable("Customers") -

Properties

+

Properties

The following properties are available in the Datasheet service: - +
+
Name @@ -271,10 +272,12 @@ Returns the com.sun.star.awt.XTabControllerModel UNO object that represents the datasheet. -
+ +

Methods

- +
+
List of Methods in the Datasheet Service @@ -301,7 +304,8 @@ -
+ +
Activate -------------------------------------------------------------------------------------------- @@ -394,10 +398,10 @@ This method does not change the position of the cursor in the data view window. - svc.GetText(column: any): str + svc.GetText(opt column: any): str - column: 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. + column: 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. @@ -416,16 +420,16 @@

GetValue

Returns the value in a given column of the current row as a valid Basic type. - The types that can be returned are: String, Integer, Long, Single, Double, Date and Null. - Binary types are returned as a Long value indicating the length of the binary field. + The types that can be returned are: String, Integer, Long, Double, Date and Null. + Binary types are returned as a Long value. An Empty value is returned if the required value could not be retrieved. This method does not change the position of the cursor in the data view window. - svc.GetValue(column: any): any + svc.GetValue(opt column: any): any - column: 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. + column: 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. @@ -461,16 +465,16 @@ oSheet.GoToCell(Column := 3) ' Moves cursor one row down leaving it in the same column oSheet.GoToCell(Row := oSheet.CurrentRow + 1) - ' Moves to the last column of the last row - Dim LastColumn As Integer : LastColumn = UBound(oSheet.ColumnHeaders) + 1 - oSheet.GoToCell(oSheet.LastRow, LastColumn) + ' Moves to the first column of the last row + Dim LastRow As Integer : LastRow = UBound(oSheet.ColumnHeaders) + 1 + oSheet.GoToCell(LastRow, 1) sheet.GoToCell(4, "LastName") sheet.GoToCell(column=3) sheet.GoToCell(row=sheet.CurrentRow + 1) - sheet.GoToCell(sheet.LastRow, len(sheet.ColumnHeaders)) + sheet.GoToCell(len(sheet.ColumnHeaders), 1)
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 @@

Properties

- +
+
Name @@ -406,31 +407,40 @@ Mouse button released -
- +
+ +
+ - - Methods - + + List of Methods in the Dialog Service + - + + Activate
Center
Controls
- - + + + + EndExecute
Execute
GetTextsFromL10N
- - - Resize
- SetPageManager
- Terminate
- + + + + + Resize
+ SetPageManager
+ Terminate
+ + -
+ +
Activate -------------------------------------------------------------------------------------------------------------------------- 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 @@

Properties

- +
+
Name @@ -607,8 +608,9 @@ The UNO object representing the tree control data model. Refer to XMutableTreeDataModel in Application Programming Interface (API) documentation for detailed information. -
- + +
+

The Value property

@@ -984,29 +986,38 @@
- -

Methods

- - + +

Methods

+
+
- List of Methods in the DialogControl Service + + List of Methods in the DialogControl Service + - - - AddSubNode
- AddSubTree
- CreateRoot
- - - FindNode
- SetFocus

- - - SetTableData
- WriteLine

- + + + + AddSubNode
+ AddSubTree
+ CreateRoot
+ + + + + FindNode
+ SetFocus

+ + + + + SetTableData
+ WriteLine

+ + -
+ +
AddSubNode -------------------------------------------------------------------------------------------- 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 @@ Because Python has built-in dictionary support, most of the methods in the Dictionary service are available for Basic scripts only. Exceptions are ConvertToPropertyValues and ImportFromPropertyValues that are supported in both Basic and Python.

Properties

+
@@ -128,6 +129,7 @@
+
The Keys and Items properties return their respective contents, using an identical ordering. The order is unrelated to the creation sequence. @@ -141,33 +143,41 @@ Next b +
- - Methods - + + List of Methods in the Dictionary Service + - + + Add
ConvertToArray
ConvertToJson
ConvertToPropertyValues - - + + + + Exists
ImportFromJson
ImportFromPropertyValues
Item - - + + + + Remove
RemoveAll
ReplaceItem
ReplaceKey - + +
+
Add ---------------------------------------------------------------------------------------------------- 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 @@ API;ODatabaseDocument

Properties

+
@@ -295,8 +296,9 @@ The UNO object com.sun.star.lang.XComponent or com.sun.star.comp.dba.ODatabaseDocument representing the document - -
+ + +
@@ -325,6 +327,7 @@ doc.CloseDocument() +
List of Methods in the Document Service @@ -355,6 +358,7 @@
+
Activate -------------------------------------------------------------------- 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 @@

Properties

The properties listed below are only available for Basic scripts. - +
+
Name @@ -122,11 +123,13 @@ Default value is 0 or the code line number for a standard Basic run-time error. -
- Raising or clearing an Exception resets its properties. + +
+ Raising or clearing an Exception resets its properties. - +
+
List of Methods in the Exception Service @@ -135,26 +138,27 @@ Clear
Console
- ConsoleClear + ConsoleClear
+ ConsoleToFile - ConsoleToFile
DebugDisplay
- DebugPrint

+ DebugPrint
+ PythonPrint

 - PythonPrint
PythonShell
Raise
- RaiseWarning
+ RaiseWarning

 -
+ +
Clear -------------------------------------------------------------------------------------------------------------------------- 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 @@

File Naming Notation

The notation used to express file and folder names, both for arguments and returned values, is defined by the FileNaming property of the FileSystem service. - In short, the possible representation types are "URL" (URL file notation), "SYS" (operating system notation) and "ANY" (default). See more information below. + In short, the possible representation types are "URL" (URL file notation), "SYS" (operating system notation) and "ANY" (default). See more information below. An example of the URL notation is file:///C:/Documents/my_file.odt. Whenever possible consider using the URL notation because it is a more portable alternative. 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 "~/Documents/my_file.odt" use the full path "/home/user/Documents/my_file.odt". @@ -138,7 +138,7 @@ FileSystem service;UserTemplatesFolder property

Properties

-
+
@@ -278,14 +278,15 @@ Returns the folder containing the user-defined template files. -
+
- - - List of Methods in the FileSystem Service - - +
+
+ + List of Methods in the FileSystem Service + + BuildPath
@@ -325,8 +326,9 @@ SubFolders
 - -
+ + +
BuildPath ----------------------------------------------------------------------------------- @@ -825,7 +827,7 @@ svc.GetName(filename: str): str - + filename: A string representing the file name and its path. 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 @@ This operation is done implicitly when a form document is closed with the CloseFormDocument() method described below.

Properties

+
@@ -367,10 +368,12 @@ The UNO object representing interactions with the form. Refer to XForm and DataForm in the API documentation for detailed information. -
+ +

Event properties

The properties below return or set URI strings that define the script triggered by the event. - +
+
Name @@ -547,11 +550,15 @@ Before unloading -
+ +
To learn more about URI strings, refer to the Scripting Framework URI Specification. - - - List of methods in the Form service +
+
+ + + List of methods in the Form service + @@ -572,7 +579,8 @@ SubForms

 -
+ +
Activate -------------------------------------------------------------------------------------------------------------------------- @@ -838,4 +846,4 @@
- \ No newline at end of file + 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 @@

Properties

- +
+
Name @@ -606,7 +607,8 @@ The UNO object representing the control view. Refer to XControl and UnoControl in the API documentation for more information. -
+ +

The Value property

@@ -799,7 +801,8 @@

Event properties

The properties below return or set URI strings that define the script triggered by the event. - +
+
Name @@ -1042,21 +1045,30 @@ After updating -
+ + To learn more about URI strings, refer to the Scripting Framework URI Specification. - - - List of Methods in the FormControl Service - +
+
+ + + List of Methods in the FormControl Service + + - + + Controls
- - + + + + SetFocus
- - -
+ + + + +
Controls -------------------------------------------------------------------------------------------------------------------------- @@ -1170,4 +1182,4 @@
- \ No newline at end of file + 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 @@ L10N service;Languages L10N service;Locale -

Properties

- + +

Properties

+
+
Name @@ -179,14 +181,16 @@
+ - - +
+
+ List of Methods in the L10N Service - - + + AddText
@@ -203,9 +207,9 @@ GetText

 - -
- + + +
AddText ----------------------------------------------------------------------------------------------- @@ -239,7 +243,7 @@ myPO.AddText(msgid = 'Provide a String value', comment = 'Do not translate the word String')
- +
AddTextsFromDialog ------------------------------------------------------------------------------------- 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 @@ PopupService service;SubmenuCharacter

Properties

- +
+
Name @@ -155,7 +156,8 @@ Character or string that defines how menu items are nested. The default character is ">". -
+ +

Menu and Submenus

To create a menu with submenus, use the character defined in the SubmenuCharacter property while creating the menu entry to define where it will be placed. For instance, consider the following menu/submenu hierarchy. @@ -190,7 +192,8 @@

Methods

- +
+
List of Methods in the Menu Service @@ -211,7 +214,8 @@ -
+ +
AddCheckBox ----------------------------------------------------------------------------------------- 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 @@ Platform service;SystemLocale

Properties

- +
+
Name @@ -380,7 +381,8 @@ Returns the locale of the operating system as a string in the format "la-CO" (language-COUNTRY). This is equivalent to the Locale property. -
+ +
The following examples in Basic and Python illustrate how to use the Fonts property to write the names of all available fonts to the current Calc sheet starting at cell "A1": 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 @@ PopupService service;SubmenuCharacter

Properties

- +
+
Name @@ -148,7 +149,8 @@ Character or string that defines how menu items are nested. The default character is >. -
+ +

Menu and Submenus

To create a popup menu with submenus, use the character defined in the SubmenuCharacter property while creating the menu entry to define where it will be placed. For instance, consider the following menu/submenu hierarchy. @@ -199,10 +201,13 @@ All icon sets have the same internal structure. The actual icon displayed depends on the icon set currently in use. -

Methods

- +

Methods

+
+
- List of Methods in the PopupMenu Service + + List of Methods in the PopupMenu Service + @@ -222,7 +227,8 @@ -
+ +
AddCheckBox ----------------------------------------------------------------------------------------- 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 @@

Properties

All properties listed below accept a locale 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. - - +
+
Name @@ -362,9 +362,11 @@ Returns the separator used to format times in the specified region. -
+ +
- +
+
List of Methods in the Region Service @@ -387,8 +389,9 @@ UTCNow
- -
+ + +
DSTOffset ---------------------------------------------------------------------------------------------- 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 @@

Constants

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 session.CONSTANT. -
+
@@ -169,11 +169,14 @@
- - - List of Methods in the Session Service - - +
+
+ + + List of Methods in the Session Service + + + ExecuteBasicScript
@@ -200,8 +203,9 @@ WebService

 - -
+ + +
Execute... methods in Session service behave as follows:
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 @@ session.ExecutePythonScript(scope: str, script: str, args: any[0..*]): any - scope: One of the applicable constants listed above. The default value is session.SCRIPTISSHARED. + scope: One of the applicable constants listed above. The default value is session.SCRIPTISSHARED. script: Either "library/module.py$method" or "module.py$method" or "myExtension.oxt|myScript|module.py$method" as a case-sensitive string. library: The folder path to the Python module. 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 @@

Properties

The SF_String object provides the following properties for Basic scripts: - +
+
Name @@ -266,14 +267,18 @@
+
You can use the properties above to identify or insert the corresponding characters inside strings. For example, the Linefeed can be replaced by SF_String.sfLF. - - - List of Methods in the String Service - - - +
+
+ + + List of Methods in the String Service + + + + Capitalize
Count
@@ -329,8 +334,9 @@ Wrap

 - -
+ + + The first argument of most methods is the string to be considered. It is always passed by reference and left unchanged. Methods such as Capitalize, Escape, etc return a new string after their execution. Because Python has comprehensive built-in string support, most of the methods in the String service are available for Basic scripts only. The methods available for Basic and Python are: HashStr, IsADate, IsEmail, IsFileName, IsIBAN, IsIPv4, IsLike, IsSheetName, IsUrl, SplitNotQuoted and Wrap. 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 @@ TextStream service;Line TextStream service;NewLine - +
+
Name @@ -169,13 +170,17 @@ 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. -
+ + To learn more about the names of character sets, visit IANA's Character Set page. Be aware that %PRODUCTNAME does not implement all existing character sets. - - - List of Methods in the TextStream Service - - +
+
+ + + List of Methods in the TextStream Service + + + CloseFile
@@ -194,8 +199,9 @@ WriteLine
 - -
+ + +
CloseFile ------------------------------------------------------------------------------------------ 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 @@

Properties

- +
+
Name @@ -154,8 +155,9 @@ The actual time elapsed since start or between start and stop (including suspensions and running time) -
- Note that the TotalDuration property is equivalent to summing the Duration and SuspendDuration properties. + +
+ Note that the TotalDuration property is equivalent to summing the Duration and SuspendDuration properties.

Methods

All methods do not require arguments and return a Boolean value. @@ -167,6 +169,7 @@ Timer service;Suspend Timer service;Terminate +
@@ -234,7 +237,8 @@ False if the timer is neither started nor suspended -
+ +
The examples below in Basic and Python illustrate the use of the methods and properties in the Timer service. 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 @@ + + + + + + + List of all ScriptForge methods and properties + /text/sbasic/shared/03/sf_toc.xhp + + + + + + ScriptForge; list of methods + ScriptForge; list of properties + +

List of all ScriptForge methods and properties

+ This help page shows all methods and properties available in the ScriptForge library by service witl links to the corresponding documentation. + +

ScriptForge.Array service

+ + The source code for the Array service is available in the SF_Array module of the Application Macros and Dialogs - ScriptForge library. + +

SFDocuments.Base service

+ + The source code for the Base service is available in the SF_Base module of the Application Macros and Dialogs - SFDocuments library. + +

ScriptForge.Basic service

+ +
+ + + + List of Properties in the Basic Service + + + + + + IDABORT
+ IDCANCEL
+ IDIGNORE
+ IDNO
+ IDOK
+ IDRETRY
+ IDYES + + + + + MB_ABORTRETRYIGNORE
+ MB_DEFBUTTON1
+ MB_DEFBUTTON2
+ MB_DEFBUTTON3
+ MB_ICONEXCLAMATION
+ MB_ICONINFORMATION
+ MB_ICONQUESTION + + + + + MB_ICONSTOP
+ MB_OK
+ MB_OKCANCEL
+ MB_RETRYCANCEL
+ MB_YESNO
+ MB_YESNOCANCEL
+ StarDesktop + + + +
+
+ The Basic service is available only in Python and its source code is available in the program\scriptforge.py file under %PRODUCTNAME instalation directory. + +

SFDocuments.Calc service

+ +
+ + + + List of Properties in the Calc Service + + + + + + CurrentSelection
+ FirstCell
+ FirstColumn
+ FirstRow
+ Height
+ LastCell + + + + + LastColumn
+ LastRow
+ Range
+ Region
+ Sheet
+ SheetName + + + + + Sheets
+ Width
+ XCellRange
+ XSheetCellCursor
+ XSpreadsheet

+ + + +
+
+ The source code for the Calc service is available in the SF_Calc module of the Application Macros and Dialogs - SFDocuments library. + +

SFDocuments.Chart service

+ +
+ + + + List of Properties in the Chart Service + + + + + + ChartType
+ Deep
+ Dim3D
+ Exploded
+ Filled + + + + + Legend
+ Percent
+ Stacked
+ Title
+ XTitle + + + + + YTitle
+ XChartObj
+ XDiagram
+ XShape
+ XTableChart + + + +
+
+ The source code for the Chart service is available in the SF_Chart module of the Application Macros and Dialogs - SFDocuments library. + +

SFDatabases.Database service

+ +
+ + + + List of Properties in the Database Service + + + + + + Queries
+ Tables + + + + + XConnection

+ + + + + XMetaData

+ + + +
+
+ The source code for the Database service is available in the SF_Database module of the Application Macros and Dialogs - SFDatabases library. + +

SFDatabases.Datasheet service

+ +
+ + + + List of Properties in the Datasheet Service + + + + + + ColumnHeaders
+ CurrentColumn
+ CurrentRow
+ DatabaseFileName
+ Filter + + + + + LastRow
+ OrderBy
+ ParentDatabase
+ Source

+ + + + + SourceType
+ XComponent
+ XControlModel
+ XTabControllerModel

+ + + +
+
+ The source code for the Datasheet service is available in the SF_Datasheet module of the Application Macros and Dialogs - SFDatabases library. + +

SFDialogs.Dialog service

+ +
+ + + + List of Properties in the Dialog Service + + + + + + CANCELBUTTON
+ Caption
+ Height
+ Modal
+ Name
+ OKBUTTON
+ OnFocusGained
+ OnFocusLost
+ OnKeyPressed + + + + + OnKeyReleased
+ OnMouseDragged
+ OnMouseEntered
+ OnMouseExited
+ OnMouseMoved
+ OnMousePressed
+ OnMouseReleased
+ Page

+ + + + + Visible
+ Width
+ XChartObj
+ XDiagram
+ XDialogModel
+ XDialogView
+ XShape
+ XTableChart

+ + + +
+
+ The source code for the Dialog service is available in the SF_Dialog module of the Application Macros and Dialogs - SFDialogs library. + +

SFDialogs.DialogControl service

+ +
+ + + + List of Properties in the DialogControl Service + + + + + + Cancel
+ Caption
+ ControlType
+ CurrentNode
+ Default
+ Enabled
+ Format
+ ListCount
+ ListIndex + + + + + Locked
+ MultiSelect
+ Name
+ Page
+ Parent
+ Picture
+ RootNode
+ RowSource

+ + + + + Text
+ TipText
+ TripleState
+ Value
+ Visible
+ XControlModel
+ XControlView
+ XTreeDataModel

+ + + +
+
+ The source code for the DialogControl service is available in the SF_DialogControl module of the Application Macros and Dialogs - SFDialogs library. + +

ScriptForge.Dictionary service

+ +
+ + + + List of Properties in the Dictionary Service + + + + + + Count
+ + + + + Items
+ + + + + Keys
+ + + +
+
+ The source code for the Dictionary service is available in the SF_Dictionary module of the Application Macros and Dialogs - ScriptForge library. + +

SFDocuments.Document service

+ +
+ + + + List of Properties in the Document Service + + + + + + CustomProperties
+ Description
+ DocumentProperties
+ DocumentType
+ ExportFilters
+ ImportFilters
+ + + + + IsBase
+ IsCalc
+ IsDraw
+ IsImpress
+ IsMath
+ IsWriter
+ + + + + Keywords
+ Readonly
+ Subject
+ Title
+ XComponent
+ + + +
+
+ The source code for the Document service is available in the SF_Document module of the Application Macros and Dialogs - SFDocuments library. + +

ScriptForge.Exception service

+ +
+ + + + List of Properties in the Exception Service + + + + + + Description
+ + + + + Number
+ + + + + Source
+ + + +
+
+ The source code for the Exception service is available in the SF_Excecption module of the Application Macros and Dialogs - ScriptForge library. + +

ScriptForge.FileSystem service

+ +
+ + + + List of Properties in the FileSystem Service + + + + + + ConfigFolder
+ ExtensionsFolder
+ FileNaming
+ HomeFolder + + + + + InstallFolder
+ Subject
+ TemplatesFolder
+ TemporaryFolder + + + + + Title
+ UserTemplatesFolder
+ XComponent

+ + + +
+
+ The source code for the FileSystem service is available in the SF_FileSystem module of the Application Macros and Dialogs - ScriptForge library. + +

SFDocuments.Form service

+ +
+ + + + List of Properties in the Form Service + + + + + + AllowDeletes
+ AllowInserts
+ AllowUpdates
+ BaseForm
+ Bookmark
+ CurrentRecord
+ Filter
+ LinkChildFields
+ LinkParentFields
+ Name + + + + + OnApproveCursorMove
+ OnApproveParameter
+ OnApproveReset
+ OnApproveRowChange
+ OnApproveSubmit
+ OnConfirmDelete
+ OnCursorMoved
+ OnErrorOccurred
+ OnLoaded
+ OnReloaded + + + + + OnReloading
+ OnResetted
+ OnRowChanged
+ OnUnloaded
+ OnUnloading
+ OrderBy
+ Parent
+ RecordSource
+ XForm

+ + + +
+
+ The source code for the FormControl service is available in the SF_Form module of the Application Macros and Dialogs - SFDocuments library. + +

SFDocuments.FormControl service

+ +
+ + + + List of Properties in the FormControl Service + + + + + + Action
+ Caption
+ ControlSource
+ ControlType
+ Default
+ DefaultValue
+ Enabled
+ Format
+ ListCount
+ ListIndex
+ ListSource
+ ListSourceType
+ Locked
+ MultiSelect
+ Name
+ OnActionPerformed + + + + + OnAdjustmentValueChanged
+ OnApproveAction
+ OnApproveReset
+ OnApproveUpdate
+ OnChanged
+ OnErrorOccurred
+ OnFocusGained
+ OnFocusLost
+ OnItemStateChanged
+ OnKeyPressed
+ OnKeyReleased
+ OnMouseDragged
+ OnMouseEntered
+ OnMouseExited
+ OnMouseMoved

+ + + + + OnMousePressed
+ OnMouseReleased
+ OnResetted
+ OnTextChanged
+ OnUpdated
+ Parent
+ Picture
+ Required
+ Text
+ TipText
+ TripleState
+ Value
+ Visible
+ XControlModel
+ XControlView

+ + + +
+
+ The source code for the FormControl service is available in the SF_FormControl module of the Application Macros and Dialogs - SFDocuments library. + +

ScriptForge.L10N service

+ +
+ + + + List of Properties in the L10N Service + + + + + + Folder
+ + + + + Language
+ + + + + Locale
+ + + +
+
+ The source code for the L10N service is available in the SF_L10N module of the Application Macros and Dialogs - ScriptForge library. + +

SFWidgets.Menu service

+ +
+ + + + List of Properties in the Menu Service + + + + + + ShortcutCharacter
+ + + + + SubmenuCharacter
+ + + +
+
+ The source code for the Menu service is available in the SF_Menu module of the Application Macros and Dialogs - SFWidgets library. + +

ScriptForge.Platform service

+
+ + + + List of Properties in the Platform Service + + + + + + Architecture
+ ComputerName
+ CPUCount
+ CurrentUser
+ Extensions
+ FilterNames
+ Fonts + + + + + FormatLocale
+ Locale
+ Machine
+ OfficeLocale
+ OfficeVersion
+ OSName
+ OSPlatform + + + + + OSRelease
+ OSVersion
+ Printers
+ Processor
+ PythonVersion
+ SystemLocale

+ + + +
+
+ The source code for the Platform service is available in the SF_Platform module of the Application Macros and Dialogs - ScriptForge library. + +

SFWidgets.PopupMenu service

+ +
+ + + + List of Properties in the PopupMenu Service + + + + + + ShortcutCharacter
+ + + + + SubmenuCharacter
+ + + +
+
+ The source code for the PopupMenu service is available in the SF_PopupMenu module of the Application Macros and Dialogs - SFWidgets library. + +

ScriptForge.Region service

+ +
+ + + + List of Properties in the Region Service + + + + + + Country
+ Currency
+ DatePatterns
+ DateSeparator
+ DayAbbrevNames + + + + + DayNames
+ DayNarrowNames
+ DecimalPoint
+ Language
+ ListSeparator + + + + + MonthAbbrevNames
+ MonthNames
+ MonthNarrowNames
+ ThousandSeparator
+ TimeSeparator + + + +
+
+ The source code for the Region service is available in the SF_Region module of the Application Macros and Dialogs - ScriptForge library. + +

ScriptForge.Session service

+ +
+ + + + List of Properties in the Session Service + + + + + + SCRIPTISAPPLICATION
+ SCRIPTISEMBEDDED
+ SCRIPTISOXT + + + + + SCRIPTISPERSONAL
+ SCRIPTISPERSOXT

+ + + + + SCRIPTISSHARED
+ SCRIPTISSHAROXT

+ + + +
+
+ The source code for the Session service is available in the SF_Session module of the Application Macros and Dialogs - ScriptForge library. + +

ScriptForge.String service

+ +
+ + + + List of Properties in the Dictionary Service + + + + + + sfCR
+ sfLF + + + + + sfCRLF
+ sfNEWLINE + + + + + sfTAB

+ + + +
+
+ The source code for the String service is available in the SF_String module of the Application Macros and Dialogs - ScriptForge library. + +

ScriptForge.TextStream service

+ +
+ + + + List of Properties in the TextStream Service + + + + + + AtEndOfStream
+ Encoding
+ + + + + FileName
+ IOMode
+ + + + + Line
+ NewLine
+ + + +
+
+ The source code for the TextStream service is available in the SF_TextStream module of the Application Macros and Dialogs - ScriptForge library. + +

ScriptForge.Timer service

+
+ + + + List of Methods in the Timer Service + + + + + + Continue
+ Restart + + + + + Start
+ Suspend + + + + + Terminate

+ + + +
+
+
+ + + + List of Properties in the Timer Service + + + + + + Duration
+ IsStarted + + + + + IsSuspended
+ SuspendDuration + + + + + TotalDuration

+ + + +
+
+ The source code for the Timer service is available in the SF_Timer module of the Application Macros and Dialogs - ScriptForge library. + +

ScriptForge.UI service

+ +
+ + + + List of Properties in the UI Service + + + + + + ActiveWindow
+ Documents
+ Height
+ + + + + MACROEXECALWAYS
+ MACROEXECNEVER
+ MACROEXECNORMAL
+ + + + + Width
+ X
+ Y
+ + + +
+
+ The source code for the UI service is available in the SF_UI module of the Application Macros and Dialogs - ScriptForge library. + +

ScriptForge.UnitTest service

+ +
+ + + + List of Properties in the UnitTest Service + + + + + + LongMessage
+ ReturnCode + + + + + Verbose

+ + + + + WhenAssertionFails

+ + + +
+
+ The source code for the UnitTest service is available in the SF_UnitTest module of the Application Macros and Dialogs - SFUnitTests library. + +
+ + +
+ + diff --git a/source/text/sbasic/shared/03/sf_ui.xhp b/source/text/sbasic/shared/03/sf_ui.xhp index c189dd67d1..4627c1165d 100644 --- a/source/text/sbasic/shared/03/sf_ui.xhp +++ b/source/text/sbasic/shared/03/sf_ui.xhp @@ -93,8 +93,9 @@ ui = CreateScriptService("UI") -

Properties

- +

Properties

+
+
Name @@ -194,11 +195,12 @@
+ -
-

Constants

- - +

Constants

+
+
+ Name @@ -242,8 +244,8 @@ Macro execution depends on user settings -
-
+ + The examples below show a MsgBox with the names of all currently open documents. @@ -266,9 +268,12 @@ bas.MsgBox(strDocs) +
- List of Methods in the UI Service + + List of Methods in the UI Service + @@ -291,8 +296,9 @@ WindowExists

 -
-Note, as an exception, that the methods marked (*) are not applicable to Base documents. + +
+ Note, as an exception, that the methods marked (*) are not applicable to Base documents.
Activate -------------------------------------------------------------------------------------------------------------------------- @@ -485,7 +491,7 @@ ui.OpenBaseDocument(r"C:\Documents\myDB.odb", macroexecution = ui.MACROEXECALWAYS) - To improve code readability you can use predefined constants for the macroexecution argument, as in the examples above. + To improve code readability you can use predefined constants for the macroexecution argument, as in the examples above.
diff --git a/source/text/sbasic/shared/03/sf_unittest.xhp b/source/text/sbasic/shared/03/sf_unittest.xhp index 50c0051d89..3a6466892a 100644 --- a/source/text/sbasic/shared/03/sf_unittest.xhp +++ b/source/text/sbasic/shared/03/sf_unittest.xhp @@ -157,7 +157,8 @@

Properties

- +
+
Name @@ -235,11 +236,15 @@ 2 - Stop immediately (default in simple mode) -
+ +
- +
+
- List of Methods in the UnitTest Service + + List of Methods in the UnitTest Service + @@ -281,8 +286,9 @@ SkipTest
 - -
+ + +

Arguments of the AssertX methods

All assertions test one or two expressions, referred in the remainder of this help page as A and B. They are always the first one or two arguments in the AssertX method. -- cgit