Using Procedures, Functions and Properties

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ę:

  [Call] SubName( [Parameter1:=]Value1, [Parameter2:=]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:=]Value1, [Parameter2:=]Value2, ...)

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
      ' 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

You can also use the fully qualified name to call a procedure, function or property:
[Call] Library.Module.Macro(), where Call is optional.
For example, to call the Autotext macro from the Gimmicks library, use the following command:
Gimmicks.AutoText.Main()

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ę.

Jei norite perduoti parametrą reikšme, kreipdamiesi į paprogramę , funkciją arba savybę prieš parametrą įterpkite bazinį žodį ByVal, pavyzdžiui:

  Function ReadOnlyParms(ByVal p2, ByVal p2)
      ' jūsų kodas eina čia
  End Function
  result = ReadOnlyParms(parm1, parm2)

Tokiu atveju Funkcija nepakeis pirminio parametro turinio, nes gauna tik reikšmę, o ne patį parametrą.

Pasirenkamų parametrų aprašymas

Funkcijas, procedūras ar savybes galima apibrėžti pasirinktinais parametrais, pavyzdžiui:

  Sub Rounding(number, Optional decimals, Optional format)
      ' jūsų kodas eina čia
  End Sub

Positional or Keyword Arguments

When you call a function or a subroutine, you may pass its arguments by position or by name. Passing by position means just listing the arguments in the order in which the parameters are defined in the function or subroutine. Passing by name requires you to prefix the argument with the name of the corresponding parameter followed by a colon and an equal sign (:=). Keyword arguments may appear in any order. Refer to Basic Replace() function for such examples.

When needing to pass less parameters, use keywords arguments. Passing values for fewer parameters by position requires to supply values for all parameters before them, optional or not. This ensures that the values are in the correct positions. If you pass the parameters by name - using keyword arguments - you may omit all other intermediate arguments.

Kintamųjų sritis

Kintamasis, apibrėžtas naudojant Paprogramė , Funkcija arba Ypatybė , galioja tik tol, kol bus baigta procedūra. Tai vadinama vietiniu arba lokaliuoju kintamuoju. Daugeliu atvejų reikia, kad kintamasis galiotų visose procedūrose, visuose bibliotekų moduliuose arba netgi įvykdžius Paprogramė , Funkcija ar Ypatybė .

Kintamųjų aprašymas išorėje: Paprogramė, Funkcija arba Savybė

Global VarName As TYPENAME

Kintamasis galioja tol, kol tęsiasi „LibreOffice“ sesija.

Public VarName As TYPENAME

Kintamasis galioja visuose moduliuose.

Private VarName As TYPENAME

Kintamasis galioja tik šiame modulyje.

Dim VarName As TYPENAME

Kintamasis galioja tik šiame modulyje.

Privačių kintamųjų pavyzdys

Naudodami Suderinimo veiksena(True) nustatykite, kad privatūs kintamieji būtų privatūs visuose moduliuose.

  ' ***** Module1 *****
  Private myText As String
  Sub initMyText
      manoTekstas = "Hello"
      Spausdinkite „Modulyje1: “, manoTekstas
  End Sub
   
  ' ***** Module2 *****
  'Option Explicit
  Sub demoBug
      CompatibilityMode( True )
      initMyText
      ' Dabar pateikia tuščią eilutę
      ' (arba tiesioginei parinkčiai sukelia klaidą)
      Spausdinkite „Dabar modulyje 2: “, manoTekstas
  End Sub

Kintamojo turinio išsaugojimas išėjus iš Parogramė, Funkcija arba Savybė

  Static VarName As TYPENAME

Kintamasis išlaiko savo reikšmę iki kito karto, kol Funkcija, Paprogramė arba Savybė veikia. Aprašyta turi būti viduje: Paprogramė, Funkcija arba Savybė.

Grąžinamos reikšmės tipo nustatymas čia: Funkcija arba Savybė

Kaip ir aprašant kintamuosius, po funkcijos pavadinimo įtraukite tipo aprašo simbolį arba nurodytą tipą Kaip ir atitinkamą duomenų tipą parametrų sąrašo pabaigoje, kad apibrėžtumėte funkcijos ar savybės grąžinimo reikšmę, pavyzdžiui:

  Function WordCount(WordText As String) As Integer