Using Calc Functions in Macros

In addition to the native BASIC functions, you can call Calc functions in your macros and scripts and set Calc functions in cell formulas.

Calling Internal Calc functions in Basic

Use the CreateUNOService function to access the com.sun.star.sheet.FunctionAccess service.

Exemplo:

The example below creates a function named MyVlook that calls the VLOOKUP Calc function over a data array passed as argument and returns the value found by the function.


    Function MyVlook(Lookup, DataArray As Object, Index As Integer, SortedRangeLookup as Byte)
        Dim oService As Object
        Set oService = createUnoService("com.sun.star.sheet.FunctionAccess")
        ' Always use the function name in English
        MyVlook = oService.callFunction("VLOOKUP", Array(Lookup, DataArray, Index, SortedRangeLookup))
    End Function
  

The macro below presents an example of how the MyVlook function can be called. If first creates a 5-by-2 data array and then calls the function MyVlook and shows the returned value using MsgBox.


    Sub CallingMyVlook()
        ' Creates a 5 by 2 array and fills it with data
        Dim myData(1 to 5, 1 to 2) as Variant
        myData(1, 1) = 1 : myData(1, 2) = "Strongly disagree"
        myData(2, 1) = 3 : myData(2, 2) = "Disagree"
        myData(3, 1) = 5 : myData(3, 2) = "Undecided"
        myData(4, 1) = 7 : myData(4, 2) = "Agree"
        myData(5, 1) = 9 : myData(5, 2) = "Strongly agree"
        ' Looks up the data array
        Dim result as String
        result = MyVlook(4, myData, 2, 1)
        ' Shows the message "Disagree"
        MsgBox result
    End Sub
  

Setting Cell Formulas Containing Internal Calc Functions

Use the formula text string to add a formula to a spreadsheet cell.

note

All Calc functions must be expressed with their English names.


Exemplo:


Sub AssignFormulaToCell
REM Add a formula to cell A1. Function name must be in English.
    oCell = ThisComponent.Sheets.getByIndex(0).getCellRangeByName("A1")
    oCell.Formula = "=SUM(B1:B10)"
REM Cell A1 displays the localized function name
End Sub

Calling Add-In Calc Functions in BASIC

The Calc Add-In functions are in service com.sun.star.sheet.addin.Analysis.

Exemplo:


REM Example calling Add-in function SQRTPI
Function MySQRTPI(arg as double) as double
   Dim oService as Object
   oService = createUNOService("com.sun.star.sheet.addin.Analysis")
   MySQRTPI = oService.getSqrtPi(arg)
End Function

Setting Cell Formulas with Add-In Functions

The Add-In function must be expressed by its UNO service name.

Exemplo:


Sub AssignAddInFormulaToCell
REM Add an Add-In formula to cell A1. Function name is the UNO service name.
    oCell = ThisComponent.Sheets.getByIndex(0).getCellRangeByName("A1")
    oCell.Formula = "=com.sun.star.sheet.addin.Analysis.getBin2Dec(B1)"
REM Cell A1 displays the localized function name
End Sub

Add-In Functions UNO service Names

The table below presents a list of all Calc Add-In functions and their respective UNO service names.

Calc Function name

UNO service name

XUROSACUM

com.sun.star.sheet.addin.Analysis.getAccrint

XUROSACUMV

com.sun.star.sheet.addin.Analysis.getAccrintm

AMORDEGRC

com.sun.star.sheet.addin.Analysis.getAmordegrc

AMORLINC

com.sun.star.sheet.addin.Analysis.getAmorlinc

BESSELI

com.sun.star.sheet.addin.Analysis.getBesseli

BESSELJ

com.sun.star.sheet.addin.Analysis.getBesselj

BESSELK

com.sun.star.sheet.addin.Analysis.getBesselk

BESSELY

com.sun.star.sheet.addin.Analysis.getBessely

BINADEC

com.sun.star.sheet.addin.Analysis.getBin2Dec

BINAHEX

com.sun.star.sheet.addin.Analysis.getBin2Hex

BINAOCT

com.sun.star.sheet.addin.Analysis.getBin2Oct

COMPLEXO

com.sun.star.sheet.addin.Analysis.getComplex

CONVERTER

com.sun.star.sheet.addin.Analysis.getConvert

CUPDÍASATÉLIQ

com.sun.star.sheet.addin.Analysis.getCoupdaybs

CUPDÍAS

com.sun.star.sheet.addin.Analysis.getCoupdays

CUPDÍASPRÓX

com.sun.star.sheet.addin.Analysis.getCoupdaysnc

CUPDATAPRÓX

com.sun.star.sheet.addin.Analysis.getCoupncd

CUPNÚM

com.sun.star.sheet.addin.Analysis.getCoupnum

CUPDATAANT

com.sun.star.sheet.addin.Analysis.getCouppcd

PGTOXUROSACUM

com.sun.star.sheet.addin.Analysis.getCumipmt

PGTOPRINCACUM

com.sun.star.sheet.addin.Analysis.getCumprinc

DECABIN

com.sun.star.sheet.addin.Analysis.getDec2Bin

DECAHEX

com.sun.star.sheet.addin.Analysis.getDec2Hex

DECAOCT

com.sun.star.sheet.addin.Analysis.getDec2Oct

DELTA

com.sun.star.sheet.addin.Analysis.getDelta

DESC

com.sun.star.sheet.addin.Analysis.getDisc

MOEDADEC

com.sun.star.sheet.addin.Analysis.getDollarde

MOEDAFRA

com.sun.star.sheet.addin.Analysis.getDollarfr

DURACIÓN

com.sun.star.sheet.addin.Analysis.getDuration

DATAM

com.sun.star.sheet.addin.Analysis.getEdate

EFECTO

com.sun.star.sheet.addin.Analysis.getEffect

FINMES

com.sun.star.sheet.addin.Analysis.getEomonth

FUNERRO

com.sun.star.sheet.addin.Analysis.getErf

FUNERROCOMPL

com.sun.star.sheet.addin.Analysis.getErfc

FACTDUPLO

com.sun.star.sheet.addin.Analysis.getFactdouble

VFPROGRAMA

com.sun.star.sheet.addin.Analysis.getFvschedule

MDC

com.sun.star.sheet.addin.Analysis.getGcd

MAIOROUIGUAL

com.sun.star.sheet.addin.Analysis.getGestep

HEXABIN

com.sun.star.sheet.addin.Analysis.getHex2Bin

HEXADEC

com.sun.star.sheet.addin.Analysis.getHex2Dec

HEXAOCT

com.sun.star.sheet.addin.Analysis.getHex2Oct

IMABS

com.sun.star.sheet.addin.Analysis.getImabs

IMAXINARIO

com.sun.star.sheet.addin.Analysis.getImaginary

IMARGUMENTO

com.sun.star.sheet.addin.Analysis.getImargument

IMCONX

com.sun.star.sheet.addin.Analysis.getImconjugate

IMCOS

com.sun.star.sheet.addin.Analysis.getImcos

IMCOSH

com.sun.star.sheet.addin.Analysis.getImcosh

IMCOT

com.sun.star.sheet.addin.Analysis.getImcot

IMCSC

com.sun.star.sheet.addin.Analysis.getImcsc

IMCSCH

com.sun.star.sheet.addin.Analysis.getImcsch

IMDIV

com.sun.star.sheet.addin.Analysis.getImdiv

IMEXP

com.sun.star.sheet.addin.Analysis.getImexp

IMLN

com.sun.star.sheet.addin.Analysis.getImln

IMLOG10

com.sun.star.sheet.addin.Analysis.getImlog10

IMLOG2

com.sun.star.sheet.addin.Analysis.getImlog2

IMPOT

com.sun.star.sheet.addin.Analysis.getImpower

IMPRODUTO

com.sun.star.sheet.addin.Analysis.getImproduct

IMREAL

com.sun.star.sheet.addin.Analysis.getImreal

IMSEC

com.sun.star.sheet.addin.Analysis.getImsec

IMSECH

com.sun.star.sheet.addin.Analysis.getImsech

IMSIN

com.sun.star.sheet.addin.Analysis.getImsin

IMSINH

com.sun.star.sheet.addin.Analysis.getImsinh

IMRAÍZ

com.sun.star.sheet.addin.Analysis.getImsqrt

IMSUBTR

com.sun.star.sheet.addin.Analysis.getImsub

IMSUMA

com.sun.star.sheet.addin.Analysis.getImsum

IMTAN

com.sun.star.sheet.addin.Analysis.getImtan

TAXAXUROS

com.sun.star.sheet.addin.Analysis.getIntrate

ÉPAR

com.sun.star.sheet.addin.Analysis.getIseven

ÉIMPAR

com.sun.star.sheet.addin.Analysis.getIsodd

MMC

com.sun.star.sheet.addin.Analysis.getLcm

MDURACIÓN

com.sun.star.sheet.addin.Analysis.getMduration

MARRED

com.sun.star.sheet.addin.Analysis.getMround

MULTINOMIAL

com.sun.star.sheet.addin.Analysis.getMultinomial

DÍASÚTILESTOTAIS

com.sun.star.sheet.addin.Analysis.getNetworkdays

NOMINAL

com.sun.star.sheet.addin.Analysis.getNominal

OCTABIN

com.sun.star.sheet.addin.Analysis.getOct2Bin

OCTADEC

com.sun.star.sheet.addin.Analysis.getOct2Dec

OCTAHEX

com.sun.star.sheet.addin.Analysis.getOct2Hex

PREZOPRIMIRR

com.sun.star.sheet.addin.Analysis.getOddfprice

BENEFPRIMIRR

com.sun.star.sheet.addin.Analysis.getOddfyield

PREZOÚLTIRR

com.sun.star.sheet.addin.Analysis.getOddlprice

BENEFÚLTIRR

com.sun.star.sheet.addin.Analysis.getOddlyield

PREZO

com.sun.star.sheet.addin.Analysis.getPrice

PREZODESC

com.sun.star.sheet.addin.Analysis.getPricedisc

PREZOVENC

com.sun.star.sheet.addin.Analysis.getPricemat

COCIENTE

com.sun.star.sheet.addin.Analysis.getQuotient

ALEATORIOENTRE

com.sun.star.sheet.addin.Analysis.getRandbetween

RECIBIDO

com.sun.star.sheet.addin.Analysis.getReceived

SUMARSECUENCIA

com.sun.star.sheet.addin.Analysis.getSeriessum

RAÍZPI

com.sun.star.sheet.addin.Analysis.getSqrtpi

LETTESEQ

com.sun.star.sheet.addin.Analysis.getTbilleq

LETTESPREZO

com.sun.star.sheet.addin.Analysis.getTbillprice

LETTESBENEF

com.sun.star.sheet.addin.Analysis.getTbillyield

SEMANACALENDARIO

com.sun.star.sheet.addin.Analysis.getWeeknum

DÍAÚTIL

com.sun.star.sheet.addin.Analysis.getWorkday

XTID

com.sun.star.sheet.addin.Analysis.getXirr

XVPL

com.sun.star.sheet.addin.Analysis.getXnpv

FRACCIÓNANO

com.sun.star.sheet.addin.Analysis.getYearfrac

BENEFICIOS

com.sun.star.sheet.addin.Analysis.getYield

BENEFDESC

com.sun.star.sheet.addin.Analysis.getYielddisc

BENEFVENC

com.sun.star.sheet.addin.Analysis.getYieldmat


Precisamos da súa axuda!