diff options
| author | Jean-Pierre Ledure <jp@ledure.be> | 2023-01-25 15:26:10 +0100 |
|---|---|---|
| committer | Jean-Pierre Ledure <jp@ledure.be> | 2023-01-26 11:22:37 +0000 |
| commit | 9079d15ec54928e1e7d5596e148d0f9aefe81bd6 (patch) | |
| tree | f42e9a7473aa54d4d99a521eced23198f24287b3 /wizards | |
| parent | b6f8734963b883798ca4bf6854fa90e7dd7b9131 (diff) | |
ScriptForge (SF_Calc) more accurate comments
Impact only on comments, code left unchanged
Change-Id: I5549f2549d2b9ff351ad6174b9dba458525db210
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/146139
Tested-by: Jean-Pierre Ledure <jp@ledure.be>
Reviewed-by: Jean-Pierre Ledure <jp@ledure.be>
Tested-by: Jenkins
Diffstat (limited to 'wizards')
| -rw-r--r-- | wizards/source/sfdocuments/SF_Calc.xba | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/wizards/source/sfdocuments/SF_Calc.xba b/wizards/source/sfdocuments/SF_Calc.xba index 8169ae2e188c..bba5ebdf5b2e 100644 --- a/wizards/source/sfdocuments/SF_Calc.xba +++ b/wizards/source/sfdocuments/SF_Calc.xba @@ -29,6 +29,7 @@ Option Explicit ''' The SF_Calc module is focused on : ''' - management (copy, insert, move, ...) of sheets within a Calc document ''' - exchange of data between Basic data structures and Calc ranges of values +''' - copying and importing massive amounts of data ''' ''' The current module is closely related to the "UI" service of the ScriptForge library ''' @@ -63,9 +64,9 @@ Option Explicit ''' or an object produced by .Range() ''' The sheet name is optional (default = active sheet). Surrounding quotes and $ signs are optional ''' ~.~, ~ The current selection in the active sheet -''' '$SheetX'.D2 or $D$2 A single cell -''' '$SheetX'.D2:F6, D2:D10 Multiple cells -''' '$SheetX'.A:A or 3:5 All cells in the same column or row up to the last active cell +''' $'SheetX'.D2 or $D$2 A single cell +''' $SheetX.D2:F6, D2:D10 Multiple cells +''' $'SheetX'.A:A or 3:5 All cells in the same column or row up to the last active cell ''' SheetX.* All cells up to the last active cell ''' myRange A range name at spreadsheet level ''' ~.yourRange, SheetX.someRange A range name at sheet level @@ -74,10 +75,10 @@ Option Explicit ''' ''' Several methods may receive a "FilterFormula" as argument. ''' A FilterFormula may be associated with a FilterScope: "row", "column" or "cell". -''' These arguments determines on which rows/columns/cells of a range the method should be applied +''' These arguments determine on which rows/columns/cells of a range the method should be applied ''' Examples: -''' oDoc.ClearAll("A1:J10", FilterFormula := "=(A1<=0)", FilterScope := "CELL") ' Clear all negative values -''' oDoc.ClearAll("A2:J10", FilterFormula := "=(A2<>A1)", FilterScope := "COLUMN") ' Clear when identical to above cell +''' oDoc.ClearAll("A1:J10", FilterFormula := "=(A1<=0)", FilterScope := "CELL") ' Clear all negative values +''' oDoc.ClearAll("SheetX.A1:J10", "=SUM(SheetX.A1:A10)>100", "COLUMN") ' Clear all columns whose sum is greater than 500 ''' ''' FilterFormula: a Calc formula that returns TRUE or FALSE ''' the formula is expressed in terms of @@ -4372,8 +4373,8 @@ Private Function _ParseAddress(ByVal psAddress As String) As Object ''' Parse and validate a sheet or range reference ''' Syntax to parse: ''' [Sheet].[Range] -''' Sheet => ['][$]sheet['] or document named range or ~ -''' Range => A1:D10, A1, A:D, 10:10 ($ ignored), or sheet named range or ~ +''' Sheet => [$][']sheet['] or document named range or ~ +''' Range => A1:D10, A1, A:D, 10:10 ($ ignored), or sheet named range or ~ or * ''' Returns: ''' An object of type _Address ''' Exceptions: |