Usare le procedure, le funzioni e le proprietĂ 

The following describes the basic use of procedures, functions and properties in LibreOffice Basic.

note

When you create a new module, LibreOffice Basic automatically inserts a Sub called "Main". This default name has nothing to do with the order or the starting point of a LibreOffice Basic project. You can also safely rename this Subroutine.


note

Ai nomi delle variabili, subroutine, funzioni e proprietĂ  pubbliche si applicano alcune restrizioni Non dovete usare lo stesso nome utilizzato come nome di uno dei moduli della stessa libreria.


Procedures (Subroutines) functions (Function) and properties (Property) help you maintaining a structured overview by separating a program into logical pieces.

Uno dei vantaggi delle procedure, delle funzioni e delle proprietà è che, una volta sviluppato un codice di programma con componenti per un dato compito, potete usare lo stesso codice per altri progetti.

Passare variabili alle procedure, alle funzioni o alle proprietĂ 

Variables can be passed to both procedures, functions or properties. The Sub Function or Property must be declared to expect parameters:


  Sub SubName(Parameter1 As TYPENAME, Parameter2 As TYPENAME,...)
      ' il vostro codice va qui
  End Sub

La Sub (subroutine) viene chiamata con la sintassi seguente:


  SubName(Value1, Value2,...)

I parametri passati a una Sub devono corrispondere a quelli specificati nella relativa dichiarazione Sub.

Lo stesso procedimento può essere applicato a unaFunzione per restituire il risultato di una funzione Tale risultato può essere definito direttamente prima di raggiungere la fine della funzione, assegnando il nome della funzione e un parametro al valore che dovrà essere restituito dalla funzione:


  Function FunctionName(Parameter1 As TYPENAME, Parameter2 As TYPENAME,...) As TYPENAME
      ' il vostro codice va qui
      FunctionName=Result
  End Function

La Funzione viene chiamata con la sintassi seguente:


  Variable=FunctionName(Parameter1, Parameter2,...)

Properties combine the syntax of procedures and functions. A property usually requires up to one parameter.


  Private _IsApproved As TYPENAME
  Property Get IsApproved As TYPENAME
      ' il vostro codice va qui
      IsApproved = some_computation
  End Property
  Property Let IsApproved(value As TYPENAME)
      ' il vostro codice va qui
      _IsApproved = computed_value
  End Property

La ProprietĂ  viene chiamata con la sintassi seguente:


  var = IsApproved
  IsApproved = some_value
tip

Potete usare anche un nome qualificato per richiamare una procedura, funzione o proprietĂ :br/> Library.Module.Macro()
Ad esempio, richiamate la macro per il testo automatico dalla libreria Gimmicks col seguente comando:
Gimmicks. AutoText.Main()


Passare le variabili per valore o riferimento

Parameters can be passed to a procedure, a function or a property either by reference or by value. Unless otherwise specified, a parameter is always passed by reference. That means that a Sub, a Function or a Property gets the parameter and can read and modify its value.

If you want to pass a parameter by value insert the key word ByVal in front of the parameter when you call a Sub, a Function or a Property, for example:


  Function ReadOnlyParms(ByVal p2, ByVal p2)
      ' il vostro codice va qui
  End Function
  result = ReadOnlyParms(parm1, parm2)

In questo caso, il contenuto originale del parametro non verrà modificato dalla Funzione, poiché questa riceverà solo il valore e non il parametro vero e proprio.

Definire parametri opzionali

Functions, procedures or properties can be defined with optional parameters, for example:


  Sub Rounding(number, Optional decimals, Optional format)
      ' il vostro codice va qui
  End Sub

Ambito delle variabili

A variable defined within a Sub, a Function or a Property, only remains valid until the procedure is exited. This is known as a "local" variable. In many cases, you need a variable to be valid in all procedures, in every module of all libraries, or after a Sub, a Function or a Property is exited.

Dichiarare variabili al di fuori di una Sub, una Function o una Property


Global VarName As TYPENAME

La variabile è valida per la durata della sessione di LibreOffice.


Public VarName As TYPENAME

La variabile è valida in tutti i moduli.


Private VarName As TYPENAME

La variabile è valida solo nel modulo attivo.


Dim VarName As TYPENAME

La variabile è valida solo nel modulo attivo.

Esempio per variabili private

Forza le variabili private a rimanere tali in altri moduli impostando CompatibilityMode(True).


  ' ***** Module1 *****
  Private myText As String
  Sub initMyText
      myText = "Ciao"
      Stampa "In modulo1 : ", myText
  End Sub
   
  ' ***** Module2 *****
  'Option Explicit
  Sub demoBug
      CompatibilityMode( True )
      initMyText
      ' Ora restituisce una stringa vuota
      ' (o eleva errore per Option Explicit)
      Stampa "Ora in modulo2 : ", myText
  End Sub

Saving Variable Content after Exiting a Sub a Function or a Property


  Static VarName As TYPENAME

The variable retains its value until the next time the a Function, Sub or Property is entered. The declaration must exist inside a Sub, a Function or a Property.

Specificare il tipo di valore di ritorno di una Function o di una Property

Come per le variabili, per definire il tipo di valore restituito della funzione o della proprietĂ  inserite un carattere di dichiarazione del tipo dopo il nome della funzione, oppure il tipo indicato da As e dal tipo di dati corrispondente, alla fine dell'elenco dei parametri, ad esempio:


  Function WordCount(WordText As String) As Integer