Υπηρεσία SFDocuments.Document

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

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

• Άνοιγμα, κλείσιμο και αποθήκευση εγγράφων

• Πρόσβαση σε τυπικές ή προσαρμοσμένες ιδιότητες εγγράφων

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

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

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

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

Πριν τη χρήση της υπηρεσίας Document, πρέπει να φορτωθεί ή να εισαχθεί η βιβλιοθήκη ScriptForge:

• Οι μακροεντολές Basic απαιτούν τη φόρτωση της βιβλιοθήκης ScriptForge χρησιμοποιώντας την ακόλουθη πρόταση:
GlobalScope.BasicLibraries.loadLibrary("ScriptForge")

• Τα σενάρια Python απαιτούν εισαγωγή από την ενότητα scriptforge:
από το scriptforge import CreateScriptService

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

Χρησιμοποιώντας τη μέθοδο 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
  

Χρησιμοποιώντας το έγγραφο που αναφέρεται από το ThisComponent. Αυτό είναι ιδιαίτερα χρήσιμο όταν εκτελείτε μια μακροεντολή μέσα από το IDE της Basic .

    Dim oDoc As Object
    Set oDoc = CreateScriptService("Document", ThisComponent)
  

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

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

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

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

    Set oDoc = oDoc.Dispose()
  

    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")
  

    bas = CreateScriptService("Basic")
    doc = CreateScriptService("Document", bas.ThisComponent)
  

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

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

Ιδιότητες

Το παρακάτω παράδειγμα εκτυπώνει όλες τις ιδιότητες ενός εγγράφου. Σημειώστε ότι το αντικείμενο 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, ο χρήστης πρέπει να έχει απευθείας πρόσβαση σε αυτές χρησιμοποιώντας τα ονόματά τους, όπως φαίνεται παρακάτω:

    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

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

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

svc.Activate(): bool

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

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

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

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

CloseDocument

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

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

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

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

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

    If oDoc.CloseDocument(True) Then
        ' ...
    End If
  

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

CreateMenu

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

Αυτή η μέθοδος επιστρέφει μια παρουσία της υπηρεσίας SFWidgets.Menu.

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

svc.CreateMenu(menuheader: str, [before: any], submenuchar: str = ">"): svc

menuheader (κεφαλίδα μενού): Το όνομα ανώτατου επιπέδου του νέου μενού.

before (πριν): Το όνομα (ως συμβολοσειρά) ή η θέση (ως ακέραιος αριθμός που ξεκινά από το 1) ενός υπάρχοντος μενού πριν από το οποίο θα τοποθετηθεί το νέο μενού. Εάν δεν οριστεί τιμή για αυτό το όρισμα, το μενού θα δημιουργηθεί στην τελευταία θέση στη γραμμή μενού.

submenuchar (χαρακτήρας υπομενού): Το διαχωριστικό που χρησιμοποιείται για τη δημιουργία δέντρων μενού κατά την κλήση μεθόδων ως AddItem (προσθήκη στοιχείου) από την υπηρεσία Menu (μενού). Η προεπιλεγμένη τιμή είναι ">".

    Dim oDoc as Object, oMenu as Object
    Set oDoc = CreateScriptService("Document")
    Set oMenu = oDoc.CreateMenu("My Menu")
    With oMenu
        ' Προσθήκη στοιχείων στο μενού
        .AddItem("Item A")
        .AddItem("Item B")
        ' ...
        ' Μετά τη δημιουργία του μενού, η παρουσία της υπηρεσίας μπορεί να απορριφθεί
        .Dispose()
    End With
  

    doc = CreateScriptService("Document")
    menu = doc.CreateMenu("My Menu")
    menu.AddItem("Item A")
    menu.AddItem("Item B")
    # ...
    menu.Dispose()
  

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

DeleteStyles

Καταργεί μι; μεμονωμένη τεχνοτροπία, ή μια σειρά τεχνοτροπίες που δίνονται με τα ονόματά τους σε μια συγκεκριμένη οικογένεια τεχνοτροπιών. Μόνο οι τεχνοτροπίες που ορίζονται από το χρήστη μπορούν να διαγραφούν, οι ενσωματωμένες τεχνοτροπίες αγνοούνται. Ισχύει για όλους τους τύπους εγγράφων εκτός από τα Base και FormDocument.

svc.DeleteStyles(family: str, stylelist: str[1..*])

family: Μία από τις οικογένειες τεχνοτροπιών που υπάρχουν στο πραγματικό έγγραφο, ως συμβολοσειρά με διάκριση πεζών-κεφαλαίων. Τα έγκυρα οικογενειακά ονόματα μπορούν να ανακτηθούν χρησιμοποιώντας την ιδιότητα StyleFamilies.

stylelist: A single style name as a string or an array of style names. The style names may be localized or not. The StylesList is typically the output of the execution of a Styles() method.

    ' Κατάργηση αχρησιμοποίητων τεχνοτροπιών παραγράφων
    Const family = "ParagraphStyles"
    aList = oDoc.Styles(family, used := False, userDefined := True)
    oDoc.DeleteStyles(family, aList)
  

    # Αφαίρεση τεχνοτροπιών σύμφωνα με ένα πρόθεμα
    a_list = doc.Styles('ParagraphStyles', namepattern = "Py*")
    doc.Styles('ParagraphStyles', a_list)
  

Echo

Αναστέλλει τις ενημερώσεις διεπαφής χρήστη (UI) κατά την εκτέλεση μιας μακροεντολής. Προαιρετικά, ο δείκτης του ποντικιού μπορεί να μετατραπεί σε κλεψύδρα ενώ οι ενημερώσεις διεπαφής χρήστη έχουν ανασταλεί.

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

svc.Echo(echoon: bool = True, hourglass: bool = False)

echoon: Καθορίστε False για να αναστείλετε τις ενημερώσεις διεπαφής χρήστη. Η προεπιλεγμένη τιμή είναι True, η οποία επιτρέπει ενημερώσεις διεπαφής χρήστη σε πραγματικό χρόνο.

hourglass: Καθορίστε True για να αλλάξετε τον δείκτη του ποντικιού σε κλεψύδρα (Προεπιλογή = False).

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

    ' Αναστέλλει τις ενημερώσεις διεπαφής χρήστη και αλλάζει το δείκτη του ποντικιού σε κλεψύδρα
    oDoc.Echo(EchoOn := False, HourGlass := True)
    ' Άλλες εντολές μακροεντολών
    ' ...
    ' Επαναφέρει τις ενημερώσεις διεπαφής χρήστη και το δείκτη του ποντικιού
    oDoc.Echo()
  

    doc.Echo(echoon = False, hourglass = True)
    ...
    doc.Echo()
  

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 που προκύπτει.

Το ακόλουθο παράδειγμα εξάγει το τρέχον έγγραφο ως αρχείο 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")
  

    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")
  

ImportStylesFromFile

Αυτή η μέθοδος φορτώνει όλες τις τεχνοτροπίες που ανήκουν σε μία ή περισσότερες οικογένειες τεχνοτροπιών από ένα κλειστό αρχείο στο πραγματικό έγγραφο. Το πραγματικό έγγραφο πρέπει να είναι ένα έγγραφο Calc, ή Writer.

Εισάγονται πάντα μαζί:

• ParagraphStyles και CharacterStyles

• NumberingStyles και ListStyles

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

svc.ImportStylesFromFile(filename: str, families: str[1..*], overwrite = False): bool

filename: Το αρχείο από το οποίο θα φορτωθούν οι τεχνοτροπίες στη σημειογραφία FileSystem. Το αρχείο θεωρείται ότι είναι του ίδιου τύπου εγγράφου με το πραγματικό έγγραφο.

families: One of the style families present in the actual document, as a case-sensitive string or an array of such strings. Default = all families.

overwrite: Όταν είναι True, οι πραγματικές τεχνοτροπίες ενδέχεται να αντικατασταθούν. Η προεπιλογή είναι False.

    oDoc.ImportStylesFromFile("C:\User\Documents\myFile.ods", "ParagraphStyles", True)
  

    doc.ImportStylesFromFile('C:\User\Documents\myFile.ods', ("ParagraphStyles",), False)
  

PrintOut

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

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

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

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

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

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

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

RemoveMenu

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

Επιστρέφει True εάν το καθορισμένο μενού μπορούσε να αφαιρεθεί. Εάν το καθορισμένο μενού δεν υπάρχει, η μέθοδος επιστρέφει False.

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

svc.RemoveMenu(menuheader: str): bool

menuheader (κεφαλίδα μενού): Το όνομα ανώτατου επιπέδου του μενού που πρόκειται να αφαιρεθεί.

    Dim oDoc as Object
    Set oDoc = CreateScriptService("Document")
    oDoc.RemoveMenu("My Menu")
  

    doc = CreateScriptService("Document")
    doc.RemoveMenu("My Menu")
  

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

RunCommand

Εκτελεί μια εντολή UNO στο παράθυρο του εγγράφου που σχετίζεται με την παρουσία της υπηρεσίας. Μερικές τυπικές εντολές είναι: Save, SaveAs, ExportToPDF, Undo, Copy, Paste, κ.λπ.

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

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

Για έναν πλήρη κατάλογο εντολών UNO που μπορούν να εκτελεστούν στο LibreOffice, ανατρέξτε στη σελίδα Wiki Development/DispatchCommands.

svc.RunCommand(command: str, [args: any])

command (εντολή): συμβολοσειρά με διάκριση πεζών-κεφαλαίων που περιέχει το όνομα εντολής UNO. Η συμπερίληψη του προθέματος ".uno:" στην εντολή είναι προαιρετική. Η ίδια η εντολή δεν ελέγχεται για ορθότητα. Εάν δεν συμβεί τίποτα μετά την κλήση της εντολής, τότε η εντολή είναι πιθανώς λάθος.

args (ορίσματα): Για κάθε όρισμα που θα μεταβιβαστεί στην εντολή, καθορίστε ένα ζεύγος που περιέχει το όνομα και την τιμή του ορίσματος.

Το παρακάτω παράδειγμα εκτελεί την εντολή SelectData σε ένα αρχείο Calc που ονομάζεται "MyFile.ods", το οποίο θα έχει ως αποτέλεσμα την επιλογή της περιοχής δεδομένων με βάση το τρέχον επιλεγμένο κελί. Σημειώστε ότι αυτή η εντολή δεν απαιτεί ορίσματα.

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

Ακολουθεί ένα παράδειγμα που εκτελεί την εντολή UNO ReplaceAll και μεταβιβάζει τιμές για τα ορίσματά της SearchString και ReplaceString. Η εκτέλεση αυτής της εντολής θα αντικαταστήσει κάθε εμφάνιση της συμβολοσειράς "abc" από "ABC" στο τρέχον φύλλο.

    ' Τα ορίσματα πέρασαν στην εντολή:
    ' SearchString  = "abc"
    ' ReplaceString = "ABC"
    oDoc.RunCommand(".uno:ReplaceAll", "SearchString", "abc", "ReplaceString", "ABC")
  

Σημειώστε ότι η κλήση της εντολής ReplaceAll χωρίς ορίσματα θα ανοίξει το παράθυρο διαλόγου Εύρεση και αντικατάσταση.

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

    doc.RunCommand(".uno:ReplaceAll", "SearchString", "abc", "ReplaceString", "ABC")
  

Στην Python είναι επίσης δυνατό να καλέσετε το RunCommand χρησιμοποιώντας ορίσματα λέξεων-κλειδιών:

    doc.RunCommand(".uno:ReplaceAll", SearchString = "abc", ReplaceString = "ABC")
  

Κάθε στοιχείο του LibreOffice έχει διαθέσιμο το δικό του σύνολο εντολών. Ένας εύκολος τρόπος για να μάθετε εντολές είναι να μεταβείτε στα Εργαλεία - Προσαρμογή - Πληκτρολόγιο. Όταν τοποθετείτε το ποντίκι σας πάνω από μια συνάρτηση στον κατάλογο Function (συναρτήσεις), θα εμφανιστεί μια επεξήγηση με την αντίστοιχη εντολή UNO.

Save

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

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

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

svc.Save(): bool

    If Not oDoc.Save() Then
        ' ...
    End If
  

    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 (*) (επιλογές φίλτρου): Μια προαιρετική συμβολοσειρά επιλογών που σχετίζεται με το φίλτρο.

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

    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 (*) (επιλογές φίλτρου): Μια προαιρετική συμβολοσειρά επιλογών που σχετίζεται με το φίλτρο.

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

    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. Αφήνεται αμετάβλητο όταν απουσιάζει.

    oDoc.SetPrinter(Orientation := "PORTRAIT")
  

    doc.SetPrinter(paperformat='TABLOID')
  

Styles

Ανακτά έναν κατάλογο τεχνοτροπιών που αντιστοιχεί σε προαιρετικά σύνθετα κριτήρια, ο πίνακας που επιστρέφεται μπορεί να είναι κενός. Ισχύει για όλους τους τύπους εγγράφων εκτός από τη Base.

svc.Styles(family, opt namepattern: str, opt used: bool, opt userdefined: bool, opt parentstyle: str, opt category: str): str[0..*])

category: Μια συμβολοσειρά χωρίς διάκριση πεζών-κεφαλαίων: TEXT, CHAPTER, LIST, INDEX, EXTRA, HTML. Για τις αντίστοιχες έννοιές τους, ανατρέξτε στην τεκμηρίωση API κατηγορία τεχνοτροπίας παραγράφου.

Αυτό το όρισμα αγνοείται όταν η οικογένεια διαφέρει από το "ParagraphStyles".

namepattern: Ένα φίλτρο στα ονόματα τεχνοτροπιών, ως μοτίβο συμβολοσειράς με διάκριση πεζών-κεφαλαίων. Τα ονόματα περιλαμβάνουν τα εσωτερικά και τοπικά ονόματα.

Οι αποδεκτοί χαρακτήρες υποκατάστασης είναι:

• ο "?" που αντιπροσωπεύει οποιονδήποτε μεμονωμένο χαρακτήρα.

• το "*" που αντιπροσωπεύει μηδέν, έναν ή πολλούς χαρακτήρες

parentstyle: Όταν υπάρχουν, διατηρούνται μόνο οι κατιόντες του συγκεκριμένου ονόματος, τοπικού ή όχι, της γονικής τεχνοτροπίας.

used: Όταν είναι True, η τεχνοτροπία πρέπει να χρησιμοποιείται στο έγγραφο, όταν απουσιάζει το όρισμα αγνοείται.

userdefined: Όταν είναι True, η τεχνοτροπία πρέπει να έχει προστεθεί από τον χρήστη, είτε στο έγγραφο είτε στο πρότυπό του, όταν δεν υπάρχει, το όρισμα αγνοείται.

    Dim vStyles As Variant
    vStyles = oDoc.Styles("ParagraphStyles") 'Όλες οι τεχνοτροπίες στην οικογένεια
    vStyles = oDoc.Styles("Styles Paragraph", "H*") 'Επικεφαλίδα, Επικεφαλίδα 1, ...
    vStyles = oDoc.Styles("ParagraphStyles", Used := False, UserDefined := True) ' Όλες οι τεχνοτροπίες που ορίζονται από το χρήστη που δεν χρησιμοποιούνται
    vStyles = oDoc.Styles("ParagraphStyles", ParentStyle := "Standard") ' Όλες οι τεχνοτροπίες προέρχονται από την 'Προεπιλεγμένη τεχνοτροπία παραγράφου'
  

    vStyles = doc.Styles('ParagraphStyles') #Όλες οι τεχνοτροπίες στην οικογένεια
    vStyles = doc.Styles('Styles Paragraph', 'H*') #Heading, Heading 1, …
    vStyles = doc.Styles('ParagraphStyles', Used = False, UserDefined = True) # Όλες οι τεχνοτροπίες που ορίζονται από το χρήστη και δεν χρησιμοποιούνται
    vStyles = doc.Styles('ParagraphStyles', ParentStyle = 'Standard") # Όλες οι τεχνοτροπίες που προέρχονται από την "Προεπιλεγμένη τεχνοτροπία παραγράφου"
  

Toolbars

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

svc.Toolbars(opt ToolbarName: str): uno
svc.Toolbars(): str[0..]

ToolbarName: Το συνηθισμένο όνομα μιας από τις διαθέσιμες γραμμές εργαλείων.

    Dim oToolbar As Object
    Set oToolbar = oDoc.Toolbars("myToolbar")
  

    a_list = doc.Toolbars()
  

XStyles

This method returns the UNO representation of a given style for all document types except Base. Nothing is returned when the StyleName does not exist in the given Family.

svc.XStyles(family: str, stylename: str): uno

stylename: Μία από τις τεχνοτροπίες που υπάρχουν στη δεδομένη οικογένεια, ως συμβολοσειρά με διάκριση πεζών-κεφαλαίων. Το StyleName μπορεί να είναι τοπικό ή όχι.

    Dim oStyle As Object
    Set oStyle = oDoc.XStyle("ParagraphStyle", "Heading 2")
  

    oStyle = doc.XStyle('ParagraphStyle', 'Heading 2')
  

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