Procedures, Functies of Eigenschappen gebruiken

Het volgende beschrijft het standaard gebruik van procedures, functies en eigenschappen in LibreOffice BASIC.

Wanneer u een nieuwe module aanmaakt, voegt LibreOffice BASIC automatisch een Sub aan genaamd "Main". Deze standaardnaam heeft niets te maken met de opdracht of het startpunt van een LibreOffice BASIC-project. U kunt deze Subroutine ook veilig hernoemen..

Er gelden enkele beperkingen voor de namen van uw openbare variabelen, subroutines, functies en eigenschappen. U mag niet dezelfde naam gebruiken als één van de modules van dezelfde bibliotheek.

Procedures (Subroutines) functies (Function) en eigenschappen (Property) helpen u een gestructureerd overzicht te behouden door een programma in logische stukken te scheiden.

Een voordeel van procedures, functies en eigenschappen is dat je, als u eenmaal een programmacode met taakcomponenten hebt ontwikkeld, deze code in een ander project kunt gebruiken.

Variabelen doorgeven aan procedures, functies of eigenschappen

Variabelen kunnen worden doorgegeven aan zowel procedures, functies als eigenschappen. De Sub Functie of Eigenschap moet worden gedeclareerd om parameters te verwachten:

  Sub SubName(Parameter1 As TYPENAME, Parameter2 As TYPENAME,...)
      ' uw code komt hier
  End Sub

De Sub wordt aangeroepen met de volgende syntaxis:

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

De parameters die aan een Sub worden doorgegeven, moeten passen bij die gespecificeerd in de Sub declaratie.

Hetzelfde proces is van toepassing op een Function. Bovendien retourneren functies altijd een functieresultaat. Het resultaat van een functie wordt gedefinieerd door de retourwaarde toe te wijzen aan de functienaam:

  Function FunctionName(Parameter1 As TYPENAME, Parameter2 As TYPENAME,...) As TYPENAME
      ' uw code komt hier
      FunctionName=Result
  End Function

De Functie wordt aangeroepen met de volgende syntaxis:

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

Eigenschappen combineren de syntaxis van procedures en functies. Een Eigenschap heeft meestal geen of één parameter.

  Private _IsApproved As TYPENAME
  Property Get IsApproved As TYPENAME
      ' uw code komt hier
      IsApproved = some_computation
  End Property
  Property Let IsApproved(value As TYPENAME)
      ' uw code komt hier
      _IsApproved = computed_value
  End Property

De Eigenschap wordt aangeroepen met de volgende syntaxis:

  var = IsApproved
  IsApproved = some_value

U kunt ook de volledige naam gebruiken om een procedure, functie of eigenschap te benoemen:
[Call] Library.Module.Macro(), hier is Call optioneel.
U kunt bijvoorbeeld de macro Autotext in de bibliotheek aanroepen met:
Gimmicks.AutoText.Main()

Variabelen op waarde of verwijzing doorgeven

Parameters kunnen worden doorgegeven aan een procedure, een functie of een eigenschap, hetzij door middel van verwijzing, hetzij door waarde. Tenzij anders aangegeven, wordt een parameter altijd door middel van verwijzing doorgegeven. Dat betekent dat een Sub, een Functie of een Eigenschap de parameter krijgt en de waarde ervan kan lezen en wijzigen.

Als u een parameter per waarde wilt doorgeven, plaatst u het sleutelwoord ByVal vóór de parameter wanneer u een Sub, een Functie of een Eigenschap, bijvoorbeeld:

  Function ReadOnlyParms(ByVal p2, ByVal p2)
      ' uw code komt hier
  End Function
  result = ReadOnlyParms(parm1, parm2)

In dit geval wordt de oorspronkelijke inhoud van de parameter niet gewijzigd door de Functie aangezien deze alleen de waarde krijgt en niet de parameter zelf.

Optionele parameters definiëren

Functies, procedures of eigenschappen kunnen worden gedefinieerd met optionele parameters, bijvoorbeeld:

  Sub Rounding(number, Optional decimals, Optional format)
      ' uw code komt hier
  End Sub

Positionele of Sleutelwoord Argumenten

U kunt een functie of subroutine aanroepen waarbij u de argumenten met hun plaats of met hun naam kunt aangegeven. Aanroepen op positie betekent dat u de argumenten in volgorde van het definiëren van de parameters in de functie of subroutine moet opgeven. Aanroepen op sleutelwoord betekent dat u eerst de parameter moet noemen dan een dubbele punt met een gelijkteken (:=) en dan pas de waarde. De sleutelwoorden mogen in elke volgorde staan. Bij de Basis-functie Replace() staan voorbeelden.

Als u niet veel argumenten hoeft door te geven, raden wij het gebruik van sleutelwoorden aan. Bij positionele aanroep moet u waarden voor alle parameters voor uw benodigde parameter doorgeven, ongeacht optioneel of niet. Dit zorgt ervoor dat de waarden op de goede plaatsen staan. Bij het gebruik van sleutelwoorden kunt u de optionele parameters overslaan.

Bereik van variabelen

Een variabele gedefinieerd binnen een Sub, een Functie of een Eigenschap, blijft alleen geldig totdat de procedure wordt afgesloten. Dit staat bekend als een "lokale" variabele. In veel gevallen heb je een variabele nodig die geldig is in alle procedures, in elke module van alle bibliotheken, of na een Sub, een Functie of een Eigenschap is verlaten.

Variabelen declareren buiten een Sub een Functie of een Eigenschap

Global VarName As TYPENAME

De variabele is geldig zolang de LibreOffice sessie duurt.

Public VarName As TYPENAME

De variabele is geldig in alle modules.

Private VarName As TYPENAME

De variabele is alleen geldig in deze module.

Dim VarName As TYPENAME

De variabele is alleen geldig in deze module.

Voorbeeld van privé variabelen

Zorg ervoor dat privévariabelen zeker privé zijn in alle modules door CompatibilityMode(True).

  ' ***** Module1 *****
  Private myText As String
  Sub initMyText
      myText = "Hallo"
      Print "In module1 : ", mijnTekst
  End Sub
   
  ' ***** Module2 *****
  'Option Explicit
  Sub demoBug
      CompatibilityMode( True )
      initMyText
      ' Geeft een lege string weer
      ' (of verhoogt de fout voor Optie Expliciet)
      Print "Now in module2 : ", mijnTekst
  End Sub

Variabele inhoud opslaan na het verlaten van een Sub een Functie of een Eigenschap

  Static VarName As TYPENAME

De variabele behoudt zijn waarde tot de volgende keer dat de Functie, Sub of Eigenschap wordt ingevoerd. De declaratie moet bestaan binnen een Sub, een Functie of een Eigenschap.

Het type retourwaarde specificeren van een Functie of een Eigenschap

Voeg, net als bij variabelen, een declaratieteken toe na de functienaam of het type aangegeven door As en het overeenkomstige gegevenstype aan het einde van de parameterlijst om het type van de functie of de terugkeer van de eigenschap te definiëren waarde, bijvoorbeeld:

  Function WordCount(WordText As String) As Integer