1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
|
<?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_Base" script:language="StarBasic" script:moduleType="normal">REM =======================================================================================================================
REM === The ScriptForge library and its associated libraries are part of the LibreOffice project. ===
REM === The SFDocuments 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_Base
''' =======
'''
''' The SFDocuments library gathers a number of methods and properties making easy
''' the management and several manipulations of LibreOffice documents
'''
''' Some methods are generic for all types of documents: they are combined in the SF_Document module.
''' Specific properties and methods are implemented in the concerned subclass(es) SF_Calc, SF_Writer, ...
'''
''' To workaround the absence of class inheritance in LibreOffice Basic, some redundancy is necessary
''' Each subclass MUST implement also the generic methods and properties, even if they only call
''' the parent methods and properties.
''' They should also duplicate some generic private members as a subset of their own set of members
'''
''' The SF_Base module is provided mainly to block parent properties that are NOT applicable to Base documents
''' In addition, it provides methods to identify form documents and access their internal forms
''' (read more elsewhere (the "SFDocuments.Form" service) about this subject)
'''
''' The current module is closely related to the "UI" service of the ScriptForge library
'''
''' Service invocation examples:
''' 1) From the UI service
''' Dim ui As Object, oDoc As Object
''' Set ui = CreateScriptService("UI")
''' Set oDoc = ui.CreateBaseDocument("C:\Me\MyFile.odb", ...)
''' ' or Set oDoc = ui.OpenDocument("C:\Me\MyFile.odb")
''' 2) Directly if the document is already opened
''' Dim oDoc As Object
''' Set oDoc = CreateScriptService("SFDocuments.Base", "MyFile.odb")
''' ' The substring "SFDocuments." in the service name is optional
'''
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
REM ================================================================== EXCEPTIONS
Private Const DBCONNECTERROR = "DBCONNECTERROR"
Private Const FORMDEADERROR = "FORMDEADERROR"
Private Const BASEFORMNOTFOUNDERROR = "BASEFORMNOTFOUNDERROR"
REM ============================================================= PRIVATE MEMBERS
Private [Me] As Object
Private [_Parent] As Object
Private [_Super] As Object ' Document superclass, which the current instance is a subclass of
Private ObjectType As String ' Must be BASE
Private ServiceName As String
' UNO references
Private _Component As Object ' com.sun.star.comp.dba.ODatabaseDocument
Private _DataSource As Object ' com.sun.star.comp.dba.ODatabaseSource
Private _Database As Object ' SFDatabases.Database service instance
Private _FormDocuments As Object
REM ============================================================ MODULE CONSTANTS
Const ISBASEFORM = 3 ' Form is stored in a Base document
Const cstToken = "//" ' Form names accept special characters but not slashes
REM ====================================================== CONSTRUCTOR/DESTRUCTOR
REM -----------------------------------------------------------------------------
Private Sub Class_Initialize()
Set [Me] = Nothing
Set [_Parent] = Nothing
Set [_Super] = Nothing
ObjectType = "BASE"
ServiceName = "SFDocuments.Base"
Set _Component = Nothing
Set _DataSource = Nothing
Set _Database = Nothing
Set _FormDocuments = Nothing
End Sub ' SFDocuments.SF_Base Constructor
REM -----------------------------------------------------------------------------
Private Sub Class_Terminate()
Call Class_Initialize()
End Sub ' SFDocuments.SF_Base Destructor
REM -----------------------------------------------------------------------------
Public Function Dispose() As Variant
If Not IsNull([_Super]) Then Set [_Super] = [_Super].Dispose()
Call Class_Terminate()
Set Dispose = Nothing
End Function ' SFDocuments.SF_Base Explicit Destructor
REM ================================================================== PROPERTIES
REM ===================================================================== METHODS
REM -----------------------------------------------------------------------------
Public Function CloseDocument(Optional ByVal SaveAsk As Variant) As Boolean
''' The closure of a Base document requires the closures of
''' 1) the connection => done in the CloseDatabase() method
''' 2) the data source
''' 3) the document itself => done in the superclass
Const cstThisSub = "SFDocuments.Base.CloseDocument"
Const cstSubArgs = "[SaveAsk=True]"
If ScriptForge.SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
Check:
If IsMissing(SaveAsk) Or IsEmpty(SaveAsk) Then SaveAsk = True
If ScriptForge.SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
If Not _IsStillAlive(True) Then GoTo Finally
If Not ScriptForge.SF_Utils._Validate(SaveAsk, "SaveAsk", V_BOOLEAN) Then GoTo Finally
End If
Try:
If Not IsNull(_Database) Then _Database.CloseDatabase()
If Not IsNull(_DataSource) Then _DataSource.dispose()
CloseDocument = [_Super].CloseDocument(SaveAsk)
Finally:
ScriptForge.SF_Utils._ExitFunction(cstThisSub)
Exit Function
Catch:
GoTo Finally
End Function ' SFDocuments.SF_Base.CloseDocument
REM -----------------------------------------------------------------------------
Public Function FormDocuments() As Variant
''' Return the list of the FormDocuments contained in the Base document
''' Args:
''' Returns:
''' A zero-base array of strings
''' Each entry is the full path name of a form document. The path separator is the slash ("/")
''' Example:
''' Dim myForm As Object, myList As Variant
''' myList = oDoc.FormDocuments()
Dim vFormNames As Variant ' Array of all form names present in the document
Const cstThisSub = "SFDocuments.Base.FormDocuments"
Const cstSubArgs = ""
If ScriptForge.SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
Check:
If ScriptForge.SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
If Not _IsStillAlive() Then GoTo Finally
End If
Try:
' Build list of available FormDocuments recursively with _CollectFormDocuments
If IsNull(_FormDocuments) Then Set _FormDocuments = _Component.getFormDocuments()
vFormNames = Split(_CollectFormDocuments(_FormDocuments), cstToken)
Finally:
FormDocuments = vFormNames
ScriptForge.SF_Utils._ExitFunction(cstThisSub)
Exit Function
Catch:
GoTo Finally
End Function ' SFDocuments.SF_Base.FormDocuments
REM -----------------------------------------------------------------------------
Public Function Forms(Optional ByVal FormDocument As Variant _
, Optional ByVal Form As Variant _
) As Variant
''' Return either
''' - the list of the Forms contained in the form document
''' - a SFDocuments.Form object based on its name or its index
''' Args:
''' FormDocument: a valid document form name as a case-sensitive string
''' Form: a form stored in the Base document given by its name or its index
''' When absent, the list of available forms is returned
''' To get the first (unique ?) form stored in the form document, set Form = 0
''' Returns:
''' A zero-base array of strings if Form is absent
''' An instance of the SF_Form class if Form exists
''' Exceptions:
''' FORMDEADERROR The form is not open
''' BASEFORMNOTFOUNDERROR FormDocument OK but Form not found
''' Example:
''' Dim myForm As Object, myList As Variant
''' myList = oDoc.Forms("Folder1/myFormDocument")
''' Set myForm = oDoc.Forms("Folder1/myFormDocument", 0)
Dim oForm As Object ' The new Form class instance
Dim oMainForm As Object ' com.sun.star.comp.sdb.Content
Dim oXForm As Object ' com.sun.star.form.XForm
Dim vFormDocuments As Variant ' Array of form documents
Dim vFormNames As Variant ' Array of form names
Dim oForms As Object ' Forms collection
Const cstDrawPage = 0 ' Only 1 drawpage in a Base document
Const cstThisSub = "SFDocuments.Base.Forms"
Const cstSubArgs = "FormDocument, [Form=""""]"
If ScriptForge.SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
Check:
If IsMissing(Form) Or IsEmpty(Form) Then Form = ""
If ScriptForge.SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
If Not _IsStillAlive() Then GoTo Finally
' Build list of available FormDocuments recursively with _CollectFormDocuments
If IsNull(_FormDocuments) Then Set _FormDocuments = _Component.getFormDocuments()
vFormDocuments = Split(_CollectFormDocuments(_FormDocuments), cstToken)
If Not ScriptForge.SF_Utils._Validate(FormDocument, "FormDocument", V_STRING, vFormDocuments) Then GoTo Finally
If Not ScriptForge.SF_Utils._Validate(Form, "Form", Array(V_STRING, ScriptForge.V_NUMERIC)) Then GoTo Finally
End If
If Not IsLoaded(FormDocument) Then GoTo CatchClosed
Try:
' Start from the form document and go down to forms
Set oMainForm = _FormDocuments.getByHierarchicalName(FormDocument)
Set oForms = oMainForm.Component.DrawPages(cstDrawPage).Forms
vFormNames = oForms.getElementNames()
If Len(Form) = 0 Then ' Return the list of valid form names
Forms = vFormNames
Else
If VarType(Form) = V_STRING Then ' Find the form by name
If Not ScriptForge.SF_Utils._Validate(Form, "Form", V_STRING, vFormNames) Then GoTo Finally
Set oXForm = oForms.getByName(Form)
Else ' Find the form by index
If Form < 0 Or Form >= oForms.Count Then GoTo CatchNotFound
Set oXForm = oForms.getByIndex(Form)
End If
' Create the new Form class instance
Set oForm = New SF_Form
With oForm
._Name = oXForm.Name
Set .[Me] = oForm
Set .[_Parent] = [Me]
._DrawPage = cstDrawPage
._FormDocumentName = FormDocument
Set ._MainForm = oMainForm
._FormType = ISBASEFORM
Set ._Form = oXForm
End With
Set Forms = oForm
End If
Finally:
ScriptForge.SF_Utils._ExitFunction(cstThisSub)
Exit Function
Catch:
GoTo Finally
CatchClosed:
ScriptForge.SF_Exception.RaiseFatal(FORMDEADERROR, FormDocument, _FileIdent())
CatchNotFound:
ScriptForge.SF_Exception.RaiseFatal(BASEFORMNOTFOUNDERROR, Form, FormDocument, _FileIdent())
End Function ' SFDocuments.SF_Base.Forms
REM -----------------------------------------------------------------------------
Public Function GetDatabase(Optional ByVal User As Variant _
, Optional ByVal Password As Variant _
) As Object
''' Returns a Database instance (service = SFDatabases.Database) giving access
''' to the execution of SQL commands on the database defined and/or stored in
''' the actual Base document
''' Args:
''' User, Password: the login parameters as strings. Defaults = ""
''' Returns:
''' A SFDatabases.Database instance or Nothing
''' Example:
''' Dim myDb As Object
''' Set myDb = oDoc.GetDatabase()
Const cstThisSub = "SFDocuments.Base.GetDatabase"
Const cstSubArgs = "[User=""""], [Password=""""]"
If ScriptForge.SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
Set GetDatabase = Nothing
Check:
If IsMissing(User) Or IsEmpty(User) Then User = ""
If IsMissing(Password) Or IsEmpty(Password) Then Password = ""
If ScriptForge.SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
If Not _IsStillAlive(True) Then GoTo Finally
If Not ScriptForge.SF_Utils._Validate(User, "User", V_STRING) Then GoTo Finally
If Not ScriptForge.SF_Utils._Validate(Password, "Password", V_STRING) Then GoTo Finally
End If
Try:
If IsNull(_Database) Then ' 1st connection from the current document instance
If IsNull(_DataSource) Then GoTo CatchConnect
Set _Database = ScriptForge.SF_Services.CreateScriptService("SFDatabases.DatabaseFromDocument" _
, _DataSource, User, Password)
If IsNull(_Database) Then GoTo CatchConnect
_Database._Location = [_Super]._WindowFileName
EndIf
Finally:
Set GetDatabase = _Database
ScriptForge.SF_Utils._ExitFunction(cstThisSub)
Exit Function
Catch:
GoTo Finally
CatchConnect:
ScriptForge.SF_Exception.RaiseFatal(DBCONNECTERROR, "User", User, "Password", Password, [_Super]._FileIdent())
GoTo Finally
End Function ' SFDocuments.SF_Base.GetDatabase
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 property
''' Exceptions:
''' ARGUMENTERROR The property does not exist
Const cstThisSub = "SFDocuments.Base.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:
' Superclass or subclass property ?
If ScriptForge.SF_Array.Contains([_Super].Properties(), PropertyName) Then
GetProperty = [_Super].GetProperty(PropertyName)
Else
GetProperty = _PropertyGet(PropertyName)
End If
Finally:
ScriptForge.SF_Utils._ExitFunction(cstThisSub)
Exit Function
Catch:
GoTo Finally
End Function ' SFDocuments.SF_Base.GetProperty
REM -----------------------------------------------------------------------------
Public Function IsLoaded(Optional ByVal FormDocument As Variant) As Boolean
''' Return True if the given FormDocument is open for the user
''' Args:
''' FormDocument: a valid document form name as a case-sensitive string
''' Returns:
''' True if the form document is currently open, otherise False
''' Exceptions:
''' Form is invalid
''' Example:
''' MsgBox oDoc.IsLoaded("Folder1/myFormDocument")
Dim bLoaded As Boolean ' Return value
Dim vFormNames As Variant ' Array of all document form names present in the document
Dim oMainForm As Object ' com.sun.star.comp.sdb.Content
Const cstThisSub = "SFDocuments.Base.IsLoaded"
Const cstSubArgs = "FormDocument"
If ScriptForge.SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
bLoaded = False
Check:
If ScriptForge.SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
If Not _IsStillAlive() Then GoTo Finally
' Build list of available FormDocuments recursively with _CollectFormDocuments
If IsNull(_FormDocuments) Then Set _FormDocuments = _Component.getFormDocuments()
vFormNames = Split(_CollectFormDocuments(_FormDocuments), cstToken)
If Not ScriptForge.SF_Utils._Validate(FormDocument, "FormDocument", V_STRING, vFormNames) Then GoTo Finally
End If
Try:
Set oMainForm = _FormDocuments.getByHierarchicalName(FormDocument)
' A document form that has never been opened has no component
' If ever opened and closed afterwards, it keeps the Component but loses its Controller
bLoaded = Not IsNull(oMainForm.Component)
If bLoaded Then bLoaded = Not IsNull(oMainForm.Component.CurrentController)
Finally:
IsLoaded = bLoaded
ScriptForge.SF_Utils._ExitFunction(cstThisSub)
Exit Function
Catch:
GoTo Finally
End Function ' SFDocuments.SF_Base.IsLoaded
REM -----------------------------------------------------------------------------
Public Function Methods() As Variant
''' Return the list of public methods of the Model service as an array
Methods = Array( _
"Activate" _
, "CloseDocument" _
, "FormDocuments" _
, "Forms" _
, "GetDatabase" _
, "RunCommand" _
, "Save" _
, "SaveAs" _
, "SaveCopyAs" _
)
End Function ' SFDocuments.SF_Base.Methods
REM -----------------------------------------------------------------------------
Public Function Properties() As Variant
''' Return the list or properties of the Timer class as an array
Properties = Array( _
"DocumentType" _
, "IsBase" _
, "IsCalc" _
, "IsDraw " _
, "IsImpress" _
, "IsMath" _
, "IsWriter" _
, "XComponent" _
)
End Function ' SFDocuments.SF_Base.Properties
REM -----------------------------------------------------------------------------
Public Function SetProperty(Optional ByVal PropertyName As Variant _
, Optional ByRef Value As Variant _
) As Boolean
''' Set a new value to the given property
''' Args:
''' PropertyName: the name of the property as a string
''' Value: its new value
''' Exceptions
''' ARGUMENTERROR The property does not exist
Const cstThisSub = "SFDocuments.Base.SetProperty"
Const cstSubArgs = "PropertyName, Value"
If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
SetProperty = False
Check:
If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
If Not SF_Utils._Validate(PropertyName, "PropertyName", V_STRING, Properties()) Then GoTo Catch
End If
Try:
Select Case UCase(PropertyName)
Case Else
End Select
Finally:
SF_Utils._ExitFunction(cstThisSub)
Exit Function
Catch:
GoTo Finally
End Function ' SFDocuments.SF_Base.SetProperty
REM ======================================================= SUPERCLASS PROPERTIES
REM -----------------------------------------------------------------------------
'Property Get CustomProperties() As Variant
' CustomProperties = [_Super].GetProperty("CustomProperties")
'End Property ' SFDocuments.SF_Base.CustomProperties
REM -----------------------------------------------------------------------------
'Property Let CustomProperties(Optional ByVal pvCustomProperties As Variant)
' [_Super].CustomProperties = pvCustomProperties
'End Property ' SFDocuments.SF_Base.CustomProperties
REM -----------------------------------------------------------------------------
'Property Get Description() As Variant
' Description = [_Super].GetProperty("Description")
'End Property ' SFDocuments.SF_Base.Description
REM -----------------------------------------------------------------------------
'Property Let Description(Optional ByVal pvDescription As Variant)
' [_Super].Description = pvDescription
'End Property ' SFDocuments.SF_Base.Description
REM -----------------------------------------------------------------------------
'Property Get DocumentProperties() As Variant
' DocumentProperties = [_Super].GetProperty("DocumentProperties")
'End Property ' SFDocuments.SF_Base.DocumentProperties
REM -----------------------------------------------------------------------------
Property Get DocumentType() As String
DocumentType = [_Super].GetProperty("DocumentType")
End Property ' SFDocuments.SF_Base.DocumentType
REM -----------------------------------------------------------------------------
Property Get IsBase() As Boolean
IsBase = [_Super].GetProperty("IsBase")
End Property ' SFDocuments.SF_Base.IsBase
REM -----------------------------------------------------------------------------
Property Get IsCalc() As Boolean
IsCalc = [_Super].GetProperty("IsCalc")
End Property ' SFDocuments.SF_Base.IsCalc
REM -----------------------------------------------------------------------------
Property Get IsDraw() As Boolean
IsDraw = [_Super].GetProperty("IsDraw")
End Property ' SFDocuments.SF_Base.IsDraw
REM -----------------------------------------------------------------------------
Property Get IsImpress() As Boolean
IsImpress = [_Super].GetProperty("IsImpress")
End Property ' SFDocuments.SF_Base.IsImpress
REM -----------------------------------------------------------------------------
Property Get IsMath() As Boolean
IsMath = [_Super].GetProperty("IsMath")
End Property ' SFDocuments.SF_Base.IsMath
REM -----------------------------------------------------------------------------
Property Get IsWriter() As Boolean
IsWriter = [_Super].GetProperty("IsWriter")
End Property ' SFDocuments.SF_Base.IsWriter
REM -----------------------------------------------------------------------------
'Property Get Keywords() As Variant
' Keywords = [_Super].GetProperty("Keywords")
'End Property ' SFDocuments.SF_Base.Keywords
REM -----------------------------------------------------------------------------
'Property Let Keywords(Optional ByVal pvKeywords As Variant)
' [_Super].Keywords = pvKeywords
'End Property ' SFDocuments.SF_Base.Keywords
REM -----------------------------------------------------------------------------
'Property Get Readonly() As Variant
' Readonly = [_Super].GetProperty("Readonly")
'End Property ' SFDocuments.SF_Base.Readonly
REM -----------------------------------------------------------------------------
'Property Get Subject() As Variant
' Subject = [_Super].GetProperty("Subject")
'End Property ' SFDocuments.SF_Base.Subject
REM -----------------------------------------------------------------------------
'Property Let Subject(Optional ByVal pvSubject As Variant)
' [_Super].Subject = pvSubject
'End Property ' SFDocuments.SF_Base.Subject
REM -----------------------------------------------------------------------------
'Property Get Title() As Variant
' Title = [_Super].GetProperty("Title")
'End Property ' SFDocuments.SF_Base.Title
REM -----------------------------------------------------------------------------
'Property Let Title(Optional ByVal pvTitle As Variant)
' [_Super].Title = pvTitle
'End Property ' SFDocuments.SF_Base.Title
REM -----------------------------------------------------------------------------
Property Get XComponent() As Variant
XComponent = [_Super].GetProperty("XComponent")
End Property ' SFDocuments.SF_Base.XComponent
REM ========================================================== SUPERCLASS METHODS
REM -----------------------------------------------------------------------------
Public Function Activate() As Boolean
Activate = [_Super].Activate()
End Function ' SFDocuments.SF_Base.Activate
REM -----------------------------------------------------------------------------
Public Sub RunCommand(Optional ByVal Command As Variant)
[_Super].RunCommand(Command)
End Sub ' SFDocuments.SF_Base.RunCommand
REM -----------------------------------------------------------------------------
Public Function Save() As Boolean
Save = [_Super].Save()
End Function ' SFDocuments.SF_Base.Save
REM -----------------------------------------------------------------------------
Public Function SaveAs(Optional ByVal FileName As Variant _
, Optional ByVal Overwrite As Variant _
, Optional ByVal Password As Variant _
, Optional ByVal FilterName As Variant _
, Optional ByVal FilterOptions As Variant _
) As Boolean
SaveAs = [_Super].SaveAs(FileName, Overwrite, Password, FilterName, FilterOptions)
End Function ' SFDocuments.SF_Base.SaveAs
REM -----------------------------------------------------------------------------
Public Function SaveCopyAs(Optional ByVal FileName As Variant _
, Optional ByVal Overwrite As Variant _
, Optional ByVal Password As Variant _
, Optional ByVal FilterName As Variant _
, Optional ByVal FilterOptions As Variant _
) As Boolean
SaveCopyAs = [_Super].SaveCopyAs(FileName, Overwrite, Password, FilterName, FilterOptions)
End Function ' SFDocuments.SF_Base.SaveCopyAs
REM =========================================================== PRIVATE FUNCTIONS
REM -----------------------------------------------------------------------------
Private Function _CollectFormDocuments(ByRef poContainer As Object) As String
''' Returns a token-separated string of all hierarchical formdocument names
''' depending on the formdocuments container in argument
''' The function traverses recursively the whole tree below the container
''' The initial call starts from the container _Component.getFormDocuments
''' The list contains closed and open forms
Dim sCollectNames As String ' Return value
Dim oSubItem As Object ' com.sun.star.container.XNameAccess (folder) or com.sun.star.ucb.XContent (form)
Dim sFormName As String ' Single form name
Dim i As Long
Const cstFormType = "application/vnd.oasis.opendocument.text"
' Identifies forms. Folders have a zero-length content type
On Local Error GoTo Finally
Try:
sCollectNames = ""
With poContainer
For i = 0 To .Count - 1
Set oSubItem = .getByIndex(i)
If oSubItem.ContentType = cstFormType Then ' Add the form to the list
sCollectNames = sCollectNames & cstToken & oSubItem.HierarchicalName
Else
sCollectNames = sCollectNames & cstToken & _CollectFormDocuments(oSubItem)
End If
Next i
End With
Finally:
_CollectFormDocuments = Mid(sCollectNames, Len(cstToken) + 1) ' Skip the initial token
Exit Function
End Function ' SFDocuments.SF_Base._CollectFormDocuments
REM -----------------------------------------------------------------------------
Private Function _FileIdent() As String
''' Returns a file identification from the information that is currently available
''' Useful e.g. for display in error messages
_FileIdent = [_Super]._FileIdent()
End Function ' SFDocuments.SF_Base._FileIdent
REM -----------------------------------------------------------------------------
Private Function _IsStillAlive(Optional ByVal pbForUpdate As Boolean _
, Optional ByVal pbError As Boolean _
) As Boolean
''' Returns True if the document 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:
''' pbForUpdate: if True (default = False), check additionally if document is open for editing
''' pbError: if True (default), raise a fatal error
Dim bAlive As Boolean ' Return value
If IsMissing(pbForUpdate) Then pbForUpdate = False
If IsMissing(pbError) Then pbError = True
Try:
bAlive = [_Super]._IsStillAlive(pbForUpdate, pbError)
Finally:
_IsStillAlive = bAlive
Exit Function
End Function ' SFDocuments.SF_Base._IsStillAlive
REM -----------------------------------------------------------------------------
Private Function _PropertyGet(Optional ByVal psProperty As String _
, Optional ByVal pvArg As Variant _
) As Variant
''' Return the value of the named property
''' Args:
''' psProperty: the name of the property
Dim oProperties As Object ' Document or Custom properties
Dim vLastCell As Variant ' Coordinates of last used cell in a sheet
Dim oSelect As Object ' Current selection
Dim vRanges As Variant ' List of selected ranges
Dim i As Long
Dim cstThisSub As String
Const cstSubArgs = ""
_PropertyGet = False
cstThisSub = "SFDocuments.SF_Base.get" & psProperty
ScriptForge.SF_Utils._EnterFunction(cstThisSub, cstSubArgs)
If Not _IsStillAlive() Then GoTo Finally
Select Case psProperty
Case Else
_PropertyGet = Null
End Select
Finally:
ScriptForge.SF_Utils._ExitFunction(cstThisSub)
Exit Function
End Function ' SFDocuments.SF_Base._PropertyGet
REM -----------------------------------------------------------------------------
Private Function _Repr() As String
''' Convert the SF_Base instance to a readable string, typically for debugging purposes (DebugPrint ...)
''' Args:
''' Return:
''' "[Base]: Type/File"
_Repr = "[Base]: " & [_Super]._FileIdent()
End Function ' SFDocuments.SF_Base._Repr
REM ============================================ END OF SFDOCUMENTS.SF_BASE
</script:module>
|
