wizards/Package_sfdatabases.mk | 1
wizards/source/scriptforge/SF_Services.xba | 2
wizards/source/scriptforge/SF_UI.xba | 31
wizards/source/scriptforge/python/scriptforge.py | 117 ++-
wizards/source/sfdatabases/SF_Database.xba | 189 +++++
wizards/source/sfdatabases/SF_Datasheet.xba | 744 +++++++++++++++++++++++
wizards/source/sfdatabases/SF_Register.xba | 58 +
wizards/source/sfdatabases/script.xlb | 1
wizards/source/sfdialogs/SF_Dialog.xba | 4
wizards/source/sfdocuments/SF_Base.xba | 107 +++
wizards/source/sfdocuments/SF_Calc.xba | 50 -
wizards/source/sfdocuments/SF_Document.xba | 4
12 files changed, 1232 insertions(+), 76 deletions(-)
New commits:
commit 985c77b570807dcc558ccff4a51430fe489b68fd
Author: Jean-Pierre Ledure <j...@ledure.be>
AuthorDate: Tue Nov 1 17:27:21 2022 +0100
Commit: Jean-Pierre Ledure <j...@ledure.be>
CommitDate: Wed Nov 2 11:26:46 2022 +0100
ScriptForge = (SFDatabases) New Datasheet service
A datasheet is the visual representation
of tabular data produced by a database.
In the user interface of LibreOffice
it is the result of the opening of a table or a query.
In this case the concerned Base document must be open.
In the context of ScriptForge, a datasheet
may be opened automatically by script code :
- either by reproducing the behaviour of the user interface
- or at any moment.
In this case the Base document does not need to be open.
Additionally, any SELECT SQL statement
may define the datasheet display.
The proposed API allows for either datasheets
(opened manually of by code) in particular
to know which cell is selected and its content.
Properties:
ColumnHeaders
CurrentColumn
CurrentRow
LastRow
Source
SourceType
XComponent
XControlModel
XTabControllerModel
Methods
Activate
ApplyFilter
CloseDatasheet
GetValue
GetText
GoToCell
OrderBy
The Base and Database services are enriched with the
OpenTable
OpenQuery
methods. The Database service gets also a new
OpenSql
method.
The whole set of properties and methods is available
both for Basic and Python scripts.
This new service requires a new help page dedicated
to this service, as well as an update of the
pages about the Base and Database services.
Change-Id: Ib409ce74d95de78f2792ba53e7ae554eab0867ab
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/142118
Tested-by: Jenkins
Reviewed-by: Jean-Pierre Ledure <j...@ledure.be>
diff --git a/wizards/Package_sfdatabases.mk b/wizards/Package_sfdatabases.mk
index 81fc55750291..bc5636fa1b2f 100644
--- a/wizards/Package_sfdatabases.mk
+++ b/wizards/Package_sfdatabases.mk
@@ -21,6 +21,7 @@ $(eval $(call
gb_Package_Package,wizards_basicsrvsfdatabases,$(SRCDIR)/wizards/s
$(eval $(call
gb_Package_add_files,wizards_basicsrvsfdatabases,$(LIBO_SHARE_FOLDER)/basic/SFDatabases,\
SF_Database.xba \
+ SF_Datasheet.xba \
SF_Register.xba \
__License.xba \
dialog.xlb \
diff --git a/wizards/source/scriptforge/SF_Services.xba
b/wizards/source/scriptforge/SF_Services.xba
index 627dc4d2e8fe..b72298ea3046 100644
--- a/wizards/source/scriptforge/SF_Services.xba
+++ b/wizards/source/scriptforge/SF_Services.xba
@@ -129,7 +129,7 @@ Try:
Case "document", "calc",
"writer", "base", "documentevent",
"formevent"
sLibrary = "SFDocuments"
Case "dialog", "dialogevent"
: sLibrary = "SFDialogs"
- Case "database"
: sLibrary = "SFDatabases"
+ Case "database", "datasheet"
: sLibrary = "SFDatabases"
Case "unittest"
: sLibrary = "SFUnitTests"
Case "menu", "popupmenu"
: sLibrary = "SFWidgets"
Case Else
diff --git a/wizards/source/scriptforge/SF_UI.xba
b/wizards/source/scriptforge/SF_UI.xba
index c8a7f9a8f861..e64011b9ed78 100644
--- a/wizards/source/scriptforge/SF_UI.xba
+++ b/wizards/source/scriptforge/SF_UI.xba
@@ -53,6 +53,7 @@ Type Window
WindowTitle As String '
Only mean to identify new documents
WindowFileName As String ' URL of
file name
DocumentType As String ' Writer,
Calc, ...
+ ParentName As String '
Identifier of the parent Base file when Window is a subcomponent
End Type
' The progress/status bar of the active window
@@ -72,11 +73,12 @@ Const IMPRESSDOCUMENT =
"Impress"
Const MATHDOCUMENT = "Math"
Const WRITERDOCUMENT = "Writer"
-' Window subtypes - Not supported yet
-Const BASETABLE = "BASETABLE"
-Const BASEQUERY = "BASEQUERY"
-Const BASEREPORT = "BASEREPORT"
-Const BASEDIAGRAM = "BASEDIAGRAM"
+' Window subtypes
+Const TABLEDATA = "TableData"
+Const QUERYDATA = "QueryData"
+Const SQLDATA = "SqlData"
+Const BASEREPORT = "BaseReport"
+Const BASEDIAGRAM = "BaseDiaram"
' Macro execution modes
Const cstMACROEXECNORMAL = 0 ' Default,
execution depends on user configuration and choice
@@ -1246,7 +1248,8 @@ Public Function _IdentifyWindow(ByRef poComponent As
Object) As Object
Dim oWindow As Window ' Return value
Dim sImplementation As String ' Component's
implementationname
Dim sIdentifier As String ' Component's
identifier
-Dim vArg As Variant ' One single item
of the Args UNO property
+Dim vSelection As Variant ' Array of
poCOmponent.Selection property values
+Dim iCommandType As Integer ' Datasheet type
Dim FSO As Object ' Alias for
SF_FileSystem
If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
@@ -1261,6 +1264,7 @@ Dim FSO As Object '
Alias for SF_FileSystem
.WindowTitle = ""
.WindowFileName = ""
.DocumentType = ""
+ .ParentName = ""
If IsNull(poComponent) Then GoTo Finally
If SF_Session.HasUnoProperty(poComponent,
"ImplementationName") Then sImplementation =
poComponent.ImplementationName
If SF_Session.HasUnoProperty(poComponent,
"Identifier") Then sIdentifier = poComponent.Identifier
@@ -1272,7 +1276,20 @@ Dim FSO As Object
' Alias for SF_FileSystem
.WindowFileName =
SF_Utils._GetPropertyValue(poComponent.Args, "URL")
If Len(.WindowFileName) > 0 Then .WindowName
= FSO.GetName(FSO._ConvertFromUrl(.WindowFileName))
.DocumentType = BASEDOCUMENT
- Case
"org.openoffice.comp.dbu.ODatasourceBrowser"
+ Case
"org.openoffice.comp.dbu.ODatasourceBrowser" ' Base
datasheet (table, query or sql in read mode
+ Set .Frame = poComponent.Frame
+ If Not IsEmpty(poComponent.Selection) Then
' Empty for (F4) DatasourceBrowser !!
+ vSelection = poComponent.Selection
+ .WindowName =
SF_Utils._GetPropertyValue(vSelection, "Command")
+ iCommandType =
SF_Utils._GetPropertyValue(vSelection, "CommandType")
+ Select Case iCommandType
+ Case
com.sun.star.sdb.CommandType.TABLE : .DocumentType = TABLEDATA
+ Case
com.sun.star.sdb.CommandType.QUERY : .DocumentType = QUERYDATA
+ Case
com.sun.star.sdb.CommandType.COMMAND : .DocumentType = SQLDATA
+ End Select
+ .ParentName =
SF_Utils._GetPropertyValue(vSelection, "DataSourceName")
+ .WindowTitle = .WindowName
+ End If
Case "org.openoffice.comp.dbu.OTableDesign",
"org.openoffice.comp.dbu.OQueryDesign" ' Table
or Query in Edit mode
Case "org.openoffice.comp.dbu.ORelationDesign"
Case "com.sun.star.comp.sfx2.BackingComp"
' Welcome screen
diff --git a/wizards/source/scriptforge/python/scriptforge.py
b/wizards/source/scriptforge/python/scriptforge.py
index c05d5349f0b4..940c355f1e44 100644
--- a/wizards/source/scriptforge/python/scriptforge.py
+++ b/wizards/source/scriptforge/python/scriptforge.py
@@ -224,7 +224,7 @@ class ScriptForge(object, metaclass = _Singleton):
scope, script = script.split('#')
if '.py$' in script.lower(): # Python
if len(scope) == 0:
- scope = 'share' # Default for Python
+ scope = 'share' # Default for Python
# Provide an alternate helper script depending on test context
if script.startswith(cls.pythonhelpermodule) and hasattr(cls,
'pythonhelpermodule2'):
script = cls.pythonhelpermodule2 +
script[len(cls.pythonhelpermodule):]
@@ -233,10 +233,10 @@ class ScriptForge(object, metaclass = _Singleton):
uri =
'vnd.sun.star.script:{0}?language=Python&location={1}'.format(script, scope)
else: # Basic
if len(scope) == 0:
- scope = 'application' # Default for Basic
+ scope = 'application' # Default for Basic
lib = ''
if len(script.split('.')) < 3:
- lib = cls.library + '.' # Default library = ScriptForge
+ lib = cls.library + '.' # Default library = ScriptForge
uri =
'vnd.sun.star.script:{0}{1}?language=Basic&location={2}'.format(lib, script,
scope)
# Get the script object
fullscript = ('@' if paramarray else '') + scope + ':' + script
@@ -327,7 +327,7 @@ class ScriptForge(object, metaclass = _Singleton):
elif returntuple[cstVarType] == ScriptForge.V_DATE:
dat =
SFScriptForge.SF_Basic.CDateFromUnoDateTime(returntuple[cstValue])
return dat
- else: # All other scalar values
+ else: # All other scalar values
pass
return returntuple[cstValue]
@@ -347,6 +347,7 @@ class ScriptForge(object, metaclass = _Singleton):
# etc ...
copyFile, copyfile = CopyFile, CopyFile
"""
+
def camelCase(key):
return key[0].lower() + key[1:]
@@ -354,8 +355,8 @@ class ScriptForge(object, metaclass = _Singleton):
# Synonyms of properties
if hasattr(cls, 'serviceproperties'):
dico = cls.serviceproperties
- dicosyn = dict(zip(map(str.lower, dico.keys()), dico.keys()))
# lower case
- cc = dict(zip(map(camelCase, dico.keys()), dico.keys()))
# camel Case
+ dicosyn = dict(zip(map(str.lower, dico.keys()), dico.keys()))
# lower case
+ cc = dict(zip(map(camelCase, dico.keys()), dico.keys())) #
camel Case
dicosyn.update(cc)
setattr(cls, 'propertysynonyms', dicosyn)
# Synonyms of methods. A method is a public callable attribute
@@ -448,7 +449,7 @@ class SFServices(object):
"""
# Python-Basic protocol constants and flags
vbGet, vbLet, vbMethod, vbSet = 2, 4, 1, 8 # CallByName constants
- flgPost = 32 # The method or the property implies a hardcoded
post-processing
+ flgPost = 32 # The method or the property implies a hardcoded
post-processing
flgDateArg = 64 # Invoked service method may contain a date argument
flgDateRet = 128 # Invoked service method can return a date
flgArrayArg = 512 # 1st argument can be a 2D array
@@ -506,7 +507,7 @@ class SFServices(object):
prop = self.GetProperty(name)
self.__dict__[name] = prop
return prop
- else: # Get Property from Basic and do not store it
+ else: # Get Property from Basic and do not store it
return self.GetProperty(name)
# Execute the usual attributes getter
return super(SFServices, self).__getattribute__(name)
@@ -545,7 +546,7 @@ class SFServices(object):
def Dispose(self):
if self.serviceimplementation == 'basic':
- if self.objectreference >= len(ScriptForge.servicesmodules): #
Do not dispose predefined module objects
+ if self.objectreference >= len(ScriptForge.servicesmodules): # Do
not dispose predefined module objects
self.ExecMethod(self.vbMethod, 'Dispose')
self.objectreference = -1
@@ -564,7 +565,7 @@ class SFServices(object):
calltype = self.vbGet + (self.flgUno if propertyname[0] == 'X'
else 0)
if arg is None:
return self.EXEC(self.objectreference, calltype, propertyname)
- else: # There are a few cases (Calc ...) where GetProperty
accepts an argument
+ else: # There are a few cases (Calc ...) where GetProperty
accepts an argument
return self.EXEC(self.objectreference, calltype, propertyname,
arg)
return None
@@ -667,7 +668,7 @@ class SFScriptForge:
:param unodate: com.sun.star.util.DateTime,
com.sun.star.util.Date or com.sun.star.util.Time
:return: the equivalent datetime.datetime
"""
- date = datetime.datetime(1899, 12, 30, 0, 0, 0, 0) # Idem as
Basic builtin TimeSeria() function
+ date = datetime.datetime(1899, 12, 30, 0, 0, 0, 0) # Idem as
Basic builtin TimeSeria() function
datetype = repr(type(unodate))
if 'com.sun.star.util.DateTime' in datetype:
if 1900 <= unodate.Year <= datetime.MAXYEAR:
@@ -693,16 +694,16 @@ class SFScriptForge:
"""
unodate = uno.createUnoStruct('com.sun.star.util.DateTime')
unodate.Year, unodate.Month, unodate.Day, unodate.Hours,
unodate.Minutes, unodate.Seconds, \
- unodate.NanoSeconds, unodate.IsUTC = \
- 1899, 12, 30, 0, 0, 0, 0, False # Identical to Basic
TimeSerial() function
+ unodate.NanoSeconds, unodate.IsUTC = \
+ 1899, 12, 30, 0, 0, 0, 0, False # Identical to Basic
TimeSerial() function
if isinstance(date, float):
date = time.localtime(date)
if isinstance(date, time.struct_time):
if 1900 <= date[0] <= 32767:
- unodate.Year, unodate.Month, unodate.Day, unodate.Hours,
unodate.Minutes, unodate.Seconds =\
+ unodate.Year, unodate.Month, unodate.Day, unodate.Hours,
unodate.Minutes, unodate.Seconds = \
date[0:6]
- else: # Copy only the time related part
+ else: # Copy only the time related part
unodate.Hours, unodate.Minutes, unodate.Seconds = date[3:3]
elif isinstance(date, (datetime.datetime, datetime.date,
datetime.time)):
if isinstance(date, (datetime.datetime, datetime.date)):
@@ -712,7 +713,7 @@ class SFScriptForge:
unodate.Hours, unodate.Minutes, unodate.Seconds,
unodate.NanoSeconds = \
date.hour, date.minute, date.second, date.microsecond
* 1000
else:
- return date # Not recognized as a date
+ return date # Not recognized as a date
return unodate
@classmethod
@@ -817,6 +818,7 @@ class SFScriptForge:
DESK = 'com.sun.star.frame.Desktop'
desktop = smgr.createInstanceWithContext(DESK, ctx)
return desktop
+
starDesktop, stardesktop = StarDesktop, StarDesktop
@property
@@ -832,8 +834,9 @@ class SFScriptForge:
return None
impl = comp.ImplementationName
if impl in ('com.sun.star.comp.basic.BasicIDE',
'com.sun.star.comp.sfx2.BackingComp'):
- return None # None when Basic IDE or welcome screen
+ return None # None when Basic IDE or welcome screen
return comp
+
thisComponent, thiscomponent = ThisComponent, ThisComponent
@property
@@ -844,7 +847,7 @@ class SFScriptForge:
Above behaviour cannot be reproduced in Python.
:return: the current Base (main) component or None when not a
Base document or one of its subcomponents
"""
- comp = self.ThisComponent # Get the current component
+ comp = self.ThisComponent # Get the current component
if comp is None:
return None
#
@@ -869,6 +872,7 @@ class SFScriptForge:
if db.ImplementationName == targetimpl:
return db
return None
+
thisDatabaseDocument, thisdatabasedocument = ThisDatabaseDocument,
ThisDatabaseDocument
@classmethod
@@ -1055,7 +1059,7 @@ class SFScriptForge:
# Direct call because RaiseFatal forces an execution stop in Basic
if len(args) == 0:
args = (None,)
- return cls.SIMPLEEXEC('@SF_Exception.RaiseFatal', (errorcode,
*args)) # With ParamArray
+ return cls.SIMPLEEXEC('@SF_Exception.RaiseFatal', (errorcode,
*args)) # With ParamArray
@classmethod
def _RaiseFatal(cls, sub, subargs, errorcode, *args):
@@ -1221,11 +1225,12 @@ class SFScriptForge:
dialogobj = dialog.objectreference if isinstance(dialog,
SFDialogs.SF_Dialog) else dialog
return self.ExecMethod(self.vbMethod + self.flgObject,
'AddTextsFromDialog', dialogobj)
- def ExportToPOTFile(self, filename, header = '', encoding= 'UTF-8'):
+ def ExportToPOTFile(self, filename, header = '', encoding = 'UTF-8'):
return self.ExecMethod(self.vbMethod, 'ExportToPOTFile', filename,
header, encoding)
def GetText(self, msgid, *args):
return self.ExecMethod(self.vbMethod, 'GetText', msgid, *args)
+
_ = GetText
# #########################################################################
@@ -1409,13 +1414,13 @@ class SFScriptForge:
serviceproperties = dict()
# Class constants Where to find an invoked
library ?
- SCRIPTISEMBEDDED = 'document' # in the document
- SCRIPTISAPPLICATION = 'application' # in any shared library (Basic)
- SCRIPTISPERSONAL = 'user' # in My Macros (Python)
- SCRIPTISPERSOXT = 'user:uno_packages' # in an extension installed
for the current user (Python)
- SCRIPTISSHARED = 'share' # in LibreOffice macros
(Python)
+ SCRIPTISEMBEDDED = 'document' # in the document
+ SCRIPTISAPPLICATION = 'application' # in any shared library (Basic)
+ SCRIPTISPERSONAL = 'user' # in My Macros (Python)
+ SCRIPTISPERSOXT = 'user:uno_packages' # in an extension installed for
the current user (Python)
+ SCRIPTISSHARED = 'share' # in LibreOffice macros (Python)
SCRIPTISSHAROXT = 'share:uno_packages' # in an extension installed
for all users (Python)
- SCRIPTISOXT = 'uno_packages' # in an extension but the
installation parameters are unknown (Python)
+ SCRIPTISOXT = 'uno_packages' # in an extension but the installation
parameters are unknown (Python)
@classmethod
def ExecuteBasicScript(cls, scope = '', script = '', *args):
@@ -1539,11 +1544,13 @@ class SFScriptForge:
@property
def AtEndOfStream(self):
return self.GetProperty('AtEndOfStream')
+
atEndOfStream, atendofstream = AtEndOfStream, AtEndOfStream
@property
def Line(self):
return self.GetProperty('Line')
+
line = Line
def CloseFile(self):
@@ -1629,6 +1636,7 @@ class SFScriptForge:
@property
def ActiveWindow(self):
return self.ExecMethod(self.vbMethod, 'ActiveWindow')
+
activeWindow, activewindow = ActiveWindow, ActiveWindow
def Activate(self, windowname = ''):
@@ -1743,9 +1751,57 @@ class SFDatabases:
def GetRows(self, sqlcommand, directsql = False, header = False,
maxrows = 0):
return self.ExecMethod(self.vbMethod + self.flgArrayRet,
'GetRows', sqlcommand, directsql, header, maxrows)
+ def OpenQuery(self, queryname):
+ return self.ExecMethod(self.vbMethod, 'OpenQuery', queryname)
+
+ def OpenSql(self, sql, directsql = False):
+ return self.ExecMethod(self.vbMethod, 'OpenSql', sql, directsql)
+
+ def OpenTable(self, tablename):
+ return self.ExecMethod(self.vbMethod, 'OpenTable', tablename)
+
def RunSql(self, sqlcommand, directsql = False):
return self.ExecMethod(self.vbMethod, 'RunSql', sqlcommand,
directsql)
+ # #########################################################################
+ # SF_Datasheet CLASS
+ # #########################################################################
+ class SF_Datasheet(SFServices):
+ """
+ A datasheet is the visual representation of tabular data produced
by a database.
+ A datasheet may be opened automatically by script code at any
moment.
+ The Base document owning the data may or may not be opened.
+ Any SELECT SQL statement may trigger the datasheet display.
+ """
+ # Mandatory class properties for service registration
+ serviceimplementation = 'basic'
+ servicename = 'SFDatabases.Datasheet'
+ servicesynonyms = ('datasheet', 'sfdatabases.datasheet')
+ serviceproperties = dict(ColumnHeaders = False, CurrentColumn = False,
CurrentRow = False, LastRow = False,
+ SOurce = False, SourceType = False,
XComponent = False, XControlModel = False,
+ XTabControllerModel = False)
+
+ def Activate(self):
+ return self.ExecMethod(self.vbMethod, 'Activate')
+
+ def ApplyFilter(self, filter = ''):
+ return self.ExecMethod(self.vbMethod, 'ApplyFilter', filter)
+
+ def CloseDatasheet(self):
+ return self.ExecMethod(self.vbMethod, 'CloseDatasheet')
+
+ def GetText(self, column = 0):
+ return self.ExecMethod(self.vbMethod, 'GetText', column)
+
+ def GetValue(self, column = 0):
+ return self.ExecMethod(self.vbMethod, 'GetValue', column)
+
+ def GoToCell(self, row = 0, column = 0):
+ return self.ExecMethod(self.vbMethod, 'GoToCell', row, column)
+
+ def OrderBy(self, order = ''):
+ return self.ExecMethod(self.vbMethod, 'OrderBy', order)
+
#
#####################################################################################################################
# SFDialogs CLASS (alias of SFDialogs Basic library)
###
@@ -1799,7 +1855,7 @@ class SFDialogs:
def Center(self, parent = ScriptForge.cstSymMissing):
parentclasses = (SFDocuments.SF_Document, SFDocuments.SF_Base,
SFDocuments.SF_Calc, SFDocuments.SF_Writer,
- SFDialogs.SF_Dialog)
+ SFDialogs.SF_Dialog)
parentobj = parent.objectreference if isinstance(parent,
parentclasses) else parent
return self.ExecMethod(self.vbMethod + self.flgObject +
self.flgHardCode, 'Center', parentobj)
@@ -2004,6 +2060,12 @@ class SFDocuments:
def OpenFormDocument(self, formdocument, designmode = False):
return self.ExecMethod(self.vbMethod, 'OpenFormDocument',
formdocument, designmode)
+ def OpenQuery(self, queryname):
+ return self.ExecMethod(self.vbMethod, 'OpenQuery', queryname)
+
+ def OpenTable(self, tablename):
+ return self.ExecMethod(self.vbMethod, 'OpenTable', tablename)
+
def PrintOut(self, formdocument, pages = '', copies = 1):
return self.ExecMethod(self.vbMethod, 'PrintOut', formdocument,
pages, copies)
@@ -2546,7 +2608,6 @@ def CreateScriptService(service, *args, **kwargs):
createScriptService, createscriptservice = CreateScriptService,
CreateScriptService
-
# ######################################################################
# Lists the scripts, that shall be visible inside the Basic/Python IDE
# ######################################################################
diff --git a/wizards/source/sfdatabases/SF_Database.xba
b/wizards/source/sfdatabases/SF_Database.xba
index 804084aff28e..6994f791a433 100644
--- a/wizards/source/sfdatabases/SF_Database.xba
+++ b/wizards/source/sfdatabases/SF_Database.xba
@@ -13,7 +13,7 @@ Option Explicit
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
''' SF_Database
-''' =========
+''' ===========
''' Management of databases embedded in or related
to Base documents
''' Each instance of the current class represents a
single database, with essentially its tables, queries and data
'''
@@ -27,7 +27,7 @@ Option Explicit
'''
''' Service invocation and usage:
''' 1) To access any database at anytime
-''' Dim myDatabase As Object
+''' Dim myDatabase As Object
''' Set myDatabase =
CreateScriptService("SFDatabases.Database", FileName, , [ReadOnly],
[User, [Password]])
''' ' Args:
''' '
FileName: the name of the Base file compliant with the
SF_FileSystem.FileNaming notation
@@ -38,7 +38,7 @@ Option Explicit
''' myDatabase.CloseDatabase()
'''
''' 2) To access the database related to the
current Base document
-''' Dim myDoc As Object, myDatabase As
Object, ui As Object
+''' Dim myDoc As Object, myDatabase
As Object, ui As Object
''' Set ui =
CreateScriptService("UI")
''' Set myDoc =
ui.OpenBaseDocument("myDb.odb")
''' Set myDatabase =
myDoc.GetDatabase() ' user and password are supplied here, if needed
@@ -401,11 +401,127 @@ Public Function Methods() As Variant
, "DMin" _
, "DSum" _
, "GetRows" _
+ , "OpenQuery" _
+ , "OpenSql" _
+ , "OpenTable" _
, "RunSql" _
)
End Function ' SFDatabases.SF_Database.Methods
+REM
-----------------------------------------------------------------------------
+Public Function OpenQuery(Optional ByVal QueryName As Variant) As Object
+''' Open the query given by its name
+''' The datasheet will live independently from any other
(typically Base) component
+''' Args:
+''' QueryName: a valid query name as a
case-sensitive string
+''' Returns:
+''' A Datasheet class instance if the query could
be opened, otherwise Nothing
+''' Exceptions:
+''' Query name is invalid
+''' Example:
+''' oDb.OpenQuery("myQuery")
+
+Dim oOpen As Object ' Return value
+Const cstThisSub = "SFDatabases.Database.OpenQuery"
+Const cstSubArgs = "QueryName"
+
+ If ScriptForge.SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
+ Set oOpen = Nothing
+
+Check:
+ If ScriptForge.SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
+ If Not ScriptForge.SF_Utils._Validate(QueryName,
"QueryName", V_STRING, Queries) Then GoTo Finally
+ End If
+
+Try:
+ Set oOpen = _OpenDatasheet(QueryName,
com.sun.star.sdb.CommandType.QUERY _
+ ,
_Connection.Queries.getByName(QueryName).EscapeProcessing)
+
+Finally:
+ Set OpenQuery = oOpen
+ ScriptForge.SF_Utils._ExitFunction(cstThisSub)
+ Exit Function
+Catch:
+ GoTo Finally
+End Function ' SFDocuments.SF_Base.OpenQuery
+
+REM
-----------------------------------------------------------------------------
+Public Function OpenSql(Optional ByRef Sql As Variant _
+ , Optional ByVal
DirectSql As Variant _
+ ) As Object
+''' Open the datasheet based on a SQL SELECT statement.
+''' The datasheet will live independently from any other
(typically Base) component
+''' Args:
+''' Sql: a valid Sql statement as a
case-sensitive string.
+''' Identifiers may be surrounded
by square brackets
+''' DirectSql: when True, the statement is
processed by the targeted RDBMS
+''' Returns:
+''' A Datasheet class instance if it could be
opened, otherwise Nothing
+''' Example:
+''' oDb.OpenSql("SELECT * FROM [Customers]
ORDER BY [CITY]")
+
+Dim oOpen As Object ' Return value
+Const cstThisSub = "SFDatabases.Database.OpenSql"
+Const cstSubArgs = "Sql, [DirectSql=False]"
+
+ If ScriptForge.SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
+ Set oOpen = Nothing
+
+Check:
+ If IsMissing(DirectSql) Or IsEmpty(DirectSql) Then DirectSql = False
+ If ScriptForge.SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
+ If Not ScriptForge.SF_Utils._Validate(Sql, "Sql",
V_STRING) Then GoTo Finally
+ If Not ScriptForge.SF_Utils._Validate(DirectSql,
"DirectSql", ScriptForge.V_BOOLEAN) Then GoTo Finally
+ End If
+
+Try:
+ Set oOpen = _OpenDatasheet(_ReplaceSquareBrackets(Sql),
com.sun.star.sdb.CommandType.COMMAND, Not DirectSql)
+
+Finally:
+ Set OpenSql = oOpen
+ ScriptForge.SF_Utils._ExitFunction(cstThisSub)
+ Exit Function
+Catch:
+ GoTo Finally
+End Function ' SFDocuments.SF_Base.OpenSql
+
+REM
-----------------------------------------------------------------------------
+Public Function OpenTable(Optional ByVal TableName As Variant) As Object
+''' Open the table given by its name
+''' The datasheet will live independently from any other
(typically Base) component
+''' Args:
+''' TableName: a valid table name as a
case-sensitive string
+''' Returns:
+''' A Datasheet class instance if the table could
be opened, otherwise Nothing
+''' Exceptions:
+''' Table name is invalid
+''' Example:
+''' oDb.OpenTable("myTable")
+
+Dim oOpen As Object ' Return value
+Const cstThisSub = "SFDatabases.Database.OpenTable"
+Const cstSubArgs = "TableName"
+
+ If ScriptForge.SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
+ Set oOpen = Nothing
+
+Check:
+ If ScriptForge.SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
+ If Not ScriptForge.SF_Utils._Validate(TableName,
"TableName", V_STRING, Tables) Then GoTo Finally
+ End If
+
+Try:
+ Set oOpen = _OpenDatasheet(TableName,
com.sun.star.sdb.CommandType.TABLE, True)
+
+Finally:
+ Set OpenTable = oOpen
+ ScriptForge.SF_Utils._ExitFunction(cstThisSub)
+ Exit Function
+Catch:
+ GoTo Finally
+End Function ' SFDocuments.SF_Base.OpenTable
+
REM
-----------------------------------------------------------------------------
Public Function Properties() As Variant
''' Return the list or properties of the Database class as
an array
@@ -664,8 +780,8 @@ Private Function _GetColumnValue(ByRef poResultSet As
Object _
''' Get the data stored in the current record of a result
set in a given column
''' The type of the column is found in the resultset's
metadata
''' Args:
-''' poResultSet: com.sun.star.sdbc.XResultSet
-''' plColIndex: the index of the column to extract
the value from
+''' poResultSet: com.sun.star.sdbc.XResultSet or
com.sun.star.awt.XTabControllerModel
+''' plColIndex: the index of the column to extract
the value from. Starts at 1
''' pbReturnBinary: when True, the method returns
the content of a binary field,
''' as long as its length does not exceed a
maximum length.
''' Default = False: binary fields are not
returned, only their length
@@ -685,7 +801,7 @@ Dim lSize As Long ' Binary
field length
Const cstMaxBinlength = 2 * 65535
On Local Error Goto 0 ' Disable error handler
- vValue = Null ' Default value
if error
+ vValue = Empty ' Default value
if error
If IsMissing(pbReturnBinary) Then pbReturnBinary = False
With com.sun.star.sdbc.DataType
@@ -701,17 +817,17 @@ Const cstMaxBinlength = 2 * 65535
If Not
ScriptForge.SF_Session.HasUNOMethod(oStream, "getLength") Then '
When no recordset
lSize = cstMaxBinLength
Else
- lSize =
CLng(oValue.getLength())
+ lSize =
CLng(oStream.getLength())
End If
If lSize <= cstMaxBinLength
And pbReturnBinary Then
vValue = Array()
-
oValue.readBytes(vValue, lSize)
+
oStream.readBytes(vValue, lSize)
Else ' Return length
of field, not content
vValue = lSize
End If
End If
End If
- oValue.closeInput()
+ If Not IsNull(oStream) Then oStream.closeInput()
Case .BIT, .BOOLEAN :
vValue = poResultSet.getBoolean(plColIndex)
Case .DATE
vDateTime = poResultSet.getDate(plColIndex)
@@ -754,6 +870,61 @@ Const cstMaxBinlength = 2 * 65535
End Function ' SFDatabases.SF_Database.GetColumnValue
+REM
-----------------------------------------------------------------------------
+Public Function _OpenDatasheet(Optional ByVal psCommand As Variant _
+ ,
piDatasheetType As Integer _
+ ,
pbEscapeProcessing As Boolean _
+ ) As Object
+''' Open the datasheet given by its name and its type
+''' The datasheet will live independently from any other
component
+''' Args:
+''' psCommand: a valid table or query name or an
SQL statement as a case-sensitive string
+''' piDatasheetType: one of the
com.sun.star.sdb.CommandType constants
+''' pbEscapeProcessing: == Not DirectSql
+''' Returns:
+''' A Datasheet class instance if the datasheet
could be opened, otherwise Nothing
+
+Dim oOpen As Object ' Return value
+Dim oNewDatasheet As Object ' com.sun.star.lang.XComponent
+Dim oURL As Object ' com.sun.star.util.URL
+Dim oDispatch As Object '
com.sun.star.frame.XDispatch
+Dim vArgs As Variant ' Array of property values
+
+ On Local Error GoTo Catch
+ Set oOpen = Nothing
+
+Try:
+ ' Setup the dispatcher
+ Set oURL = New com.sun.star.util.URL
+ oURL.Complete = ".component:DB/DataSourceBrowser"
+ Set oDispatch = StarDesktop.queryDispatch(oURL, "_Blank", 8)
+
+ ' Setup the arguments of the component to create
+ With ScriptForge.SF_Utils
+ vArgs = Array( _
+ ._MakePropertyValue("ActiveConnection",
_Connection) _
+ , ._MakePropertyValue("CommandType",
piDatasheetType) _
+ , ._MakePropertyValue("Command",
psCommand) _
+ , ._MakePropertyValue("ShowMenu",
True) _
+ , ._MakePropertyValue("ShowTreeView",
False) _
+ , ._MakePropertyValue("ShowTreeViewButton",
False) _
+ , ._MakePropertyValue("Filter",
"") _
+ , ._MakePropertyValue("ApplyFilter",
False) _
+ , ._MakePropertyValue("EscapeProcessing",
pbEscapeProcessing) _
+ )
+ End With
+
+ ' Open the targeted datasheet
+ Set oNewDatasheet = oDispatch.dispatchWithReturnValue(oURL, vArgs)
+ If Not IsNull(oNewDatasheet) Then Set oOpen =
ScriptForge.SF_Services.CreateScriptService("SFDatabases.Datasheet",
[Me], oNewDatasheet)
+
+Finally:
+ Set _OpenDatasheet = oOpen
+ Exit Function
+Catch:
+ GoTo Finally
+End Function ' SFDocuments.SF_Base._OpenDatasheet
+
REM
-----------------------------------------------------------------------------
Private Function _PropertyGet(Optional ByVal psProperty As String) As Variant
''' Return the value of the named property
diff --git a/wizards/source/sfdatabases/SF_Datasheet.xba
b/wizards/source/sfdatabases/SF_Datasheet.xba
new file mode 100644
index 000000000000..5550e35df30c
--- /dev/null
+++ b/wizards/source/sfdatabases/SF_Datasheet.xba
@@ -0,0 +1,744 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE script:module PUBLIC "-//OpenOffice.org//DTD OfficeDocument 1.0//EN"
"module.dtd">
+<script:module xmlns:script="http://openoffice.org/2000/script";
script:name="SF_Datasheet" script:language="StarBasic"
script:moduleType="normal">REM
=======================================================================================================================
+REM === The ScriptForge library and its associated
libraries are part of the LibreOffice project. ===
+REM === The SFDatabases library
is one of the associated libraries.
===
+REM === Full documentation is available
on https://help.libreoffice.org/
===
+REM
=======================================================================================================================
+
+Option Compatible
+Option ClassModule
+
+Option Explicit
+
+'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+''' SF_Datasheet
+''' ============
+''' A datasheet is the visual representation of
tabular data produced by a database.
+''' In the user interface of LibreOffice it is the
result of the opening of
+''' a table or a query. In this case the concerned
Base document must be open.
+'''
+''' In the context of ScriptForge, a datasheet may
be opened automatically by script code :
+''' - either by reproducing the behaviour
of the user interface
+''' - or at any moment. In this case the
Base document may or may not be opened.
+''' Additionally, any SELECT SQL
statement may trigger the datasheet display.
+'''
+''' The proposed API allows for either datasheets
(opened manually of by code) in particular
+''' to know which cell is selected and its content.
+'''
+''' Service invocation:
+''' 1) From an open Base document
+''' Set ui =
CreateScriptService("UI")
+''' Set oBase =
ui.getDocument("/home/user/Documents/myDb.odb")
+''' Set oSheet1 =
oBase.OpenTable("Customers") ' or OpenQuery(...)
+''' Set oSheet2 =
oBase.Datasheets("Products") ' when the datasheet has been
opened manually
+''' 2) Independently from a Base document
+''' Set oDatabase =
CreateScriptService("Database",
"/home/user/Documents/myDb.odb")
+''' Set oSheet =
oDatabase.OpenTable("Customers")
+'''
+''' Detailed user documentation:
+'''
https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/sf_datasheet.html?DbPAR=BASIC
+'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+
+REM ==================================================================
EXCEPTIONS
+
+Private Const DOCUMENTDEADERROR =
"DOCUMENTDEADERROR"
+
+REM ============================================================= PRIVATE
MEMBERS
+
+Private [Me] As Object
+Private [_Parent] As Object ' Base
instance when opened from a Base document by code
+
' or Database instance when opened without Base document
+Private ObjectType As String ' Must be
DATASHEET
+Private ServiceName As String
+
+Private _Component As Object '
com.sun.star.lang.XComponent - org.openoffice.comp.dbu.ODatasourceBrowser
+Private _Frame As Object '
com.sun.star.frame.XFrame
+Private _ParentBase As Object ' The
parent SF_Base instance (may be void)
+Private _ParentDatabase As Object ' The
parent SF_Database instance (must not be void)
+Private _SheetType As String ' TABLE,
QUERY or SQL
+Private _ParentType As String ' BASE or
DATABASE
+Private _BaseFileName As String ' URL format of
parent Base file
+Private _Command As String ' Table
name, query name or SQL statement
+Private _DirectSql As Boolean ' When
True, SQL processed by RDBMS
+Private _TabControllerModel As Object '
com.sun.star.awt.XTabControllerModel - com.sun.star.comp.forms.ODatabaseForm
+Private _ControlModel As Object '
com.sun.star.awt.XControlModel - com.sun.star.form.OGridControlModel
+Private _ControlView As Object '
com.sun.star.awt.XControl - org.openoffice.comp.dbu.ODatasourceBrowser
+Private _ColumnHeaders As Variant ' List of column
headers as an array of strings
+
+REM ============================================================ MODULE
CONSTANTS
+
+REM ======================================================
CONSTRUCTOR/DESTRUCTOR
+
+REM
-----------------------------------------------------------------------------
+Private Sub Class_Initialize()
+ Set [Me] = Nothing
+ Set [_Parent] = Nothing
+ ObjectType = "DATASHEET"
+ ServiceName = "SFDatabases.Datasheet"
+ Set _Component = Nothing
+ Set _Frame = Nothing
+ Set _ParentBase = Nothing
+ Set _ParentDatabase = Nothing
+ _SheetType = ""
+ _ParentType = ""
+ _BaseFileName = ""
+ _Command = ""
+ _DirectSql = False
+ Set _TabControllerModel = Nothing
+ Set _ControlModel = Nothing
+ Set _ControlView = Nothing
+ _ColumnHeaders = Array()
+End Sub ' SFDatabases.SF_Datasheet Constructor
+
+REM
-----------------------------------------------------------------------------
+Private Sub Class_Terminate()
+ Call Class_Initialize()
+End Sub ' SFDatabases.SF_Datasheet Destructor
+
+REM
-----------------------------------------------------------------------------
+Public Function Dispose() As Variant
+ Call Class_Terminate()
+ Set Dispose = Nothing
+End Function ' SFDatabases.SF_Datasheet Explicit Destructor
+
+REM ==================================================================
PROPERTIES
+
+REM
-----------------------------------------------------------------------------
+Property Get ColumnHeaders() As Variant
+''' Returns the list of column headers of the datasheet as
an array of strings
+ ColumnHeaders = _PropertyGet("ColumnHeaders")
+End Property ' SFDatabases.SF_Datasheet.ColumnHeaders
+
+REM
-----------------------------------------------------------------------------
+Property Get CurrentColumn() As String
+''' Returns the currently selected column by its name
+ CurrentColumn = _PropertyGet("CurrentColumn")
+End Property ' SFDatabases.SF_Datasheet.CurrentColumn
+
+REM
-----------------------------------------------------------------------------
+Property Get CurrentRow() As Long
+''' Returns the currently selected row by its number >= 1
+ CurrentRow = _PropertyGet("CurrentRow")
+End Property ' SFDatabases.SF_Datasheet.CurrentRow
+
+REM
-----------------------------------------------------------------------------
+Property Get LastRow() As Long
+''' Returns the total number of rows
+''' The process may imply to move the cursor to the last
available row.
+''' Afterwards the cursor is reset to the current row.
+ LastRow = _PropertyGet("LastRow")
+End Property ' SFDatabases.SF_Datasheet.LastRow
+
+REM
-----------------------------------------------------------------------------
+Property Get Source() As String
+''' Returns the source of the data: table name, query name
or sql statement
+ Source = _PropertyGet("Source")
+End Property ' SFDatabases.SF_Datasheet.Source
+
+REM
-----------------------------------------------------------------------------
+Property Get SourceType() As String
+''' Returns thetype of source of the data: TABLE, QUERY or
SQL
+ SourceType = _PropertyGet("SourceType")
+End Property ' SFDatabases.SF_Datasheet.SourceType
+
+REM
-----------------------------------------------------------------------------
+Property Get XComponent() As Object
+''' Returns the com.sun.star.lang.XComponent UNO object
representing the datasheet
+ XComponent = _PropertyGet("XComponent")
+End Property ' SFDocuments.SF_Document.XComponent
+
+REM
-----------------------------------------------------------------------------
+Property Get XControlModel() As Object
+''' Returns the com.sun.star.lang.XControl UNO object
representing the datasheet
+ XControlModel = _PropertyGet("XControlModel")
+End Property ' SFDocuments.SF_Document.XControlModel
+
+REM
-----------------------------------------------------------------------------
+Property Get XTabControllerModel() As Object
+''' Returns the com.sun.star.lang.XTabControllerModel UNO
object representing the datasheet
+ XTabControllerModel = _PropertyGet("XTabControllerModel")
+End Property ' SFDocuments.SF_Document.XTabControllerModel
+
+REM =====================================================================
METHODS
+
+REM
-----------------------------------------------------------------------------
+Public Sub Activate()
+''' Make the actual datasheet active
+''' Args:
+''' Returns:
+''' Examples:
+''' oSheet.Activate()
+
+Dim oContainer As Object ' com.sun.star.awt.XWindow
+Const cstThisSub = "SFDatabases.Datasheet.Activate"
+Const cstSubArgs = ""
+
+ If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
+
+Check:
+ SF_Utils._EnterFunction(cstThisSub, cstSubArgs)
+ If Not _IsStillAlive() Then GoTo Finally
+
+Try:
+ Set oContainer = _Component.Frame.ContainerWindow
+ With oContainer
+ If .isVisible() = False Then .setVisible(True)
+ .IsMinimized = False
+ .setFocus()
+ .toFront() ' Force window
change in Linux
+ Wait 1 ' Bypass
desynchro issue in Linux
+ End With
+
+Finally:
+ SF_Utils._ExitFunction(cstThisSub)
+ Exit Sub
+Catch:
+ GoTo Finally
+End Sub ' SFDatabases.SF_Datasheet.Activate
+
+REM
-----------------------------------------------------------------------------
+Public Function ApplyFilter(Optional ByVal Filter As Variant) As Boolean
+''' Apply the given filter to the actual datasheet
+''' Args:
+''' Filter: a SQL WHERE clause without the WHERE
keyword
+''' Table and field names may be surrounded
by square brackets
+''' When the argument is the zero-length
string or absent, the actual filter is removed
+''' Returns:
+''' True when successful
+''' Examples:
+'''
oSheet.ApplyFilter("[ShipCountry]='USA'")
+
+Dim bApply As Boolean ' Return value
+Dim sFilter As String ' Filter after
replacement of square brackets by real delimiter
+Const cstThisSub = "SFDatabases.Datasheet.ApplyFilter"
+Const cstSubArgs = "[Filter=""""]"
+
+ If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
+ bApply = False
+
+Check:
+ If IsMissing(Filter) Or IsEmpty(Filter) Then Filter = ""
+ If ScriptForge.SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
+ If Not _IsStillAlive() Then GoTo Finally
+ If Not ScriptForge.SF_Utils._Validate(Filter,
"Filter", V_STRING) Then GoTo Catch
+ End If
+
+Try:
+ With _TabControllerModel
+ If Len(Filter) > 0 Then
+ .Filter = _ParentDatabase._ReplaceSquareBrackets(Filter)
+ .ApplyFilter = True
+ .reload()
+ Else
+ .Filter = ""
+ .ApplyFilter = False
+ .reload()
+ End If
+ End With
+
+ bApply = True
+
+Finally:
+ ApplyFilter = bApply
+ SF_Utils._ExitFunction(cstThisSub)
+ Exit Function
+Catch:
+ GoTo Finally
+End Function ' SFDatabases.SF_Datasheet.ApplyFilter
+
+REM
-----------------------------------------------------------------------------
+Public Function CloseDatasheet() As Boolean
+''' Close the actual datasheet
+''' Args:
+''' Returns:
+''' True when successful
+''' Examples:
+''' oSheet.CloseDatasheet()
+
+Dim bClose As Boolean ' Return value
+Const cstThisSub = "SFDatabases.Datasheet.CloseDatasheet"
+Const cstSubArgs = ""
+
+ If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
+ bClose = False
+
+Check:
+ SF_Utils._EnterFunction(cstThisSub, cstSubArgs)
+ If Not _IsStillAlive() Then GoTo Finally
+
+Try:
+ _TabControllerModel.close()
+ _Frame.close(True)
+ _Frame.dispose()
+ Dispose()
+ bClose = True
+
+Finally:
+ CloseDatasheet = bClose
+ SF_Utils._ExitFunction(cstThisSub)
+ Exit Function
+Catch:
+ GoTo Finally
+End Function ' SFDatabases.SF_Datasheet.CloseDatasheet
+
+REM
-----------------------------------------------------------------------------
+Public Function GetProperty(Optional ByVal PropertyName As Variant) As Variant
+''' Return the actual value of the given property
+''' Args:
+''' PropertyName: the name of the property as a
string
+''' Returns:
+''' The actual value of the propRATTCerty
+''' If the property does not exist, returns Null
+
+Const cstThisSub = "SFDatabases.Datasheet.GetProperty"
+Const cstSubArgs = ""
+
+ If ScriptForge.SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
+ GetProperty = Null
+
+Check:
+ If ScriptForge.SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
+ If Not ScriptForge.SF_Utils._Validate(PropertyName,
"PropertyName", V_STRING, Properties()) Then GoTo Catch
+ End If
+
+Try:
+ GetProperty = _PropertyGet(PropertyName)
+
+Finally:
+ ScriptForge.SF_Utils._ExitFunction(cstThisSub)
+ Exit Function
+Catch:
+ GoTo Finally
+End Function ' SFDatabases.SF_Datasheet.GetProperty
+
+REM
-----------------------------------------------------------------------------
+Public Function GetText(Optional ByVal Column As Variant) As String
+''' Get the text in the given column of the current row.
+''' Args:
+''' Column: the name of the column as a string or
its position (>= 1). Default = the current column
+''' If the argument exceeds the
number of columns, the last column is selected.
+''' Returns:
+''' The text in the cell as a string as how it is
displayed
+''' Note that the position of the cursor is left
unchanged.
+''' Examples:
+''' oSheet.GeText("ShipCity")) '
Extract the text on the current row from the column "ShipCity"
+
+Dim sText As String ' Return Text
+Dim lCol As Long ' Numeric index
of Column in lists of columns
+Dim lMaxCol As Long ' Index of last column
+Const cstThisSub = "SFDatabases.Datasheet.GetText"
+Const cstSubArgs = "[Column=0]"
+
+ If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
+ sText = ""
+
+Check:
+ If IsMissing(Column) Or IsEmpty(Column) Then Column = 0
+ If ScriptForge.SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
+ If Not _IsStillAlive() Then GoTo Finally
+ If VarType(Column) <> V_STRING Then
+ If Not ScriptForge.SF_Utils._Validate(Column,
"Column", ScriptForge.V_NUMERIC) Then GoTo Catch
+ Else
+ If Not ScriptForge.SF_Utils._Validate(Column,
"Column", V_STRING, _ColumnHeaders) Then GoTo Catch
+ End If
+ End If
+
+Try:
+ ' Position the column - The index to be passed starts at 0
+ With _ControlView
+ If VarType(Column) = V_STRING Then
+ lCol = ScriptForge.SF_Array.IndexOf(_ColumnHeaders,
Column, CaseSensitive := False)
+ Else
+ lCol = -1
+ If Column >= 1 Then
+ lMaxCol = .Count - 1
+ If Column > lMaxCol + 1 Then lCol = lMaxCol
Else lCol = Column - 1
+ End If
+ End If
+
+ If lCol >= 0 Then sText = .getByIndex(lCol).Text
+ End With
+
+Finally:
+ GetText = sText
+ SF_Utils._ExitFunction(cstThisSub)
+ Exit Function
+Catch:
+ GoTo Finally
+End Function ' SFDatabases.SF_Datasheet.GetText
+
+REM
-----------------------------------------------------------------------------
+Public Function GetValue(Optional ByVal Column As Variant) As Variant
+''' Get the value in the given column of the current row.
+''' Args:
+''' Column: the name of the column as a string or
its position (>= 1). Default = the current column
+''' If the argument exceeds the
number of columns, the last column is selected.
+''' Returns:
+''' The value in the cell as a valid Basic type
+''' Typical types are: STRING, INTEGER, LONG,
FLOAT, DOUBLE, DATE, NULL
+''' Binary types are returned as a LONG giving
their length, not their content
+''' An EMPTY return value means that the value
could not be retrieved.
+''' Note that the position of the cursor is left
unchanged.
+''' Examples:
+''' oSheet.GeValue("ShipCity")) '
Extract the value on the current row from the column "ShipCity"
+
+Dim vValue As Variant ' Return value
+Dim lCol As Long ' Numeric index
of Column in lists of columns
+Dim lMaxCol As Long ' Index of last column
+Const cstThisSub = "SFDatabases.Datasheet.GetValue"
+Const cstSubArgs = "[Column=0]"
+
+ If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
+ vValue = Empty
+
+Check:
+ If IsMissing(Column) Or IsEmpty(Column) Then Column = 0
+ If ScriptForge.SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
+ If Not _IsStillAlive() Then GoTo Finally
+ If VarType(Column) <> V_STRING Then
+ If Not ScriptForge.SF_Utils._Validate(Column,
"Column", ScriptForge.V_NUMERIC) Then GoTo Catch
+ Else
+ If Not ScriptForge.SF_Utils._Validate(Column,
"Column", V_STRING, _ColumnHeaders) Then GoTo Catch
+ End If
+ End If
+
+Try:
+ ' Position the column - The index to be passed starts at 1
+ If VarType(Column) = V_STRING Then
+ lCol = ScriptForge.SF_Array.IndexOf(_ColumnHeaders, Column,
CaseSensitive := False) + 1
+ Else
+ lCol = 0
+ If Column >= 1 Then
+ lMaxCol = _ControlView.Count
+ If Column > lMaxCol Then lCol = lMaxCol Else lCol =
Column
+ End If
+ End If
+
+ ' The _TabControllerModel acts exactly as a result set, from
which the generic _GetColumnValue can extract the searched value
+ If lCol >= 1 Then vValue =
_ParentDatabase._GetColumnValue(_TabControllerModel, lCol)
+
+Finally:
+ GetValue = vValue
+ SF_Utils._ExitFunction(cstThisSub)
+ Exit Function
+Catch:
+ GoTo Finally
+End Function ' SFDatabases.SF_Datasheet.GetValue
+
+REM
-----------------------------------------------------------------------------
+Public Function GoToCell(Optional ByVal Row As Variant _
+ , Optional ByVal Column
As Variant _
+ ) As Boolean
+''' Set the cursor on the given row and the given column.
+''' If the requested row exceeds the number of available
rows, the cursor is set on the last row.
+''' If the requested column exceeds the number of available
columns, the selected column is the last one.
+''' Args:
+''' Row: the row number (>= 1) as a numeric
value. Default= no change
+''' Column: the name of the column as a string or
its position (>= 1). Default = the current column
+''' Returns:
+''' True when successful
+''' Examples:
+''' oSheet.GoToCell(1000000, "ShipCity"))
' Set the cursor on he last row, column "ShipCity"
+
+Dim bGoTo As Boolean ' Return value
+Dim lCol As Long ' Numercic index
of Column in lists of columns
+Dim lMaxCol As Long ' Index of last column
+Const cstThisSub = "SFDatabases.Datasheet.GoToCell"
+Const cstSubArgs = "[Row=0], [Column=0]"
+
+ If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
+ bGoTo = False
+
+Check:
+ If IsMissing(Row) Or IsEmpty(Row) Then Row = 0
+ If IsMissing(Column) Or IsEmpty(Column) Then Column = 0
+ If ScriptForge.SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
+ If Not _IsStillAlive() Then GoTo Finally
+ If Not ScriptForge.SF_Utils._Validate(Row, "Row",
ScriptForge.V_NUMERIC) Then GoTo Catch
+ If VarType(Column) <> V_STRING Then
+ If Not ScriptForge.SF_Utils._Validate(Column,
"Column", ScriptForge.V_NUMERIC) Then GoTo Catch
+ Else
+ If Not ScriptForge.SF_Utils._Validate(Column,
"Column", V_STRING, _ColumnHeaders) Then GoTo Catch
+ End If
+ End If
+
+Try:
+ ' Position the row
+ With _TabControllerModel
+ If Row <= 0 Then Row = .Row Else .absolute(Row)
+ ' Does Row exceed the total number of rows ?
+ If .IsRowCountFinal And Row > .RowCount Then
.absolute(.RowCount)
+ End With
+
+ ' Position the column
+ With _ControlView
+ If VarType(Column) = V_STRING Then
+ lCol = ScriptForge.SF_Array.IndexOf(_ColumnHeaders,
Column, CaseSensitive := False)
+ Else
+ lCol = -1
+ If Column >= 1 Then
+ lMaxCol = .Count - 1
+ If Column > lMaxCol + 1 Then lCol = lMaxCol
Else lCol = Column - 1
+ End If
+ End If
+ If lCol >= 0 Then .setCurrentColumnPosition(lCol)
+ End With
+
+ bGoTo = True
+
+Finally:
+ GoToCell = bGoTo
+ SF_Utils._ExitFunction(cstThisSub)
+ Exit Function
+Catch:
+ GoTo Finally
+End Function ' SFDatabases.SF_Datasheet.GoToCell
+
+REM
-----------------------------------------------------------------------------
+Public Function Methods() As Variant
+''' Return the list of public methods of the Model service
as an array
+
+ Methods = Array( _
+ "Activate" _
+ , "ApplyFilter" _
+ , "CloseDatasheet" _
+ , "GetText" _
+ , "GetValue" _
+ , "GoToCell" _
+ , "OrderBy" _
+ )
+
+End Function ' SFDatabases.SF_Datasheet.Methods
+
+REM
-----------------------------------------------------------------------------
+Public Function OrderBy(Optional ByVal Order As Variant) As Boolean
+''' Sort the actual datasheet based on the given ordering
instructions
+''' Args:
+''' Order: a SQL ORDER BY clause without the ORDER
BY keywords
+''' Table and field names may be surrounded
by square brackets
+''' When the argument is the zero-length
string or absent, the actual sort is removed
+''' Returns:
+''' True when successful
+''' Examples:
+''' oSheet.OrderBy("[ShipCountry] DESC,
[EmployeeID]")
+
+Dim bOrder As Boolean ' Return value
+Dim sOrder As String ' Order after replacement
of square brackets by real delimiter
+Const cstThisSub = "SFDatabases.Datasheet.OrderBy"
+Const cstSubArgs = "[Order=""""]"
+
+ If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
+ bOrder = False
+
+Check:
+ If IsMissing(Order) Or IsEmpty(Order) Then Order = ""
+ If ScriptForge.SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
+ If Not _IsStillAlive() Then GoTo Finally
+ If Not ScriptForge.SF_Utils._Validate(Order, "Order",
V_STRING) Then GoTo Catch
+ End If
+
+Try:
+ With _TabControllerModel
+ If Len(Order) > 0 Then
+ .Order = _ParentDatabase._ReplaceSquareBrackets(Order)
+ .ApplyFilter = True
+ .reload()
+ Else
+ .Order = ""
+ .ApplyFilter = False
+ .reload()
+ End If
+ End With
+
+ bOrder = True
+
+Finally:
+ OrderBy = bOrder
+ SF_Utils._ExitFunction(cstThisSub)
+ Exit Function
+Catch:
+ GoTo Finally
+End Function ' SFDatabases.SF_Datasheet.OrderBy
+
+REM
-----------------------------------------------------------------------------
+Public Function Properties() As Variant
+''' Return the list or properties of the Model class as an
array
+
+ Properties = Array( _
+ "ColumnHeaders" _
+ , "CurrentColumn" _
+ , "CurrentRow" _
+ , "LastRow" _
+ , "Source" _
+ , "SourceType" _
+ , "XComponent" _
+ , "XControlModel" _
+ , "XTabControllerModel" _
+ )
+
+End Function ' SFDatabases.SF_Datasheet.Properties
+
+REM =========================================================== PRIVATE
FUNCTIONS
+
+REM
-----------------------------------------------------------------------------
+Public Sub _Initialize()
+''' Called immediately after instance creation to complete
the initial values
+''' An eventual error must be trapped in the calling
routine to cancel the instance creation
+
+Dim iType As Integer ' One of the
com.sun.star.sdb.CommandType constants
+Dim oColumn As Object ' A single column
+Dim oColumnDescriptor As Object ' A single column descriptor
+Dim i As Long
+
+Try:
+ _ParentType = [_Parent].ObjectType
+
+ With _Component
+ ' The existence of _Component.Selection must be checked
upfront
+ _Command = ScriptForge.SF_Utils._GetPropertyValue(.Selection,
"Command")
+
+ iType = ScriptForge.SF_Utils._GetPropertyValue(.Selection,
"CommandType")
+ Select Case iType
+ Case com.sun.star.sdb.CommandType.TABLE :
_SheetType = "TABLE"
+ Case com.sun.star.sdb.CommandType.QUERY :
_SheetType = "QUERY"
+ Case com.sun.star.sdb.CommandType.COMMAND :
_SheetType = "SQL"
+ End Select
+
+ _BaseFileName =
ScriptForge.SF_Utils._GetPropertyValue(.Selection, "DataSourceName")
+ _DirectSql = Not
ScriptForge.SF_Utils._GetPropertyValue(.Selection, "EscapeProcessing")
+
+ ' Useful UNO objects
+ Set _Frame = .Frame
+ Set _ControlView = .CurrentControl
+ Set _TabControllerModel =
.com_sun_star_awt_XTabController_getModel
+ Set _ControlModel = _ControlView.getModel()
+
+ ' Retrieve the parent database instance
+ Select Case [_Parent].ObjectType
+ Case "BASE"
+ With _TabControllerModel
+ Set _ParentDatabase =
[_Parent].GetDatabase(.User, .Password)
+ End With
+ Set _ParentBase = [_Parent]
+ Case "DATABASE"
+ Set _ParentDatabase = [_Parent]
+ Set _ParentBase = Nothing
+ End Select
+
+ ' Load column headers
+ _ColumnHeaders =
_TabControllerModel.getColumns().getElementNames()
+
+ End With
+
+Finally:
+ Exit Sub
+End Sub ' SFDatabases.SF_Datasheet._Initialize
+
+
' or Nothing when opened manually from the user interface
+REM
-----------------------------------------------------------------------------
+Private Function _IsStillAlive(Optional ByVal pbError As Boolean) As Boolean
+''' Returns True if the datasheet has not been closed
manually or incidentally since the last use
+''' If dead the actual instance is disposed. The execution
is cancelled when pbError = True (default)
+''' Args:
+''' pbError: if True (default), raise a fatal error
+
+Dim bAlive As Boolean ' Return value
+Dim sName As String ' Used in error message
+
+ On Local Error GoTo Catch ' Anticipate
DisposedException errors or alike
+ If IsMissing(pbError) Then pbError = True
+
+Try:
+ ' Check existence of datasheet
+ bAlive = Not IsNull(_Component.ComponentWindow)
+
+Finally:
+ If pbError And Not bAlive Then
+ sName = _Command
+ Dispose()
+ If pbError Then
ScriptForge.SF_Exception.RaiseFatal(DOCUMENTDEADERROR, sName)
+ End If
+ _IsStillAlive = bAlive
+ Exit Function
+Catch:
+ bAlive = False
+ On Error GoTo 0
+ GoTo Finally
+End Function ' SFDatabases.SF_Datasheet._IsStillAlive
+
+REM
-----------------------------------------------------------------------------
+Private Function _PropertyGet(Optional ByVal psProperty As String) As Variant
+''' Return the value of the named property
+''' Args:
+''' psProperty: the name of the property
+
+Dim lRow As Long ' Actual row number
+Dim cstThisSub As String
+Const cstSubArgs = ""
+
+ cstThisSub = "SFDatabases.Datasheet.get" & psProperty
+ If ScriptForge.SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
+
+ ScriptForge.SF_Utils._EnterFunction(cstThisSub, cstSubArgs)
+ If Not _IsStillAlive(False) Then GoTo Finally
+
+ Select Case psProperty
+ Case "ColumnHeaders"
+
' or Nothing when opened manually from the user interface
+
+
' or Nothing when opened manually from the user interface
+ _PropertyGet = _ColumnHeaders
+ Case "CurrentColumn"
+ _PropertyGet =
_ColumnHeaders(_ControlView.getCurrentColumnPosition())
+ Case "CurrentRow"
+ _PropertyGet = _TabControllerModel.Row
+ Case "LastRow"
+ With _TabControllerModel
+ If .IsRowCountFinal Then
+ _PropertyGet = .RowCount
+ Else
+ lRow = .Row
+ If lRow > 0 Then
+ .last()
+ _PropertyGet = .RowCount
+ .absolute(lRow)
+ Else
+ _PropertyGet = 0
+ End If
+ End If
+ End With
+ Case "Source"
+ _PropertyGet = _Command
+ Case "SourceType"
+ _PropertyGet = _SheetType
+ Case "XComponent"
+ Set _PropertyGet = _Component
+ Case "XControlModel"
+ Set _PropertyGet = _ControlModel
+ Case "XTabControllerModel"
+ Set _PropertyGet = _TabControllerModel
+ Case Else
+ _PropertyGet = Null
+ End Select
+
+Finally:
+ ScriptForge.SF_Utils._ExitFunction(cstThisSub)
+ Exit Function
+Catch:
+ GoTo Finally
+End Function ' SFDatabases.SF_Datasheet._PropertyGet
+
+REM
-----------------------------------------------------------------------------
+Private Function _Repr() As String
+''' Convert the Datasheet instance to a readable string,
typically for debugging purposes (DebugPrint ...)
+''' Args:
+''' Return:
+''' "[DATASHEET]: A readable string"
+
+ _Repr = "[DATASHEET]: A readable string"
+
+End Function ' SFDatabases.SF_Datasheet._Repr
+
+REM ============================================ END OF
SFDATABASES.SF_DATASHEET
+</script:module>
\ No newline at end of file
diff --git a/wizards/source/sfdatabases/SF_Register.xba
b/wizards/source/sfdatabases/SF_Register.xba
index c9b3f03d7334..25d41e99718a 100644
--- a/wizards/source/sfdatabases/SF_Register.xba
+++ b/wizards/source/sfdatabases/SF_Register.xba
@@ -46,6 +46,7 @@ Public Sub RegisterScriptServices() As Variant
With GlobalScope.ScriptForge.SF_Services
.RegisterService("Database",
"SFDatabases.SF_Register._NewDatabase") '
Reference to the function initializing the service
.RegisterService("DatabaseFromDocument",
"SFDatabases.SF_Register._NewDatabaseFromSource")
+ .RegisterService("Datasheet",
"SFDatabases.SF_Register._NewDatasheet")
End With
End Sub '
SFDatabases.SF_Register.RegisterScriptServices
@@ -55,7 +56,7 @@ REM
=========================================================== PRIVATE FUNCTION
REM
-----------------------------------------------------------------------------
Public Function _NewDatabase(Optional ByVal pvArgs As Variant) As Object
''' Create a new instance of the SF_Database class
-' Args:
+''' Args:
''' FileName : the name of the file (compliant with
the SF_FileSystem.FileNaming notation)
''' RegistrationName: mutually exclusive with
FileName. Used when database is registered
''' ReadOnly : (boolean). Default = True
@@ -140,7 +141,7 @@ Public Function _NewDatabaseFromSource(Optional ByVal
pvArgs As Variant) As Obje
''' Create a new instance of the SF_Database class from the
given datasource
''' established in the SFDocuments.Base service
''' THIS SERVICE MUST NOT BE CALLED FROM A USER SCRIPT
-' Args:
+''' Args:
''' DataSource: com.sun.star.sdbc.XDataSource
''' User, Password : connection parameters
''' Returns:
@@ -191,5 +192,58 @@ Catch:
GoTo Finally
End Function ' SFDatabases.SF_Register._NewDatabaseFromSource
+REM
-----------------------------------------------------------------------------
+Public Function _NewDatasheet(Optional ByVal pvArgs As Variant) As Object
+' Optional ByRef
poParent As Object _
+' , Optional
ByRef poComponent As Object _
+' ) As Object
+''' Create a new instance of the SF_Datasheet class
+''' Called from (internal calls only)
+''' base.Datasheets()
+''' base.OpenTable()
+''' base.OpenQuery()
+''' database.OpenTable()
+''' database.OpenQuery()
+''' database.OpenSql()
+''' Args:
+''' Parent: the parent SF_Database or SF_Base
instance having produced the new datasheet
+''' Component: the component of the new
datasheet
+'''
com.sun.star.lang.XComponent - org.openoffice.comp.dbu.ODatasourceBrowser
+''' Returns:
+''' The instance or Nothing
+
+Dim oDatasheet As Object ' Return value
+Dim oParent As Object ' The parent SF_Database or
SF_Base instance having produced the new datasheet
+Dim oComponent As Object ' The component of the new
datasheet
+
+ If ScriptForge.SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
+ Set oDatasheet = Nothing
+
+Check:
+ ' Get arguments
+ If UBound(pvArgs) <> 1 Then GoTo Catch
+ Set oParent = pvArgs(0)
+ Set oComponent = pvArgs(1)
+ If IsNull(oParent) Or IsNull(oComponent) Then GoTo Catch
+ If IsEmpty(oComponent.Selection) Then GoTo Catch
+
+Try:
+ Set oDatasheet = New SF_Datasheet
+ With oDatasheet
+ Set .[Me] = oDatasheet
+ Set .[_Parent] = oParent
+ Set ._Component = oComponent
+ ' Achieve the initialization
+ ._Initialize()
+ End With
+
+Finally:
+ Set _NewDatasheet = oDatasheet
+ Exit Function
+Catch:
+ Set oDatasheet = Nothing
+ GoTo Finally
+End Function ' SFDatabases.SF_Register._NewDatasheet
+
REM ============================================== END OF
SFDATABASES.SF_REGISTER
</script:module>
\ No newline at end of file
diff --git a/wizards/source/sfdatabases/script.xlb
b/wizards/source/sfdatabases/script.xlb
index 6cea80d2a912..15d7cbdbe978 100644
--- a/wizards/source/sfdatabases/script.xlb
+++ b/wizards/source/sfdatabases/script.xlb
@@ -4,4 +4,5 @@
<library:element library:name="SF_Register"/>
<library:element library:name="__License"/>
<library:element library:name="SF_Database"/>
+ <library:element library:name="SF_Datasheet"/>
</library:library>
\ No newline at end of file
diff --git a/wizards/source/sfdialogs/SF_Dialog.xba
b/wizards/source/sfdialogs/SF_Dialog.xba
index 486e90ef71dd..507e5ac72c00 100644
--- a/wizards/source/sfdialogs/SF_Dialog.xba
+++ b/wizards/source/sfdialogs/SF_Dialog.xba
@@ -1083,7 +1083,7 @@ Try:
Next sControlName
vRadioList = ScriptForge.SF_Array.SortRows(vRadioList, 1)
- ' Retain continuous tav indexes
+ ' Retain contiguous tab indexes
For i = 1 To UBound(vRadioList, 1) ' First row = argument
If vRadioList(i, 1) = iRadioTabIndex + i Then sList = sList
& cstComma & vRadioList(i, 0)
Next i
@@ -1481,4 +1481,4 @@ Private Function _Repr() As String
End Function ' SFDialogs.SF_Dialog._Repr
REM ============================================ END OF SFDIALOGS.SF_DIALOG
-</script:module>
+</script:module>
\ No newline at end of file
diff --git a/wizards/source/sfdocuments/SF_Base.xba
b/wizards/source/sfdocuments/SF_Base.xba
index 1e6395dbfa2c..81afacc7bbda 100644
--- a/wizards/source/sfdocuments/SF_Base.xba
+++ b/wizards/source/sfdocuments/SF_Base.xba
@@ -459,7 +459,7 @@ Public Function OpenFormDocument(Optional ByVal
FormDocument As Variant _
''' Open the FormDocument given by its hierarchical name
either in normal or in design mode
''' If the form document is already open, the form document
is made active without changing its mode
''' Args:
-''' FormDocument: a valid document form name as a
case-sensitive string
+''' FormDocument: a valid form document name as a
case-sensitive string
''' DesignMode: when True the form document is
opened in design mode (Default = False)
''' Returns:
''' True if the form document could be opened,
otherwise False
@@ -509,6 +509,111 @@ Catch:
GoTo Finally
End Function ' SFDocuments.SF_Base.OpenFormDocument
+REM
-----------------------------------------------------------------------------
+Public Function OpenQuery(Optional ByVal QueryName As Variant _
+ ,
Optional ByVal DesignMode As Variant _
+ ) As
Object
+''' Open the query given by its name either in normal or in
design mode
+''' If the query is already open, the query datasheet is
made active without changing its mode
+''' If still open, the datasheet will be closed together
with the actual Base document.
+''' Args:
+''' QueryName: a valid Query name as a
case-sensitive string
+''' DesignMode: when True the query is opened in
design mode (Default = False)
+''' Returns:
+''' A Datasheet class instance if the query could
be opened and DesignMode = False, otherwise False
+''' Exceptions:
+''' Query name is invalid
+''' Example:
+''' oDoc.OpenQuery("myQuery", DesignMode
:= False)
+
+Dim oOpen As Object ' Return value
+Dim vQueries As Variant ' Array of query
names
+Dim oNewQuery As Object ' Output of
loadComponent()
+Const cstThisSub = "SFDocuments.Base.OpenQuery"
+Const cstSubArgs = "QueryName, [DesignMode=False]"
+
+ If ScriptForge.SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
+ Set oOpen = Nothing
+
+Check:
+ If IsMissing(DesignMode) Or IsEmpty(DesignMode) Then DesignMode = False
+ vQueries = GetDatabase().Queries ' Includes _IsStillAlive()
+ If ScriptForge.SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
+ If Not ScriptForge.SF_Utils._Validate(QueryName,
"QueryName", V_STRING, vQueries) Then GoTo Finally
+ If Not ScriptForge.SF_Utils._Validate(DesignMode,
"DesignMode", ScriptForge.V_BOOLEAN) Then GoTo Finally
+ End If
+
+Try:
+ With _Component.CurrentController
+ ' The connection may have been done previously by a user
commmand. If not, do it now.
+ If Not .IsConnected Then .connect()
+ ' loadComponent activates the query component when
already loaded
+ Set oNewQuery =
.loadComponent(com.sun.star.sdb.application.DatabaseObject.QUERY, QueryName,
DesignMode)
+ End With
+ ' When design mode, the method returns Nothing
+ If Not DesignMode Then Set oOpen =
ScriptForge.SF_Services.CreateScriptService("SFDatabases.Datasheet",
[Me], oNewQuery)
+
+Finally:
+ Set OpenQuery = oOpen
+ ScriptForge.SF_Utils._ExitFunction(cstThisSub)
+ Exit Function
+Catch:
+ GoTo Finally
+End Function ' SFDocuments.SF_Base.OpenQuery
+
+REM
-----------------------------------------------------------------------------
+Public Function OpenTable(Optional ByVal TableName As Variant _
+ ,
Optional ByVal DesignMode As Variant _
+ ) As
Object
+''' Open the table given by its name either in normal or in
design mode
+''' If the table is already open, the table datasheet is
made active without changing its mode
+''' If still open, the datasheet will be closed together
with the actual Base document.
+''' Args:
+''' TableName: a valid table name as a
case-sensitive string
+''' DesignMode: when True the table is opened in
design mode (Default = False)
+''' Returns:
+''' A Datasheet class instance if the table could
be opened or was already open, and DesignMode = False.
+''' Otherwise Nothing
+''' Exceptions:
+''' Table name is invalid
+''' Example:
+''' oDoc.OpenTable("myTable", DesignMode
:= False)
+
+Dim oOpen As Object ' Return value
+Dim vTables As Variant ' Array of table names
+Dim oNewTable As Object ' Output of
loadComponent()
+Const cstThisSub = "SFDocuments.Base.OpenTable"
+Const cstSubArgs = "TableName, [DesignMode=False]"
+
+ If ScriptForge.SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
+ Set oOpen = Nothing
+
+Check:
+ If IsMissing(DesignMode) Or IsEmpty(DesignMode) Then DesignMode = False
+ vTables = GetDatabase().Tables
+ If ScriptForge.SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
+ If Not ScriptForge.SF_Utils._Validate(TableName,
"TableName", V_STRING, vTables) Then GoTo Finally
+ If Not ScriptForge.SF_Utils._Validate(DesignMode,
"DesignMode", ScriptForge.V_BOOLEAN) Then GoTo Finally
+ End If
+
+Try:
+ With _Component.CurrentController
+ ' The connection may have been done previously by a user
commmand. If not, do it now.
+ If Not .IsConnected Then .connect()
+ ' loadComponent activates the table component when
already loaded
+ Set oNewTable =
.loadComponent(com.sun.star.sdb.application.DatabaseObject.TABLE, TableName,
DesignMode)
+ End With
+ ' When design mode, the method returns Nothing
+ If Not DesignMode Then Set oOpen =
ScriptForge.SF_Services.CreateScriptService("SFDatabases.Datasheet",
[Me], oNewTable)
+
+Finally:
+ Set OpenTable = oOpen
+ ScriptForge.SF_Utils._ExitFunction(cstThisSub)
+ Exit Function
+Catch:
+ GoTo Finally
+End Function ' SFDocuments.SF_Base.OpenTable
+
REM
-----------------------------------------------------------------------------
Public Function PrintOut(Optional ByVal FormDocument As Variant _
, Optional ByVal Pages
As Variant _
diff --git a/wizards/source/sfdocuments/SF_Calc.xba
b/wizards/source/sfdocuments/SF_Calc.xba
index e32dab652166..0733be07eb6a 100644
--- a/wizards/source/sfdocuments/SF_Calc.xba
+++ b/wizards/source/sfdocuments/SF_Calc.xba
@@ -401,7 +401,7 @@ Finally:
Exit Function
Catch:
GoTo Finally
-End Function ' SF_Documents.SF_Calc.A1Style
+End Function ' SFDocuments.SF_Calc.A1Style
REM
-----------------------------------------------------------------------------
Public Function Activate(Optional ByVal SheetName As Variant) As Boolean
@@ -560,7 +560,7 @@ Public Sub ClearAll(Optional ByVal Range As Variant _
_ClearRange("All", Range, FilterFormula, FilterScope)
-End Sub ' SF_Documents.SF_Calc.ClearAll
+End Sub ' SFDocuments.SF_Calc.ClearAll
REM
-----------------------------------------------------------------------------
Public Sub ClearFormats(Optional ByVal Range As Variant _
@@ -580,7 +580,7 @@ Public Sub ClearFormats(Optional ByVal Range As Variant _
_ClearRange("Formats", Range, FilterFormula, FilterScope)
-End Sub ' SF_Documents.SF_Calc.ClearFormats
+End Sub ' SFDocuments.SF_Calc.ClearFormats
REM
-----------------------------------------------------------------------------
Public Sub ClearValues(Optional ByVal Range As Variant _
@@ -600,7 +600,7 @@ Public Sub ClearValues(Optional ByVal Range As Variant _
_ClearRange("Values", Range, FilterFormula, FilterScope)
-End Sub ' SF_Documents.SF_Calc.ClearValues
+End Sub ' SFDocuments.SF_Calc.ClearValues
REM
-----------------------------------------------------------------------------
Public Function CompactLeft(Optional ByVal Range As Variant _
@@ -1424,7 +1424,7 @@ Try:
Finally:
Exit Function
-End Function ' SF_Documents.SF_Calc.DAvg
+End Function ' SFDocuments.SF_Calc.DAvg
REM
-----------------------------------------------------------------------------
Public Function DCount(Optional ByVal Range As Variant) As Long
@@ -1441,7 +1441,7 @@ Try:
Finally:
Exit Function
-End Function ' SF_Documents.SF_Calc.DCount
+End Function ' SFDocuments.SF_Calc.DCount
REM
-----------------------------------------------------------------------------
Public Function DMax(Optional ByVal Range As Variant) As Double
@@ -1458,7 +1458,7 @@ Try:
Finally:
Exit Function
-End Function ' SF_Documents.SF_Calc.DMax
+End Function ' SFDocuments.SF_Calc.DMax
REM
-----------------------------------------------------------------------------
Public Function DMin(Optional ByVal Range As Variant) As Double
@@ -1475,7 +1475,7 @@ Try:
Finally:
Exit Function
-End Function ' SF_Documents.SF_Calc.DMin
+End Function ' SFDocuments.SF_Calc.DMin
REM
-----------------------------------------------------------------------------
Public Function DSum(Optional ByVal Range As Variant) As Double
@@ -1492,7 +1492,7 @@ Try:
Finally:
Exit Function
-End Function ' SF_Documents.SF_Calc.DSum
+End Function ' SFDocuments.SF_Calc.DSum
REM
-----------------------------------------------------------------------------
Public Function ExportRangeToFile(Optional ByVal Range As Variant _
@@ -1754,7 +1754,7 @@ Finally:
Exit Function
Catch:
GoTo Finally
-End Function ' SF_Documents.SF_Calc.GetFormula
+End Function ' SFDocuments.SF_Calc.GetFormula
REM
-----------------------------------------------------------------------------
Public Function GetProperty(Optional ByVal PropertyName As Variant _
@@ -1839,7 +1839,7 @@ Finally:
Exit Function
Catch:
GoTo Finally
-End Function ' SF_Documents.SF_Calc.GetValue
+End Function ' SFDocuments.SF_Calc.GetValue
REM
-----------------------------------------------------------------------------
Public Function ImportFromCSVFile(Optional ByVal FileName As Variant _
@@ -2300,7 +2300,7 @@ Finally:
Exit Function
Catch:
GoTo Finally
-End Function ' SF_Documents.SF_Calc.Offset
+End Function ' SFDocuments.SF_Calc.Offset
REM
-----------------------------------------------------------------------------
Public Function OpenRangeSelector(Optional ByVal Title As Variant _
@@ -2381,7 +2381,7 @@ Finally:
Exit Function
Catch:
GoTo Finally
-End Function ' SF_Documents.SF_Calc.OpenRangeSelector
+End Function ' SFDocuments.SF_Calc.OpenRangeSelector
REM
-----------------------------------------------------------------------------
Public Function Printf(Optional ByVal InputStr As Variant _
@@ -2478,7 +2478,7 @@ Finally:
Exit Function
Catch:
GoTo Finally
-End Function ' SF_Documents.SF_Calc.Printf
+End Function ' SFDocuments.SF_Calc.Printf
REM
-----------------------------------------------------------------------------
Public Function PrintOut(Optional ByVal SheetName As Variant _
@@ -2711,7 +2711,7 @@ Finally:
Exit Function
Catch:
GoTo Finally
-End Function ' SF_Documents.SF_Calc.SetArray
+End Function ' SFDocuments.SF_Calc.SetArray
REM
-----------------------------------------------------------------------------
Public Function SetCellStyle(Optional ByVal TargetRange As Variant _
@@ -2789,7 +2789,7 @@ Finally:
Exit Function
Catch:
GoTo Finally
-End Function ' SF_Documents.SF_Calc.SetCellStyle
+End Function ' SFDocuments.SF_Calc.SetCellStyle
REM
-----------------------------------------------------------------------------
Public Function SetFormula(Optional ByVal TargetRange As Variant _
@@ -2858,7 +2858,7 @@ Finally:
Exit Function
Catch:
GoTo Finally
-End Function ' SF_Documents.SF_Calc.SetFormula
+End Function ' SFDocuments.SF_Calc.SetFormula
REM
-----------------------------------------------------------------------------
Private Function SetProperty(Optional ByVal psProperty As String _
@@ -2966,7 +2966,7 @@ Finally:
Exit Function
Catch:
GoTo Finally
-End Function ' SF_Documents.SF_Calc.SetValue
+End Function ' SFDocuments.SF_Calc.SetValue
REM
-----------------------------------------------------------------------------
Public Function ShiftDown(Optional ByVal Range As Variant _
@@ -3423,7 +3423,7 @@ Finally:
Exit Function
Catch:
GoTo Finally
-End Function ' SF_Documents.SF_Calc.SortRange
+End Function ' SFDocuments.SF_Calc.SortRange
REM ======================================================= SUPERCLASS
PROPERTIES
@@ -3685,7 +3685,7 @@ Finally:
Exit Sub
Catch:
GoTo Finally
-End Sub ' SF_Documents.SF_Calc._ClearRange
+End Sub ' SFDocuments.SF_Calc._ClearRange
REM
-----------------------------------------------------------------------------
Private Function _ComputeFilter(ByRef poRange As Object _
@@ -3853,7 +3853,7 @@ Try:
Finally:
_ConvertFromDataArray = vArray
-End Function ' SF_Documents.SF_Calc._ConvertFromDataArray
+End Function ' SFDocuments.SF_Calc._ConvertFromDataArray
REM
-----------------------------------------------------------------------------
Private Function _ConvertToCellValue(ByVal pvItem As Variant) As Variant
@@ -3873,7 +3873,7 @@ Try:
Finally:
_ConvertToCellValue = vCell
Exit Function
-End Function ' SF_Documents.SF_Calc._ConvertToCellValue
+End Function ' SFDocuments.SF_Calc._ConvertToCellValue
REM
-----------------------------------------------------------------------------
Private Function _ConvertToDataArray(ByRef pvArray As Variant _
@@ -3997,7 +3997,7 @@ Try:
Finally:
_ConvertToDataArray = vDataArray
Exit Function
-End Function ' SF_Documents.SF_Calc._ConvertToDataArray
+End Function ' SFDocuments.SF_Calc._ConvertToDataArray
REM
-----------------------------------------------------------------------------
Private Function _DFunction(ByVal psFunction As String _
@@ -4043,7 +4043,7 @@ Finally:
Exit Function
Catch:
GoTo Finally
-End Function ' SF_Documents.SF_Calc._DFunction
+End Function ' SFDocuments.SF_Calc._DFunction
REM
-----------------------------------------------------------------------------
Private Function _FileIdent() As String
@@ -4205,7 +4205,7 @@ CatchAddress:
, "Rows", plRows,
"Columns", plColumns, "Height", plHeight,
"Width", plWidth _
, "Document", [_Super]._FileIdent())
GoTo Finally
-End Function ' SF_Documents.SF_Calc._Offset
+End Function ' SFDocuments.SF_Calc._Offset
REM
-----------------------------------------------------------------------------
Private Function _ParseAddress(ByVal psAddress As String) As Object
diff --git a/wizards/source/sfdocuments/SF_Document.xba
b/wizards/source/sfdocuments/SF_Document.xba
index 30508f2e87b1..e537b90e5da1 100644
--- a/wizards/source/sfdocuments/SF_Document.xba
+++ b/wizards/source/sfdocuments/SF_Document.xba
@@ -864,7 +864,9 @@ Check:
' When called from a subclass (Calc, Writer, ..) the arguments
are gathered into one single array item
vArgs = Args
If IsArray(Args) Then
- If UBound(Args) >= 0 And IsArray(Args(0)) Then vArgs =
Args(0)
+ If UBound(Args) >= 0 Then
+ If IsArray(Args(0)) Then vArgs = Args(0)
+ End If
End If
If ScriptForge.SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
If Not _IsStillAlive() Then GoTo Finally
