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. It 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 the UNO services com.sun.star.sheet.addin.Analysis, com.sun.star.sheet.addin.DateFunctions and com.sun.star.sheet.addin.PricingFunctions.

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

UNO Service Names for Analysis Add-In Functions

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

Calc Function name

UNO service name

JUROSACUM

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

JUROSACUMV

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

CUPDIASINLIQ

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

CUPDIAS

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

CUPDIASPRÓ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

PGTOJURACUM

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

PGTOCAPACUM

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

DURAÇÃO

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

DATAM

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

EFETIVA

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

FIMMÊS

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

FUNCERRO

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

FUNCERROCOMPL

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

FATDUPLO

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

VFPLANO

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

MDC

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

DEGRAU

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

IMAGINÁRIO

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

IMARG

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

IMCONJ

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

IMCOSECH

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

IMPROD

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

IMSENO

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

IMSENOH

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

IMRAIZ

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

IMSUBTR

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

IMSOMA

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

IMTAN

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

TAXAJUROS

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

ÉPAR

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

ÉÍMPAR

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

MMC

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

MDURAÇÃO

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

MARRED

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

POLINOMIAL

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

DIATRABALHOTOTAL

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

PREÇOPRIMINC

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

LUCROPRIMINC

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

PREÇOÚLTINC

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

LUCROÚLTINC

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

PREÇO

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

PREÇODESC

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

PREÇOVENC

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

QUOCIENTE

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

ALEATÓRIOENTRE

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

RECEBER

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

SOMASÉRIE

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

RAIZPI

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

OTN

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

OTNVALOR

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

OTNLUCRO

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

NÚMSEMANA

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

DIATRABALHO

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

XTIR

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

XVAL

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

FRAÇÃOANO

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

LUCRO

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

LUCRODESC

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

LUCROVENC

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


UNO Service Names for Date Add-In Functions

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

Calc Function name

UNO service name

DIASNOMÊS

com.sun.star.sheet.addin.DateFunctions.getDaysInMonth

DIASNOANO

com.sun.star.sheet.addin.DateFunctions.getDaysInMonth

MESES

com.sun.star.sheet.addin.DateFunctions.getDiffMonths

SEMANAS

com.sun.star.sheet.addin.DateFunctions.getDiffWeeks

ANOS

com.sun.star.sheet.addin.DateFunctions.getDiffYears

ROT13

com.sun.star.sheet.addin.DateFunctions.getRot13

SEMANASNOANO

com.sun.star.sheet.addin.DateFunctions.getWeeksInYear


UNO Service Names for Pricing Add-In Functions

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

Calc Function name

UNO service name

OPT_BARRIER

com.sun.star.sheet.addin.PrincingFunctions.getOptBarrier

OPT_PROB_HIT

com.sun.star.sheet.addin.PrincingFunctions.getOptProbHit

OPT_PROB_INMONEY

com.sun.star.sheet.addin.PrincingFunctions.getOptProbInMoney

OPT_TOUCH

com.sun.star.sheet.addin.PrincingFunctions.getOptTouch


Necessitamos da sua ajuda!