wizards/source/scriptforge/SF_Exception.xba | 5 +
wizards/source/scriptforge/SF_Root.xba | 12 ++
wizards/source/scriptforge/po/ScriptForge.pot | 21 ++++
wizards/source/scriptforge/po/en.po | 21 ++++
wizards/source/scriptforge/python/scriptforge.py | 3
wizards/source/sfdocuments/SF_Calc.xba | 109 +++++++++++++++++++++++
6 files changed, 167 insertions(+), 4 deletions(-)
New commits:
commit 363dd5850fd1681caeb2757f1ad2378b6a0e4afe
Author: Jean-Pierre Ledure <j...@ledure.be>
AuthorDate: Wed Mar 2 11:27:44 2022 +0100
Commit: Jean-Pierre Ledure <j...@ledure.be>
CommitDate: Wed Mar 2 14:13:39 2022 +0100
ScriptForge - (SF_Calc) new ExportRangeToFile() method
The Calc service offers the possibility to export
a range, given as a string, to a file in several
different image formats.
Supported formats: pdf, jpeg, png.
Arguments:
- Range: a sheet name or a range of cells
- Filename: the file to export to in FileSystem notation
- ImageType: the expected output format
- Overwrite: True when the output file may be overwritten
New error message: RANGEEXPORTERROR
Error is introduced in po files.
The method is available both in Basic and Python user scripts.
Change-Id: Ibd297ec2da1b48fca3dee7d8e03bd2ee4815957a
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/130835
Tested-by: Jean-Pierre Ledure <j...@ledure.be>
Tested-by: Jenkins
Reviewed-by: Jean-Pierre Ledure <j...@ledure.be>
diff --git a/wizards/source/scriptforge/SF_Exception.xba
b/wizards/source/scriptforge/SF_Exception.xba
index a7fde7b69ea4..3d28153a5a40 100644
--- a/wizards/source/scriptforge/SF_Exception.xba
+++ b/wizards/source/scriptforge/SF_Exception.xba
@@ -107,6 +107,7 @@ Const CALCADDRESSERROR =
"CALCADDRESSERROR"
Const DUPLICATESHEETERROR = "DUPLICATESHEETERROR"
Const OFFSETADDRESSERROR = "OFFSETADDRESSERROR"
Const DUPLICATECHARTERROR = "DUPLICATECHARTERROR"
+Const RANGEEXPORTERROR = "RANGEEXPORTERROR"
' SF_Chart
Const CHARTEXPORTERROR = "CHARTEXPORTERROR"
@@ -978,6 +979,10 @@ Try:
sMessage = sLocation _
& "\n" &
"\n" & "\n" & .GetText("VALIDATEERROR",
pvArgs(0)) _
& "\n" &
"\n" & .GetText("DUPLICATECHART", pvArgs(0), pvArgs(1),
pvArgs(2), pvArgs(3), pvArgs(4), pvArgs(5))
+ Case RANGEEXPORTERROR '
SF_Calc.ExportRangeToFile(Arg1Name, FileName, Arg2, Overwrite)
+ pvArgs(0) = _RightCase(pvArgs(0)) :
pvArgs(2) = _RightCase(pvArgs(2))
+ sMessage = sLocation _
+ & "\n" &
"\n" & .GetText("RANGEEXPORT", pvArgs(0), pvArgs(1),
pvArgs(2), pvArgs(3))
Case CHARTEXPORTERROR '
SF_Chart.ExportToFile(Arg1Name, FileName, Arg2, Overwrite)
pvArgs(0) = _RightCase(pvArgs(0)) :
pvArgs(2) = _RightCase(pvArgs(2))
sMessage = sLocation _
diff --git a/wizards/source/scriptforge/SF_Root.xba
b/wizards/source/scriptforge/SF_Root.xba
index 7df7cd3957a6..46cdec9f7ea5 100644
--- a/wizards/source/scriptforge/SF_Root.xba
+++ b/wizards/source/scriptforge/SF_Root.xba
@@ -849,6 +849,18 @@ Try:
&
"%5: An identifier\n" _
&
"%6: A file name" _
)
+ ' SF_Calc.ExportRangeToFile
+ .AddText( Context := "RANGEEXPORT" _
+ , MsgId := "The given
range could not be exported.\n" _
+ &
"Either the destination file must not be overwritten, or it has a
read-only attribute set.\n\n" _
+ &
"%1 = '%2'\n" _
+ &
"%3 = %4" _
+ , Comment :=
"SF_Calc.ExportRangeToFile error message\n" _
+ &
"%1: An identifier\n" _
+ &
"%2: A file name\n" _
+ &
"%3: An identifier\n" _
+ &
"%4: True or False\n" _
+ )
' SF_Chart.ExportToFile
.AddText( Context := "CHARTEXPORT" _
, MsgId := "The chart
could not be exported.\n" _
diff --git a/wizards/source/scriptforge/po/ScriptForge.pot
b/wizards/source/scriptforge/po/ScriptForge.pot
index 9976fb866a25..7db51ffc5f60 100644
--- a/wizards/source/scriptforge/po/ScriptForge.pot
+++ b/wizards/source/scriptforge/po/ScriptForge.pot
@@ -7,14 +7,14 @@
# *** are part of the LibreOffice project. ***
# *********************************************************************
#
-# ScriptForge Release 7.3
+# ScriptForge Release 7.4
# -----------------------
#
msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"Report-Msgid-Bugs-To:
https://bugs.libreoffice.org/enter_bug.cgi?product=LibreOffice&bug_status=UNCONFIRMED&component=UI\n";
-"POT-Creation-Date: 2022-01-31 16:58:10\n"
+"POT-Creation-Date: 2022-03-01 15:25:24\n"
"PO-Revision-Date: YYYY-MM-DD HH:MM:SS\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <EMAIL@ADDRESS>\n"
@@ -762,6 +762,23 @@ msgid ""
""
msgstr ""
+#. SF_Calc.ExportRangeToFile error message
+#. %1: An identifier
+#. %2: A file name
+#. %3: An identifier
+#. %4: True or False
+#.
+#, kde-format
+msgctxt "RANGEEXPORT"
+msgid ""
+"The given range could not be exported.\n"
+"Either the destination file must not be overwritten, or it has a "
+"read-only attribute set.\n"
+"\n"
+"%1 = '%2'\n"
+"%3 = %4"
+msgstr ""
+
#. SF_Chart.ExportToFile error message
#. %1: An identifier
#. %2: A file name
diff --git a/wizards/source/scriptforge/po/en.po
b/wizards/source/scriptforge/po/en.po
index 9976fb866a25..7db51ffc5f60 100644
--- a/wizards/source/scriptforge/po/en.po
+++ b/wizards/source/scriptforge/po/en.po
@@ -7,14 +7,14 @@
# *** are part of the LibreOffice project. ***
# *********************************************************************
#
-# ScriptForge Release 7.3
+# ScriptForge Release 7.4
# -----------------------
#
msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"Report-Msgid-Bugs-To:
https://bugs.libreoffice.org/enter_bug.cgi?product=LibreOffice&bug_status=UNCONFIRMED&component=UI\n";
-"POT-Creation-Date: 2022-01-31 16:58:10\n"
+"POT-Creation-Date: 2022-03-01 15:25:24\n"
"PO-Revision-Date: YYYY-MM-DD HH:MM:SS\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <EMAIL@ADDRESS>\n"
@@ -762,6 +762,23 @@ msgid ""
""
msgstr ""
+#. SF_Calc.ExportRangeToFile error message
+#. %1: An identifier
+#. %2: A file name
+#. %3: An identifier
+#. %4: True or False
+#.
+#, kde-format
+msgctxt "RANGEEXPORT"
+msgid ""
+"The given range could not be exported.\n"
+"Either the destination file must not be overwritten, or it has a "
+"read-only attribute set.\n"
+"\n"
+"%1 = '%2'\n"
+"%3 = %4"
+msgstr ""
+
#. SF_Chart.ExportToFile error message
#. %1: An identifier
#. %2: A file name
diff --git a/wizards/source/scriptforge/python/scriptforge.py
b/wizards/source/scriptforge/python/scriptforge.py
index d9fac9c26d5e..ec76835befd2 100644
--- a/wizards/source/scriptforge/python/scriptforge.py
+++ b/wizards/source/scriptforge/python/scriptforge.py
@@ -2018,6 +2018,9 @@ class SFDocuments:
def DSum(self, range):
return self.ExecMethod(self.vbMethod, 'DSum', range)
+ def ExportRangeToFile(self, range, filename, imagetype = 'pdf',
overwrite = False):
+ return self.ExecMethod(self.vbMethod, 'ExportRangeToFile', range,
filename, imagetype, overwrite)
+
def Forms(self, sheetname, form = ''):
return self.ExecMethod(self.vbMethod + self.flgArrayRet, 'Forms',
sheetname, form)
diff --git a/wizards/source/sfdocuments/SF_Calc.xba
b/wizards/source/sfdocuments/SF_Calc.xba
index f7cd2005d1b5..66fc9c19800f 100644
--- a/wizards/source/sfdocuments/SF_Calc.xba
+++ b/wizards/source/sfdocuments/SF_Calc.xba
@@ -85,6 +85,7 @@ Private Const DUPLICATESHEETERROR =
"DUPLICATESHEETERROR"
Private Const OFFSETADDRESSERROR = "OFFSETADDRESSERROR"
Private Const CALCFORMNOTFOUNDERROR =
"CALCFORMNOTFOUNDERROR"
Private Const DUPLICATECHARTERROR = "DUPLICATECHARTERROR"
+Private Const RANGEEXPORTERROR = "RANGEEXPORTERROR"
REM ============================================================= PRIVATE
MEMBERS
@@ -1154,6 +1155,113 @@ Finally:
Exit Function
End Function ' SF_Documents.SF_Calc.DSum
+REM
-----------------------------------------------------------------------------
+Public Function ExportRangeToFile(Optional ByVal Range As Variant _
+ ,
Optional ByVal FileName As Variant _
+ ,
Optional ByVal ImageType As Variant _
+ ,
Optional ByVal Overwrite As Variant _
+ ) As
Boolean
+''' Store the given range as an image to the given file location
+''' Actual selections are not impacted
+''' Inspired by
https://stackoverflow.com/questions/30509532/how-to-export-cell-range-to-pdf-file
+''' Args:
+''' Range: sheet name or cell range to be exported,
as a string
+''' FileName: Identifies the file where to save. It
must follow the SF_FileSystem.FileNaming notation
+''' ImageType: the name of the targeted media type
+''' Allowed values: jpeg, pdf (default) and
png
+''' Overwrite: True if the destination file may be
overwritten (default = False)
+''' Returns:
+''' False if the document could not be saved
+''' Exceptions:
+''' RANGEEXPORTERROR The destination
has its readonly attribute set or overwriting rejected
+''' Examples:
+'''
oDoc.ExportRangeToFile('SheetX.B2:J15", "C:\Me\Range2.png",
ImageType := "png", Overwrite := True)
+
+Dim bSaved As Boolean ' return value
+Dim oSfa As Object '
com.sun.star.ucb.SimpleFileAccess
+Dim sFile As String ' Alias of
FileName
+Dim vStoreArguments As Variant ' Array of
com.sun.star.beans.PropertyValue
+Dim vFilterData As Variant ' Array of
com.sun.star.beans.PropertyValue
+Dim FSO As Object ' SF_FileSystem
+Dim vImageTypes As Variant ' Array of permitted
image types
+Dim vFilters As Variant ' Array of
corresponding filters in the same order as vImageTypes
+Dim sFilter As String ' The filter to apply
+Dim oSelect As Object ' Currently selected
range(s)
+Dim oAddress As Object ' Alias of Range
+
+Const cstImageTypes = "jpeg,pdf,png"
+Const cstFilters =
"calc_jpg_Export,calc_pdf_Export,calc_png_Export"
+
+Const cstThisSub = "SFDocuments.Calc.ExportRangeToFile"
+Const cstSubArgs = "Range, FileName,
[ImageType=""pdf""|""jpeg""|""png""],
[Overwrite=False]"
+
+ If ScriptForge.SF_Utils._ErrorHandling() Then On Local Error GoTo
CatchError
+ bSaved = False
+
+Check:
+ If IsMissing(ImageType) Or IsEmpty(ImageType) Then ImageType =
"pdf"
+ If IsMissing(Overwrite) Or IsEmpty(Overwrite) Then Overwrite = False
+
+ vImageTypes = Split(cstImageTypes, ",")
+ If ScriptForge.SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
+ If Not _IsStillAlive() Then GoTo Finally
+ If Not ScriptForge.SF_Utils._Validate(Range, "Range",
V_STRING) Then GoTo Finally
+ If Not ScriptForge.SF_Utils._ValidateFile(FileName,
"FileName") Then GoTo Finally
+ If Not ScriptForge.SF_Utils._Validate(ImageType,
"ImageType", V_STRING, vImageTypes) Then GoTo Finally
+ If Not ScriptForge.SF_Utils._Validate(Overwrite,
"Overwrite", ScriptForge.V_BOOLEAN) Then GoTo Finally
+ End If
+
+ ' Check destination file overwriting
+ Set FSO = CreateScriptService("FileSystem")
+ sFile = FSO._ConvertToUrl(FileName)
+ If FSO.FileExists(FileName) Then
+ If Overwrite = False Then GoTo CatchError
+ Set oSfa =
ScriptForge.SF_Utils._GetUNOService("FileAccess")
+ If oSfa.isReadonly(sFile) Then GoTo CatchError
+ End If
+
+Try:
+ ' Setup arguments
+ vFilters = Split(cstFilters, ",")
+ sFilter = vFilters(ScriptForge.SF_Array.IndexOf(vImageTypes, ImageType,
CaseSensitive := False))
+ Set oAddress = _ParseAddress(Range)
+
+ ' The filter arguments differ between
+ ' 1) pdf : store range in Selection property value
+ ' 2) png, jpeg : save current selection, select range,
restore initial selection
+ If LCase(ImageType) = "pdf" Then
+ vFilterData =
Array(ScriptForge.SF_Utils._MakePropertyValue("Selection",
oAddress.XCellRange) )
+ vStoreArguments = Array( _
+
ScriptForge.SF_Utils._MakePropertyValue("FilterName", sFilter) _
+ ,
ScriptForge.SF_Utils._MakePropertyValue("FilterData", vFilterData) _
+ )
+ Else ' png, jpeg
+ ' Save the current selection(s)
+ Set oSelect = _Component.CurrentController.getSelection()
+ _Component.CurrentController.select(oAddress.XCellRange)
+ vStoreArguments = Array( _
+
ScriptForge.SF_Utils._MakePropertyValue("FilterName", sFilter) _
+ ,
ScriptForge.SF_Utils._MakePropertyValue("SelectionOnly", True) _
+ )
+ End If
+
+ ' Apply the filter and export
+ _Component.storeToUrl(sFile, vStoreArguments)
+ If LCase(ImageType) <> "pdf" Then
_RestoreSelections(_Component, oSelect)
+
+ bSaved = True
+
+Finally:
+ ExportRangeToFile = bSaved
+ ScriptForge.SF_Utils._ExitFunction(cstThisSub)
+ Exit Function
+Catch:
+ GoTo Finally
+CatchError:
+ ScriptForge.SF_Exception.RaiseFatal(RANGEEXPORTERROR,
"FileName", FileName, "Overwrite", Overwrite)
+ GoTo Finally
+End Function ' SFDocuments.SF_Chart.ExportRangeToFile
+
REM
-----------------------------------------------------------------------------
Public Function Forms(Optional ByVal SheetName As Variant _
, Optional ByVal Form
As Variant _
@@ -1650,6 +1758,7 @@ Public Function Methods() As Variant
, "DMax" _
, "DMin" _
, "DSum" _
+ , "ExportRangeToFile" _
, "GetColumnName" _
, "GetFormula" _
, "GetValue" _
