Χρήση διεργασιών, συναρτήσεων και ιδιοτήτων

Τα παρακάτω περιγράφουν τη βασική χρήση των διεργασιών, συναρτήσεων και ιδιοτήτων στη LibreOffice Basic.

Όταν δημιουργείτε νέο άρθρωμα, το LibreOffice Basic εισάγει αυτόματα ένα Sub που ονομάζεται "Main". Αυτό το προεπιλεγμένο όνομα δεν έχει τίποτα να κάνει με τη σειρά ή το σημείο έναρξης έργου της LibreOffice Basic. Μπορείτε επίσης να μετονομάσετε με ασφάλεια αυτήν την ρουτίνα Sub.

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

Οι διεργασίες (ρουτινών Sub) συναρτήσεων (Function) και ιδιοτήτων (Property) σας βοηθούν να διατηρήσετε μια δομημένη επισκόπηση ξεχωρίζοντας ένα πρόγραμμα σε λογικά τμήματα.

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

Μεταβίβαση μεταβλητών σε διεργασίες, συναρτήσεις ή ιδιότητες

Οι μεταβλητές μπορούν να μεταβιβαστούν και σε διεργασίες, συναρτήσεις ή ιδιότητες. Η Sub Function ή Property πρέπει να δηλώνονται στις αναμενόμενες παραμέτρους:

  Sub SubName(Parameter1 As TYPENAME, Parameter2 As TYPENAME,...)
      'ο κώδικας σας πηγαίνει εδώ
  End Sub

Η Sub καλείται χρησιμοποιώντας την παρακάτω σύνταξη:

  [Call] SubName( [Parameter1:=]Value1, [Parameter2:=]Value2, ...)

Οι παράμετροι που μεταβιβάστηκαν σε μια Sub πρέπει να ταιριάζουν με αυτές που ορίστηκαν στη δήλωση Sub.

Η ίδια διαδικασία εφαρμόζεται σε Function. Επιπλέον, οι συναρτήσεις επιστρέφουν πάντα αποτέλεσμα συνάρτησης. Το αποτέλεσμα συνάρτησης ορίζεται αποδίδοντας την επιστρεφόμενη τιμή στο όνομα της συνάρτησης:

  Function FunctionName(Parameter1 As TYPENAME, Parameter2 As TYPENAME,...) As TYPENAME
      'ο κώδικας σας πηγαίνει εδώ
      FunctionName=Result
  End Function

Η Function καλείται χρησιμοποιώντας την ακόλουθη σύνταξη:

  Variable = FunctionName( [Parameter1:=]Value1, [Parameter2:=]Value2, ...)

Οι ιδιότητες συνδυάζουν τη σύνταξη διαδικασιών και συναρτήσεων. Μια Property συνήθως απαιτεί έως και μία παράμετρο.

  Private _IsApproved As TYPENAME
  Property Get IsApproved As TYPENAME
      'ο κώδικας σας πηγαίνει εδώ
      IsApproved = some_computation
  End Property
  Property Let IsApproved(value As TYPENAME)
      'ο κώδικας σας πηγαίνει εδώ
      _IsApproved = computed_value
  End Property

Η Property καλείται χρησιμοποιώντας την παρακάτω σύνταξη:

  var = IsApproved
  IsApproved = some_value

Μπορείτε επίσης να χρησιμοποιήσετε το πλήρως προσδιορισμένο όνομα για να καλέσετε μια διαδικασία, μια συνάρτηση ή μια ιδιότητα:
[Call] Library.Module.Macro(), όπου η Call είναι προαιρετική .
Για παράδειγμα, για να καλέσετε τη μακροεντολή Autotext από τη βιβλιοθήκη Gimmicks, χρησιμοποιήστε την ακόλουθη εντολή:
Gimmicks.AutoText.Main()

Μεταβίβαση μεταβλητών ως τιμής ή ως αναφοράς

Οι παράμετροι μπορούν να μεταβιβαστούν σε μια διαδικασία, συνάρτηση ή ιδιότητα είτε με αναφορά, είτε με τιμή. Εκτός και προσδιορίζεται αλλιώς, μια παράμετρος μεταβιβάζεται πάντα με αναφορά. Αυτό σημαίνει ότι μια Sub, Function ή Property παίρνει την παράμετρο και μπορεί να διαβιβάσει ή να τροποποιήσει την τιμή της.

Εάν θέλετε να περάσετε μια παράμετρο με τιμή εισάγετε τη λέξη κλειδί ByVal μπροστά από την παράμετρο όταν καλείτε Sub, Function ή Property, παραδείγματος χάρη:

  Function ReadOnlyParms(ByVal p2, ByVal p2)
      'ο κώδικας σας πηγαίνει εδώ
  End Function
  result = ReadOnlyParms(parm1, parm2)

Σε αυτήν την περίπτωση, το αρχικό περιεχόμενο της παραμέτρου δεν θα τροποποιηθεί με την Function επειδή παίρνει μόνο την τιμή και όχι την ίδια την παράμετρο.

Καθορισμός των προαιρετικών παραμέτρων

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

  Sub Rounding(number, Optional decimals, Optional format)
      'ο κώδικας σας πηγαίνει εδώ
  End Sub

Ορίσματα θέσης ή λέξης-κλειδιού

Όταν καλείτε μια συνάρτηση ή μια υπορουτίνα, μπορείτε να μεταβιβάσετε τα ορίσματά της κατά θέση ή όνομα. Η μεταβίβαση από τη θέση σημαίνει απλώς την παράθεση των ορισμάτων με τη σειρά με την οποία ορίζονται οι παράμετροι στη συνάρτηση ή την υπορουτίνα. Η μετάβαση με βάση το όνομα απαιτεί την προσθήκη προθέματος στο όρισμα με το όνομα της αντίστοιχης παραμέτρου ακολουθούμενο από άνω και κάτω τελεία και σύμβολο ίσου (:=). Τα ορίσματα λέξεων-κλειδιών μπορούν να εμφανίζονται με οποιαδήποτε σειρά. Ανατρέξτε στη συνάρτηση Basic Replace() για τέτοια παραδείγματα.

Όταν χρειάζεται να μεταβιβάσετε λιγότερες παραμέτρους, χρησιμοποιήστε ορίσματα λέξεων-κλειδιών. Η μεταβίβαση τιμών για λιγότερες παραμέτρους ανά θέση απαιτεί την παροχή τιμών για όλες τις παραμέτρους πριν από αυτές, προαιρετικές ή μη. Αυτό διασφαλίζει ότι οι τιμές βρίσκονται στις σωστές θέσεις. Εάν μεταβιβάσετε τις παραμέτρους κατά όνομα - χρησιμοποιώντας ορίσματα λέξεων-κλειδιών - μπορείτε να παραλείψετε όλα τα άλλα ενδιάμεσα ορίσματα.

Εμβέλεια των μεταβλητών

Μια μεταβλητή καθορισμένη μέσα σε Sub, Function ή Property, παραμένει έγκυρη μόνο μέχρι η διεργασία να εξέλθει. Αυτή είναι γνωστή ως "τοπική" μεταβλητή. Σε πολλές περιπτώσεις, χρειαζόσαστε μια μεταβλητή να είναι έγκυρη σε όλες τις διεργασίες, σε κάθε άρθρωμα όλων των βιβλιοθηκών, ή μετά από την έξοδο Sub, Function ή Property.

Δήλωση μεταβλητών εκτός Sub, Function ή Property

Global VarName As TYPENAME

Η μεταβλητή είναι έγκυρη όσο η συνεδρία του LibreOffice διαρκεί.

Public VarName As TYPENAME

Η μεταβλητή είναι έγκυρη σε όλα τα αρθρώματα.

Private VarName As TYPENAME

Η μεταβλητή ισχύει μόνο σε αυτό το άρθρωμα.

Dim VarName As TYPENAME

Η μεταβλητή ισχύει μόνο σε αυτό το άρθρωμα.

Παράδειγμα για τις ιδιωτικές μεταβλητές

Εξαναγκασμός ιδιωτικών μεταβλητών να είναι ιδιωτικές σε όλα τα αρθρώματα ορίζοντας το CompatibilityMode(True).

  ' ***** Module1 *****
  Private myText As String
  Sub initMyText
      myText = "Hello"
      print "in module1 : ", myText
  End Sub
   
  ' ***** Module2 *****
  'Option Explicit
  Sub demoBug
      CompatibilityMode( True )
      initMyText
      ' Τώρα επιστρέφει κενή συμβολοσειρά
      ' (ή δημιουργεί σφάλμα για Option Explicit (ρητή επιλογή))
      print "Now in module2 : ", τοΚείμενοΜου
  End Sub

Αποθήκευση περιεχομένου μεταβλητής μετά την έξοδο Sub Function ή Property

  Static VarName As TYPENAME

Η μεταβλητή διατηρεί την τιμή της μέχρι την επόμενη φορά που εισάγεται μια Function, Sub ή Property. Η δήλωση πρέπει να υπάρχει μέσα σε Sub, Function ή Property.

Καθορισμός τύπου τιμής επιστροφής Function ή Property

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

  Function WordCount(WordText As String) As Integer