Naudojamos procedūros, funkcijos ir savybės
Toliau aprašo pagrindinį procedūrų, funkcijų ir savybių naudojimą LibreOffice „Beisike“.
Kai sukuriate naują modulį, LibreOffice „Beisikas“ automatiškai įterpia Sub pavadintą „Pagrindinis“. Šis numatytasis pavadinimas neturi nieko bendro su rikiavimo tvarka arba pradžios tašku LibreOffice „Beisiko“ projekte. Taip pat galite saugiai pervadinti šią Sub programą.
Kai kurie apribojimai pritaikomi viešiems kintamųjų, paprogramių, funkcijų ir savybių pavadinimams. Privalote nenaudoti tokio paties pavadinimo kaip vieno iš tos pačios bibliotekos modulių.
Procedūros (Subrutinos) funkcijos (Funkcija) ir savybės (Savybė) padeda palaikyti struktūrizuotą apžvalgą atskiriant programą į logines dalis.
Viena iš procedūrų, funkcijų ir savybių naudų yra tai, kad vos tik sukuriate programos kodą turintį užduoties komponentus, galite naudoti šį kodą kitame projekte.
Perduodami kintamieji procedūroms, funkcijoms arba savybės
Kintamieji gali būti perduoti procedūroms, funkcijoms ar savybėms. SubFunkcija arba Savybė privalo būti aprašyta tikėtiesiems parametrams:
Sub SubName(Parameter1 As TYPENAME, Parameter2 As TYPENAME,...)
' jūsų kodas eina čia
End Sub
Sub iškviečiamas naudojant toliau pateiktą sintaksę:
SubName(Value1, Value2,...)
Parametrai perduoti Sub privalo atitikti nurodytus Sub aprašus.
Tas pats procesas pritaikomas Funkcijai. Taip pat funkcijos visada grąžina funkcijos rezultatą. Funkcijos rezultatas yra apibrėžiamas priskiriant grąžinimo reikšmę funkcijos pavadinimui:
Function FunctionName(Parameter1 As TYPENAME, Parameter2 As TYPENAME,...) As TYPENAME
' jūsų kodas eina čia
FunctionName=Result
End Function
Funkcija yra iškviečiama naudojant toliau pateiktą sintaksę:
Variable=FunctionName(Parameter1, Parameter2,...)
Savybės sujungia procedūrų ir funkcijų sintaksę. Savybei dažniausiai privalo turėti iki vieno parametro.
Private _IsApproved As TYPENAME
Property Get IsApproved As TYPENAME
' jūsų kodas eina čia
IsApproved = some_computation
End Property
Property Let IsApproved(value As TYPENAME)
' jūsų kodas eina čia
_IsApproved = computed_value
End Property
Savybė yra iškviečiama naudojant toliau pateiktą sintaksę:
var = IsApproved
IsApproved = some_value
Taip pat galite naudoti pilnai patikslintą vardą iškviesti procedūrą, funkciją arba savybę:
Biblioteka.Modulis.Makrokomanda()
Pavyzdžiui, norėdami iškviesti Autoteksto makrokomandą iš Gimmicks bibliotekos, naudokite toliau pateiktą komandą:
Gimmicks.Autotekstas.Pagrindinis()
Perduodami kintamieji pagal reikšmę arba nuorodą
Parametrai gali būti perduoti procedūrai, funkcijai arba savybei pagal nuorodą arba pagal reikšmę. Kol nėra nurodyta kaip nors kitaip, parametras visada būna perduodamas pagal nuorodą. Tai reiškia, kad Sub, Funkcija arba Savybė gauna parametrą ir gali skaityti bei keisti jo reikšmę.
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)
' your code goes here
End Function
result = ReadOnlyParms(parm1, parm2)
In this case, the original content of the parameter will not be modified by the Function since it only gets the value and not the parameter itself.
Defining Optional Parameters
Functions, procedures or properties can be defined with optional parameters, for example:
Sub Rounding(number, Optional decimals, Optional format)
' your code goes here
End Sub
Scope of Variables
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.
Declaring Variables Outside a Sub a Function or a Property
Global VarName As TYPENAME
The variable is valid as long as the LibreOffice session lasts.
Public VarName As TYPENAME
The variable is valid in all modules.
Private VarName As TYPENAME
The variable is only valid in this module.
Dim VarName As TYPENAME
The variable is only valid in this module.
Example for private variables
Enforce private variables to be private across modules by setting 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
' Now returns empty string
' (or raises error for Option Explicit)
Print "Now in module2 : ", 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.
Specifying the Return Value Type of a Function or a Property
As with variables, include a type-declaration character after the function name, or the type indicated by As and the corresponding data type at the end of the parameter list to define the type of the function or property's return value, for example:
Function WordCount(WordText As String) As Integer