Υπηρεσία SFDocuments.Document

Η βιβλιοθήκη SFDocuments παρέχει μεθόδους και ιδιότητες για τη διευκόλυνση της διαχείρισης και του χειρισμού των εγγράφων του LibreOffice.

Μέθοδοι που ισχύουν για όλους τους τύπους εγγράφων (Έγγραφα κειμένου, Φύλλα, Παρουσιάσεις, κ.λπ.) παρέχονται από την υπηρεσία SFDocuments.Document. Μερικά παραδείγματα είναι:

warning

Οι ιδιότητες, οι μέθοδοι ή τα ορίσματα που επισημαίνονται με (*) ΔΕΝ ισχύουν για έγγραφα Base.


Οι μέθοδοι και οι ιδιότητες που αφορούν συγκεκριμένα στοιχεία του LibreOffice αποθηκεύονται σε ξεχωριστές υπηρεσίες, όπως SFDocuments.SF_Calc και SFDocuments.SF_Base.

Αν και η γλώσσα Basic δεν προσφέρει κληρονομικότητα μεταξύ κλάσεων αντικειμένων, οι τελευταίες υπηρεσίες μπορούν να θεωρηθούν ως υποκλάσεις της υπηρεσίας SFDocuments.Document. Τέτοιες υποκατηγορίες μπορούν να καλούν τις ιδιότητες και τις μεθόδους που περιγράφονται παρακάτω.

Κλήση υπηρεσίας

Ακολουθούν τρεις παραλλαγές του τρόπου με τον οποίο μπορεί να κληθεί η υπηρεσία Document.

Σε Basic

Χρησιμοποιώντας τη μέθοδο getDocument από την υπηρεσία ScriptForge.UI:


    Dim ui As Object, oDoc As Object
    Set ui = CreateScriptService("UI")
    Set oDoc = ui.GetDocument("Untitled 1")
  

Εναλλακτικά, μπορείτε να χρησιμοποιήσετε τις μεθόδους CreateDocument και OpenDocument από την υπηρεσία UI.


    Set oDocA = ui.CreateDocument("Calc")
    Set oDocB = ui.OpenDocument("C:\Documents\MyFile.odt")
  

Απευθείας εάν το έγγραφο είναι ήδη ανοιχτό.


    Dim oDoc As Object
    Set oDoc = CreateScriptService("SFDocuments.Document", "Untitled 1") 'Default = ActiveWindow
  

Από μια μακροεντολή που ενεργοποιείται από ένα συμβάν εγγράφου.


    Sub RunEvent(ByRef poEvent As Object)
        Dim oDoc As Object
        Set oDoc = CreateScriptService("SFDocuments.DocumentEvent", poEvent)
        ' (...)
    End Sub
  
note

Η υπηρεσία Document σχετίζεται στενά με τις υπηρεσίες UI και FileSystem.


Εκτός από την περίπτωση που το έγγραφο έκλεισε με πρόγραμμα με τη μέθοδο CloseDocument (τότε είναι περιττό), συνιστάται η απελευθέρωση πόρων μετά τη χρήση:


    Set oDoc = oDoc.Dispose()
  
Σε Python

    from scriptforge import CreateScriptService
    ui = CreateScriptService("UI")
    doc = ui.GetDocument("Untitled 1")
    # (...)
    doc.Dispose()
  

    docA = ui.CreateDocument("Calc")
    docB = ui.OpenDocument("C:\Documents\MyFile.odt")
  

    doc = CreateScriptService("SFDocuments.Document", "Untitled 1")
  

    def RunEvent(event)
        doc = CreateScriptService("SFDocuments.DocumentEvent", Event)
        # (...)
  
tip

Η χρήση του προθέματος "SFDocuments." κατά την κλήση της υπηρεσίας είναι προαιρετική.


Ιδιότητες

Όνομα

Μόνο για ανάγνωση

Τύπος

Περιγραφή

CustomProperties (*)

Όχι

Dictionary service

Επιστρέφει μια παρουσία αντικειμένου ScriptForge.Dictionary. Μετά την ενημέρωση, μπορεί να μεταβιβαστεί ξανά στην ιδιότητα για ενημέρωση του εγγράφου.
Μεμονωμένα στοιχεία του λεξικού μπορεί να είναι συμβολοσειρές, αριθμοί, ημερομηνίες (Basic) ή στοιχεία com.sun.star.util.Duration.

Description (*)

Όχι

String

Παρέχει πρόσβαση στην ιδιότητα Description (Περιγραφή) του εγγράφου (γνωστή και ως "Comments (Σχόλια)")

DocumentProperties (*)

Ναι

Dictionary service

Επιστρέφει ένα αντικείμενο ScriptForge.Dictionary που περιέχει όλες τις εγγραφές. Περιλαμβάνονται στατιστικά στοιχεία εγγράφων. Σημειώστε ότι είναι ειδικά για τον τύπο του εγγράφου. Για παράδειγμα, ένα έγγραφο Calc περιλαμβάνει μια καταχώρηση "CellCount". Άλλα έγγραφα όχι.

DocumentType

Ναι

String

Τιμή συμβολοσειράς με τον τύπο εγγράφου ("Base", "Calc", "Writer" κ.λπ.)

IsBase
IsCalc
IsDraw
IsImpress
IsMath
IsWriter

Ναι

Boolean

Ακριβώς μία από αυτές τις ιδιότητες είναι True για ένα δεδομένο έγγραφο.

Keywords (*)

Όχι

String

Παρέχει πρόσβαση στην ιδιότητα Keywords (Λέξεις-κλειδιά) του εγγράφου. Αντιπροσωπεύεται ως κατάλογος λέξεων-κλειδιών διαχωρισμένα με κόμμα

Readonly (*)

Ναι

Boolean

True (αληθές)εάν το έγγραφο βρίσκεται στην πραγματικότητα σε λειτουργία μόνο για ανάγνωση

Subject (*)

Όχι

String

Παρέχει πρόσβαση στην ιδιότητα Subject (Θέμα) του εγγράφου.

Title (*)

Όχι

String

Παρέχει πρόσβαση στην ιδιότητα Title (τίτλος) του εγγράφου.

XComponent

Ναι

Αντικείμενο UNO

Το αντικείμενο UNO com.sun.star.lang.XComponent ή com.sun.dbatar.comp .ODatabaseDocument που αντιπροσωπεύει το έγγραφο


Παράδειγμα:

Σε Basic

Το παρακάτω παράδειγμα εκτυπώνει όλες τις ιδιότητες ενός εγγράφου. Σημειώστε ότι το αντικείμενο oDoc που επιστρέφεται με τη μέθοδο UI.OpenDocument είναι αντικείμενο SFDocuments.Document.


    Dim ui as Variant : Set ui = CreateScriptService("UI")
    Dim oDoc as Object
    Set oDoc = ui.OpenDocument("C:\Documents\MyFile.ods")
    Dim propDict as Object
    Set propDict = oDoc.DocumentProperties
    Dim keys as Variant : propKeys = propDict.Keys
    Dim k as String, strProp as String
    For Each k In propKeys
        strProp = strProp & k & ": " & propDict.Item(k) & CHR$(10)
    Next k
    MsgBox strProp
    oDoc.CloseDocument()
  
Σε Python

Για να αποκτήσετε πρόσβαση στις ιδιότητες εγγράφων σε ένα σενάριο Python, ο χρήστης πρέπει να έχει απευθείας πρόσβαση σε αυτές χρησιμοποιώντας τα ονόματά τους, όπως φαίνεται παρακάτω:


    doc = ui.GetDocument(r"C:\Documents\MyFile.ods")
    msg = doc.Title + '\n' + doc.Description + '\n' + doc.Keywords
    bas = CreateScriptService("Basic")
    bas.MsgBox(msg)
    doc.CloseDocument()
  

Κατάλογος μεθόδων στην υπηρεσία εγγράφων

Activate
CloseDocument
ExportAsPDF

PrintOut
RunCommand
Save

SaveAs
SaveCopyAs
SetPrinter


Activate

Επιστρέφει True εάν το έγγραφο μπορούσε να ενεργοποιηθεί. Διαφορετικά, δεν υπάρχει καμία αλλαγή στην πραγματική διεπαφή χρήστη. Είναι ισοδύναμο με τη μέθοδο Activate (Ενεργοποίηση) της υπηρεσίας UI.

Αυτή η μέθοδος είναι χρήσιμη όταν χρειάζεται να εστιάσετε σε ένα έγγραφο που είναι ελαχιστοποιημένο ή κρυφό.

Σύνταξη:

svc.Activate(): bool

Παράδειγμα:

Το παρακάτω παράδειγμα θεωρεί ότι το αρχείο "My_File.ods" είναι ήδη ανοιχτό αλλά δεν είναι ενεργό.

Σε Basic

    Dim oDoc As Object
    Set oDoc = CreateScriptService("Document", "MyFile.ods")
    oDoc.Activate()
  
Σε Python

    doc = CreateScriptService("Document", "MyFile.ods")
    doc.Activate()
  
tip

Λάβετε υπόψη ότι μπορείτε να καλέσετε την υπηρεσία Document περνώντας στο CreateScriptService, είτε "Document", ή "SFDocuments.Document"


CloseDocument

Κλείνει το έγγραφο. Εάν το έγγραφο είναι ήδη κλειστό, ανεξάρτητα από το πώς έκλεισε το έγγραφο, αυτή η μέθοδος δεν έχει κανένα αποτέλεσμα και επιστρέφει False.

Η μέθοδος θα επιστρέψει επίσης False εάν ο χρήστης αρνηθεί να την κλείσει.

Επιστρέφει True εάν το έγγραφο έκλεισε με επιτυχία.

Σύνταξη:

svc.CloseDocument(saveask: bool = True): bool

Παράμετροι:

saveask : Εάν είναι True (προεπιλογή), ο χρήστης καλείται να επιβεβαιώσει εάν οι αλλαγές πρέπει να εγγραφούν στο δίσκο. Αυτό το όρισμα αγνοείται εάν το έγγραφο δεν τροποποιήθηκε.

Παράδειγμα:

Σε Basic

    If oDoc.CloseDocument(True) Then
        ' ...
    End If
  
Σε Python

    if doc.CloseDocument(True):
        # ...
  

ExportAsPDF

Εξάγει το έγγραφο απευθείας ως αρχείο PDF στην καθορισμένη τοποθεσία. Επιστρέφει True εάν το αρχείο PDF δημιουργήθηκε με επιτυχία.

Οι επιλογές εξαγωγής μπορούν να οριστούν είτε χειροκίνητα χρησιμοποιώντας το παράθυρο διαλόγου Αρχείο - Εξαγωγή ως - Εξαγωγή ως PDF, είτε καλώντας τις μεθόδους GetPDFExportOptions και SetPDFExportOptions από το Υπηρεσία Session.

Σύνταξη:

svc.ExportAsPDF(filename: str, overwrite: bool = False, opt pages: str, opt password: str, opt watermark: str): bool

Παράμετροι:

filename (όνομα αρχείου): Η πλήρης διαδρομή και το όνομα αρχείου του PDF που θα δημιουργηθεί. Πρέπει να ακολουθεί τη σημειογραφία SF_FileSystem.FileNaming.

(αντικατάσταση): Καθορίζει εάν το αρχείο προορισμού μπορεί να αντικατασταθεί (Προεπιλογή = False). Θα προκύψει σφάλμα εάν το overwrite οριστεί σε False και το αρχείο προορισμού υπάρχει ήδη.

pages (σελίδες): Συμβολοσειρά που καθορίζει ποιες σελίδες θα εξαχθούν. Αυτό το όρισμα χρησιμοποιεί την ίδια συμειογραφία όπως στο παράθυρο διαλόγου Αρχείο - Εξαγωγή ως - Εξαγωγή ως PDF.

password (κωδικός πρόσβασης): Καθορίζει έναν κωδικό πρόσβασης για το άνοιγμα του αρχείου PDF.

watermark (υδατογράφημα): Κείμενο που θα χρησιμοποιηθεί ως υδατογράφημα στο αρχείο PDF, το οποίο θα σχεδιαστεί σε κάθε σελίδα του PDF που προκύπτει.

Παράδειγμα:

Σε Basic

Το ακόλουθο παράδειγμα εξάγει το τρέχον έγγραφο ως αρχείο PDF, ορίζει έναν κωδικό πρόσβασης και αντικαθιστά το αρχείο προορισμού εάν υπάρχει ήδη.


    oDoc.ExportAsPDF("C:\User\Documents\myFile.pdf", Password := "1234", Overwrite := True)
  

Το παρακάτω απόσπασμα κώδικα λαμβάνει τις τρέχουσες επιλογές εξαγωγής PDF και τις χρησιμοποιεί για τη δημιουργία του αρχείου PDF.


    Dim exportSettings as Object, oSession as Object
    oSession = CreateScriptService("Session")
    exportSettings = oSession.GetPDFExportOptions()
    ' Ορίζει σε True την επιλογή εξαγωγής σχολίων ως σημειώσεων PDF
    exportSettings.ReplaceItem("ExportNotes", True)
    oSession.SetPDFExportOptions(exportSettings)
    oDoc.ExportAsPDF("C:\User\Documents\myFile.pdf")
  
Σε Python

    doc.ExportAsPDF(r"C:\User\Documents\myFile.pdf", password = "1234", overwrite = True)
  

    session = CreateScriptService("Session")
    exportSettings = oSession.GetPDFExportOptions()
    exportSettings.ReplaceItem("ExportNotes", True)
    session.SetPDFExportOptions(exportSettings)
    doc.ExportAsPDF(r"C:\User\Documents\myFile.pdf")
  

PrintOut

Αυτή η μέθοδος στέλνει τα περιεχόμενα του εγγράφου στον προεπιλεγμένο εκτυπωτή ή στον εκτυπωτή που ορίζεται από τη μέθοδο SetPrinter.

Επιστρέφει True εάν το έγγραφο εκτυπώθηκε με επιτυχία.

Σύνταξη:

svc.PrintOut(pages: str = "", copies: num = 1): bool

Παράμετροι:

pages (σελίδες): Οι σελίδες που θα εκτυπωθούν ως συμβολοσειρά, όπως στη διεπαφή χρήστη. Παράδειγμα: "1-4;10;15-18". Η προεπιλογή είναι όλες οι σελίδες.

copies (αντίγραφα): Ο αριθμός των αντιγράφων. Η προεπιλογή είναι 1.

Παράδειγμα:

Σε Basic

    If oDoc.PrintOut("1-4;10;15-18", Copies := 2) Then
        ' ...
    End If
  
Σε Python

    if doc.PrintOut(copies=3, pages='45-88'):
        # ...
  

RunCommand

Runs a command on a document. The command is executed without arguments.

A few typical commands are: Save, SaveAs, ExportToPDF, SetDocumentProperties, Undo, Copy, Paste, etc.

Το ίδιο το έγγραφο δεν χρειάζεται να είναι ενεργό για να μπορεί να εκτελεί εντολές.

Σύνταξη:

svc.RunCommand(command: str)

Παράμετροι:

command: Case-sensitive string containing the command in English. The command itself is not checked for correctness. If nothing happens after the command call, then the command is probably wrong.

Παράδειγμα:

The following example runs the "SelectData" command in a Calc sheet named "MyFile.ods", which will result in the selection of the data area based on the currently selected cell.

Σε Basic

    Set oDoc = CreateScriptService("Document", "MyFile.ods")
    oDoc.RunCommand("SelectData")
  
Σε Python

    doc = CreateScriptService("Document", "MyFile.ods")
    doc.RunCommand("SelectData")
  

The example above actually runs the UNO command .uno:SelectData. Hence, to use the RunCommand method it is necessary to remove the ".uno:" substring.

tip

Each LibreOffice component has its own set of commands available. One easy way to learn commands is going to Tools > Customize > Keyboard. When you position your mouse over a function in the Function list, a tooltip will appear with the corresponding UNO command.


Save

Αποθηκεύει το έγγραφο στη θέση του αρχείου από την οποία φορτώθηκε. Η μέθοδος αγνοείται εάν το έγγραφο δεν τροποποιήθηκε.

Επιστρέφει False εάν δεν ήταν δυνατή η αποθήκευση του εγγράφου. Παρουσιάζεται σφάλμα εάν το αρχείο είναι ανοιχτό ως μόνο για ανάγνωση ή εάν πρόκειται για νέο αρχείο που δεν έχει αποθηκευτεί ακόμα.

Το ίδιο το έγγραφο δεν χρειάζεται να είναι ενεργό για την εκτέλεση αυτής της μεθόδου.

Σύνταξη:

svc.Save(): bool

Παράδειγμα:

Σε Basic

    If Not oDoc.Save() Then
        ' ...
    End If
  
Σε Python

    if not doc.Save():
        # ...
  

SaveAs

Αποθηκεύει το έγγραφο στη δεδομένη θέση αρχείου. Η νέα θέση γίνεται το νέο όνομα αρχείου στο οποίο θα εφαρμοστούν απλές κλήσεις της μεθόδου Save (Αποθήκευση).

Επιστρέφει False εάν δεν ήταν δυνατή η αποθήκευση του εγγράφου. Παρουσιάζεται σφάλμα όταν απορρίπτεται η αντικατάσταση του προορισμού, ή όταν ο προορισμός έχει σύνολο γνωρισμάτων μόνο για ανάγνωση.

Το ίδιο το έγγραφο δεν χρειάζεται να είναι ενεργό για την εκτέλεση αυτής της μεθόδου.

Σύνταξη:

svc.SaveAs(filename: str, overwrite: bool = False, password: str = '', filtername: str = '', filteroptions: str = ''): bool

Παράμετροι:

filename (όνομα αρχείου): Μια συμβολοσειρά που περιέχει το όνομα αρχείου που θα χρησιμοποιηθεί. Πρέπει να ακολουθεί τη σημειογραφία SF_FileSystem.FileNaming.

overwrite (αντικατάσταση): Εάν είναι True, το αρχείο προορισμού ενδέχεται να αντικατασταθεί (προεπιλογή = False).

password (*) (κωδικός πρόσβασης): Μια συμβολοσειρά χωρίς διάστημα για την προστασία του εγγράφου.

filtername (*) (όνομα φίλτρου): Το όνομα ενός φίλτρου που πρέπει να χρησιμοποιηθεί για την αποθήκευση του εγγράφου. Εάν αυτό το όρισμα μεταβιβαστεί, τότε το φίλτρο πρέπει να υπάρχει.

filteroptions (*) (επιλογές φίλτρου): Μια προαιρετική συμβολοσειρά επιλογών που σχετίζεται με το φίλτρο.

Παράδειγμα:

Σε Basic

    oDoc.SaveAs("C:\Documents\NewCopy.odt", overwrite := True)
  
Σε Python

    doc.SaveAs(r"C:\Documents\NewCopy.odt", overwrite = True)
  

SaveCopyAs

Αποθηκεύει ένα αντίγραφο ή εξάγει το έγγραφο στη δεδομένη θέση αρχείου. Η πραγματική τοποθεσία παραμένει αμετάβλητη.

Επιστρέφει False εάν δεν ήταν δυνατή η αποθήκευση του εγγράφου. Παρουσιάζεται σφάλμα όταν απορρίπτεται η αντικατάσταση του προορισμού, ή όταν ο προορισμός έχει σύνολο γνωρισμάτων μόνο για ανάγνωση.

Το ίδιο το έγγραφο δεν χρειάζεται να είναι ενεργό για την εκτέλεση αυτής της μεθόδου.

Σύνταξη:

svc.SaveCopyAs(filename: str, overwrite: bool = False, password: str = '', filtername: str = '', filteroptions: str = ''): bool

Παράμετροι:

filename (όνομα αρχείου): Μια συμβολοσειρά που περιέχει το όνομα αρχείου που θα χρησιμοποιηθεί. Πρέπει να ακολουθεί τη σημειογραφία SF_FileSystem.FileNaming.

overwrite (αντικατάσταση): Εάν είναι True, το αρχείο προορισμού ενδέχεται να αντικατασταθεί (προεπιλογή = False).

password (*) (κωδικός πρόσβασης): Μια συμβολοσειρά χωρίς διάστημα για την προστασία του εγγράφου.

filtername (*) (όνομα φίλτρου): Το όνομα ενός φίλτρου που πρέπει να χρησιμοποιηθεί για την αποθήκευση του εγγράφου. Εάν αυτό το όρισμα μεταβιβαστεί, τότε το φίλτρο πρέπει να υπάρχει.

filteroptions (*) (επιλογές φίλτρου): Μια προαιρετική συμβολοσειρά επιλογών που σχετίζεται με το φίλτρο.

Παράδειγμα:

Σε Basic

    oDoc.SaveCopyAs("C:\Documents\Copy2.odt", Overwrite := True)
  
Σε Python

    doc.SaveCopyAs(r"C:\Documents\Copy2.odt", overwrite = True)
  

SetPrinter

Καθορίζει τις επιλογές εκτυπωτή για το έγγραφο.

Επιστρέφει True όταν είναι επιτυχές.

Σύνταξη:

svc.SetPrinter(opt printer: str, opt orientation: str, paperformat: str): bool

Παράμετροι:

printer (εκτυπωτής): Το όνομα της ουράς του εκτυπωτή όπου θα εκτυπωθεί. Όταν απουσιάζει, ορίζεται ο προεπιλεγμένος εκτυπωτής.

orientation (προσανατολισμός): Είτε PORTRAIT (κατακόρυφα), είτε LANDSCAPE (οριζόντια). Όταν απουσιάζει, αφήνεται αμετάβλητο σε σχέση με τις ρυθμίσεις του εκτυπωτή.

performat (μορφή χαρτιού): Καθορίζει τη μορφή χαρτιού ως τιμή συμβολοσειράς που μπορεί να είναι είτε A3, A4, A5, >LETTER, LEGAL ή TABLOID. Αφήνεται αμετάβλητο όταν απουσιάζει.

Παράδειγμα:

Σε Basic

    oDoc.SetPrinter(Orientation := "PORTRAIT")
  
Σε Python

    doc.SetPrinter(paperformat='TABLOID')
  
warning

Όλες οι ρουτίνες ή αναγνωριστικά του ScriptForge στη Basic που έχουν το πρόθεμα χαρακτήρα υπογράμμισης "_" δεσμεύονται για εσωτερική χρήση. Δεν προορίζονται να χρησιμοποιηθούν σε μακροεντολές Basic ή σενάρια Python.