1cdf0e10cSrcweir<?xml version="1.0" encoding="UTF-8"?> 211028d3cSmseidel 352ac0773SAndrew Rist<!--*********************************************************** 411028d3cSmseidel * 552ac0773SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 652ac0773SAndrew Rist * or more contributor license agreements. See the NOTICE file 752ac0773SAndrew Rist * distributed with this work for additional information 852ac0773SAndrew Rist * regarding copyright ownership. The ASF licenses this file 952ac0773SAndrew Rist * to you under the Apache License, Version 2.0 (the 1052ac0773SAndrew Rist * "License"); you may not use this file except in compliance 1152ac0773SAndrew Rist * with the License. You may obtain a copy of the License at 1211028d3cSmseidel * 1352ac0773SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 1411028d3cSmseidel * 1552ac0773SAndrew Rist * Unless required by applicable law or agreed to in writing, 1652ac0773SAndrew Rist * software distributed under the License is distributed on an 1752ac0773SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 1852ac0773SAndrew Rist * KIND, either express or implied. See the License for the 1952ac0773SAndrew Rist * specific language governing permissions and limitations 2052ac0773SAndrew Rist * under the License. 2111028d3cSmseidel * 2252ac0773SAndrew Rist ***********************************************************--> 2352ac0773SAndrew Rist 2411028d3cSmseidel<helpdocument version="1.0"> 25cdf0e10cSrcweir<meta> 26cdf0e10cSrcweir<topic id="textscalc0104060111xml" indexer="include"> 27cdf0e10cSrcweir<title id="tit" xml-lang="en-US">Add-in Functions</title> 28cdf0e10cSrcweir<filename>/text/scalc/01/04060111.xhp</filename> 29cdf0e10cSrcweir</topic> 30cdf0e10cSrcweir</meta> 31cdf0e10cSrcweir<body> 32*88cae784Smseidel<bookmark xml-lang="en-US" branch="index" id="bm_id3150870"> 33*88cae784Smseidel<bookmark_value>add-ins; functions</bookmark_value> 34cdf0e10cSrcweir<bookmark_value>functions; add-in functions</bookmark_value> 35cdf0e10cSrcweir<bookmark_value>Function Wizard; add-ins</bookmark_value> 36cdf0e10cSrcweir</bookmark> 37cdf0e10cSrcweir<paragraph role="heading" id="hd_id3150870" xml-lang="en-US" level="1" l10n="U" oldref="1">Add-in Functions</paragraph> 38cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3147427" xml-lang="en-US" l10n="CHG" oldref="2"><variable id="addintext">The following describes and lists some of the available add-in functions. 39cdf0e10cSrcweir</variable></paragraph> 40cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3163713" xml-lang="en-US" l10n="U" oldref="75"><link href="text/scalc/01/04060112.xhp#addinconcept">Add-in concept</link></paragraph> 41cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3146120" xml-lang="en-US" l10n="U" oldref="5">You will also find a <link href="text/scalc/01/04060112.xhp">description of the $[officename] Calc add-in interface</link> in the Help. In addition, important functions and their parameters are described in the Help for the <switchinline select="sys"><caseinline select="UNIX">Shared Library 42cdf0e10cSrcweir</caseinline><defaultinline>$[officename] Calc add-in DLL</defaultinline></switchinline>.</paragraph> 43cdf0e10cSrcweir<paragraph role="heading" id="hd_id3151075" xml-lang="en-US" level="2" l10n="U" oldref="7">Add-ins supplied</paragraph> 44cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3156285" xml-lang="en-US" l10n="CHG" oldref="8">$[officename] contains examples for the add-in interface of $[officename] Calc.</paragraph> 45cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3159267" xml-lang="en-US" l10n="U" oldref="76"><link href="text/scalc/01/04060115.xhp">Analysis Functions Part One</link></paragraph> 46cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3154703" xml-lang="en-US" l10n="U" oldref="77"><link href="text/scalc/01/04060116.xhp">Analysis Functions Part Two</link></paragraph> 47cdf0e10cSrcweir<sort order="asc"> 48cdf0e10cSrcweir<section id="isleapyear"> 49*88cae784Smseidel<bookmark xml-lang="en-US" branch="index" id="bm_id3149566"> 50*88cae784Smseidel<bookmark_value>ISLEAPYEAR function</bookmark_value> 51cdf0e10cSrcweir<bookmark_value>leap year determination</bookmark_value> 52cdf0e10cSrcweir</bookmark><comment>mw added one entry</comment> 53cdf0e10cSrcweir<paragraph role="heading" id="hd_id3149566" xml-lang="en-US" level="2" l10n="U" oldref="14">ISLEAPYEAR</paragraph> 54cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3150297" xml-lang="en-US" l10n="U" oldref="15"><ahelp hid=".">Determines whether a year is a leap year.</ahelp> If yes, the function will return the value 1 (TRUE); if not, it will return 0 (FALSE).</paragraph> 55cdf0e10cSrcweir<paragraph role="heading" id="hd_id3148487" xml-lang="en-US" level="3" l10n="U" oldref="16">Syntax</paragraph> 56cdf0e10cSrcweir<paragraph role="code" id="par_id3150205" xml-lang="en-US" l10n="U" oldref="17">ISLEAPYEAR("Date")</paragraph> 57cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3159239" xml-lang="en-US" l10n="U" oldref="18"> 58cdf0e10cSrcweir<emph>Date</emph> specifies whether a given date falls within a leap year. The Date parameter must be a valid date according to the locale settings of %PRODUCTNAME.</paragraph> 59cdf0e10cSrcweir<paragraph role="heading" id="hd_id3149817" xml-lang="en-US" level="3" l10n="U" oldref="19">Example</paragraph> 60cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3150786" xml-lang="en-US" l10n="CHG" oldref="20">=ISLEAPYEAR(A1) returns 1, if A1 contains 1968-02-29, the valid date 29th of February 1968 in your locale setting.</paragraph> 61cdf0e10cSrcweir<paragraph role="paragraph" id="par_idN107E7" xml-lang="en-US" l10n="CHG">You may also use =ISLEAPYEAR("1968-02-29") or =ISLEAPYEAR("2/29/68").</paragraph> 62cdf0e10cSrcweir<paragraph role="paragraph" id="par_idN107EA" xml-lang="en-US" l10n="CHG">Never use =ISLEAPYEAR(2/29/68), because this would first evaluate 2 divided by 29 divided by 68, and then calculate the ISLEAPYEAR function from this small number as a serial date number.</paragraph> 63cdf0e10cSrcweir</section> 64cdf0e10cSrcweir<section id="years"> 65*88cae784Smseidel<bookmark xml-lang="en-US" branch="index" id="bm_id3154656"> 66*88cae784Smseidel<bookmark_value>YEARS function</bookmark_value> 67cdf0e10cSrcweir<bookmark_value>number of years between two dates</bookmark_value> 68cdf0e10cSrcweir</bookmark><comment>mw added one entry</comment> 69cdf0e10cSrcweir<bookmark xml-lang="en-US" branch="hid/SC_HID_DAI_FUNC_DIFFYEARS" id="bm_id3150368" localize="false"/> 70cdf0e10cSrcweir<paragraph role="heading" id="hd_id3154656" xml-lang="en-US" level="2" l10n="U" oldref="21">YEARS</paragraph> 71cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3150886" xml-lang="en-US" l10n="U" oldref="22"><ahelp hid="HID_DAI_FUNC_DIFFYEARS">Calculates the difference in years between two dates.</ahelp></paragraph> 72cdf0e10cSrcweir<paragraph role="heading" id="hd_id3154370" xml-lang="en-US" level="3" l10n="U" oldref="23">Syntax</paragraph> 73cdf0e10cSrcweir<paragraph role="code" id="par_id3146114" xml-lang="en-US" l10n="U" oldref="24">YEARS(StartDate; EndDate; Type)</paragraph> 74cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3145387" xml-lang="en-US" l10n="U" oldref="25"> 75cdf0e10cSrcweir<emph>StartDate</emph> is the first date</paragraph> 76cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3156290" xml-lang="en-US" l10n="U" oldref="26"> 77cdf0e10cSrcweir<emph>EndDate</emph> is the second date</paragraph> 78cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3152893" xml-lang="en-US" l10n="U" oldref="27"> 79cdf0e10cSrcweir<emph>Type</emph> calculates the type of difference. Possible values are 0 (interval) and 1 (in calendar years).</paragraph> 80cdf0e10cSrcweir</section> 81cdf0e10cSrcweir<section id="months"> 82*88cae784Smseidel<bookmark xml-lang="en-US" branch="index" id="bm_id3152898"> 83*88cae784Smseidel<bookmark_value>MONTHS function</bookmark_value> 84cdf0e10cSrcweir<bookmark_value>number of months between two dates</bookmark_value> 85cdf0e10cSrcweir</bookmark><comment>mw added one entry</comment> 86cdf0e10cSrcweir<bookmark xml-lang="en-US" branch="hid/SC_HID_DAI_FUNC_DIFFMONTHS" id="bm_id3148839" localize="false"/> 87cdf0e10cSrcweir<paragraph role="heading" id="hd_id3152898" xml-lang="en-US" level="2" l10n="U" oldref="28">MONTHS</paragraph> 88cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3153066" xml-lang="en-US" l10n="U" oldref="29"><ahelp hid="HID_DAI_FUNC_DIFFMONTHS">Calculates the difference in months between two dates.</ahelp></paragraph> 89cdf0e10cSrcweir<paragraph role="heading" id="hd_id3151240" xml-lang="en-US" level="3" l10n="U" oldref="30">Syntax</paragraph> 90cdf0e10cSrcweir<paragraph role="code" id="par_id3146869" xml-lang="en-US" l10n="U" oldref="31">MONTHS(StartDate; EndDate; Type)</paragraph> 91cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3145075" xml-lang="en-US" l10n="U" oldref="32"> 92cdf0e10cSrcweir<emph>StartDate</emph> is the first date</paragraph> 93cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3157981" xml-lang="en-US" l10n="U" oldref="33"> 94cdf0e10cSrcweir<emph>EndDate</emph> is the second date</paragraph> 95cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3150111" xml-lang="en-US" l10n="U" oldref="34"> 96cdf0e10cSrcweir<emph>Type</emph> calculates the type of difference. Possible values include 0 (interval) and 1 (in calendar months).</paragraph> 97cdf0e10cSrcweir</section> 98cdf0e10cSrcweir<section id="rot13"> 99*88cae784Smseidel<bookmark xml-lang="en-US" branch="index" id="bm_id3159094"> 100*88cae784Smseidel<bookmark_value>ROT13 function</bookmark_value> 101cdf0e10cSrcweir<bookmark_value>encrypting text</bookmark_value> 102cdf0e10cSrcweir</bookmark><comment>mw added one entry</comment> 103cdf0e10cSrcweir<bookmark xml-lang="en-US" branch="hid/SC_HID_DAI_FUNC_ROT13" id="bm_id3153283" localize="false"/> 104cdf0e10cSrcweir<paragraph role="heading" id="hd_id3159094" xml-lang="en-US" level="2" l10n="U" oldref="35">ROT13</paragraph> 105cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3146781" xml-lang="en-US" l10n="U" oldref="36"><ahelp hid="HID_DAI_FUNC_ROT13">Encrypts a character string by moving the characters 13 positions in the alphabet.</ahelp> After the letter Z, the alphabet begins again (Rotation). By applying the encryption function again to the resulting code, you can decrypt the text.</paragraph> 106cdf0e10cSrcweir<paragraph role="heading" id="hd_id3150893" xml-lang="en-US" level="3" l10n="U" oldref="37">Syntax</paragraph> 107cdf0e10cSrcweir<paragraph role="code" id="par_id3159205" xml-lang="en-US" l10n="U" oldref="38">ROT13(Text)</paragraph> 108cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3153249" xml-lang="en-US" l10n="U" oldref="39"> 109cdf0e10cSrcweir<emph>Text</emph> is the character string to be encrypted. ROT13(ROT13(Text)) decrypts the code.</paragraph> 110cdf0e10cSrcweir</section> 111cdf0e10cSrcweir<section id="daysinyear"> 112*88cae784Smseidel<bookmark xml-lang="en-US" branch="index" id="bm_id3151300"> 113*88cae784Smseidel<bookmark_value>DAYSINYEAR function</bookmark_value> 114cdf0e10cSrcweir<bookmark_value>number of days; in a specific year</bookmark_value> 115cdf0e10cSrcweir</bookmark><comment>mw added one entry</comment> 116cdf0e10cSrcweir<bookmark xml-lang="en-US" branch="hid/SC_HID_DAI_FUNC_DAYSINYEAR" id="bm_id3153972" localize="false"/> 117cdf0e10cSrcweir<paragraph role="heading" id="hd_id3151300" xml-lang="en-US" level="2" l10n="U" oldref="43">DAYSINYEAR</paragraph> 118cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3143220" xml-lang="en-US" l10n="CHG" oldref="44"><ahelp hid="HID_DAI_FUNC_DAYSINYEAR">Calculates the number of days of the year in which the date entered occurs.</ahelp></paragraph> 119cdf0e10cSrcweir<paragraph role="heading" id="hd_id3145358" xml-lang="en-US" level="3" l10n="U" oldref="45">Syntax</paragraph> 120cdf0e10cSrcweir<paragraph role="code" id="par_id3154651" xml-lang="en-US" l10n="U" oldref="46">DAYSINYEAR(Date)</paragraph> 121cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3153803" xml-lang="en-US" l10n="CHG" oldref="47"> 122cdf0e10cSrcweir<emph>Date</emph> is any date in the respective year. The Date parameter must be a valid date according to the locale settings of %PRODUCTNAME.</paragraph> 123cdf0e10cSrcweir<paragraph role="heading" id="hd_id3153487" xml-lang="en-US" level="3" l10n="U" oldref="48">Example</paragraph> 124cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3153811" xml-lang="en-US" l10n="CHG" oldref="49">=DAYSINYEAR(A1) returns 366 days if A1 contains 1968-02-29, a valid date for the year 1968.</paragraph> 125cdf0e10cSrcweir</section> 126cdf0e10cSrcweir<section id="daysinmonth"> 127*88cae784Smseidel<bookmark xml-lang="en-US" branch="index" id="bm_id3154737"> 128*88cae784Smseidel<bookmark_value>DAYSINMONTH function</bookmark_value> 129cdf0e10cSrcweir<bookmark_value>number of days;in a specific month of a year</bookmark_value> 130cdf0e10cSrcweir</bookmark><comment>mw added one entry</comment> 131cdf0e10cSrcweir<bookmark xml-lang="en-US" branch="hid/SC_HID_DAI_FUNC_DAYSINMONTH" id="bm_id3155593" localize="false"/> 132cdf0e10cSrcweir<paragraph role="heading" id="hd_id3154737" xml-lang="en-US" level="2" l10n="U" oldref="50">DAYSINMONTH</paragraph> 133cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3149316" xml-lang="en-US" l10n="CHG" oldref="51"><ahelp hid="HID_DAI_FUNC_DAYSINMONTH">Calculates the number of days of the month in which the date entered occurs.</ahelp></paragraph> 134cdf0e10cSrcweir<paragraph role="heading" id="hd_id3145114" xml-lang="en-US" level="3" l10n="U" oldref="52">Syntax</paragraph> 135cdf0e10cSrcweir<paragraph role="code" id="par_id3150955" xml-lang="en-US" l10n="U" oldref="53">DAYSINMONTH(Date)</paragraph> 136cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3147501" xml-lang="en-US" l10n="CHG" oldref="54"> 137cdf0e10cSrcweir<emph>Date</emph> is any date in the respective month of the desired year. The Date parameter must be a valid date according to the locale settings of %PRODUCTNAME.</paragraph> 138cdf0e10cSrcweir<paragraph role="heading" id="hd_id3149871" xml-lang="en-US" level="3" l10n="U" oldref="55">Example</paragraph> 139cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3155742" xml-lang="en-US" l10n="CHG" oldref="56">=DAYSINMONTH(A1) returns 29 days if A1 contains 1968-02-17, a valid date for February 1968.</paragraph> 140cdf0e10cSrcweir</section> 141cdf0e10cSrcweir<section id="weeks"> 142*88cae784Smseidel<bookmark xml-lang="en-US" branch="index" id="bm_id3149048"> 143*88cae784Smseidel<bookmark_value>WEEKS function</bookmark_value> 144cdf0e10cSrcweir<bookmark_value>number of weeks;between two dates</bookmark_value> 145cdf0e10cSrcweir</bookmark><comment>mw added one entry</comment> 146cdf0e10cSrcweir<bookmark xml-lang="en-US" branch="hid/SC_HID_DAI_FUNC_DIFFWEEKS" id="bm_id3150435" localize="false"/> 147cdf0e10cSrcweir<paragraph role="heading" id="hd_id3149048" xml-lang="en-US" level="2" l10n="U" oldref="57">WEEKS</paragraph> 148cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3153340" xml-lang="en-US" l10n="U" oldref="58"><ahelp hid="HID_DAI_FUNC_DIFFWEEKS">Calculates the difference in weeks between two dates.</ahelp></paragraph> 149cdf0e10cSrcweir<paragraph role="heading" id="hd_id3150393" xml-lang="en-US" level="3" l10n="U" oldref="59">Syntax</paragraph> 150cdf0e10cSrcweir<paragraph role="code" id="par_id3147402" xml-lang="en-US" l10n="U" oldref="60">WEEKS(StartDate; EndDate; Type)</paragraph> 151cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3151387" xml-lang="en-US" l10n="U" oldref="61"> 152cdf0e10cSrcweir<emph>StartDate</emph> is the first date</paragraph> 153cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3146324" xml-lang="en-US" l10n="U" oldref="62"> 154cdf0e10cSrcweir<emph>EndDate</emph> is the second date</paragraph> 155cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3166467" xml-lang="en-US" l10n="U" oldref="63"> 156cdf0e10cSrcweir<emph>Type</emph> calculates the type of difference. The possible values are 0 (interval) and 1 (in numbers of weeks).</paragraph> 157cdf0e10cSrcweir</section> 158cdf0e10cSrcweir<section id="weeksinyear"> 159*88cae784Smseidel<bookmark xml-lang="en-US" branch="index" id="bm_id3145237"> 160*88cae784Smseidel<bookmark_value>WEEKSINYEAR function</bookmark_value> 161cdf0e10cSrcweir<bookmark_value>number of weeks;in a specific year</bookmark_value> 162cdf0e10cSrcweir</bookmark><comment>mw added one entry</comment> 163cdf0e10cSrcweir<bookmark xml-lang="en-US" branch="hid/SC_HID_DAI_FUNC_WEEKSINYEAR" id="bm_id3146883" localize="false"/> 164cdf0e10cSrcweir<paragraph role="heading" id="hd_id3145237" xml-lang="en-US" level="2" l10n="U" oldref="64">WEEKSINYEAR</paragraph> 165cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3147410" xml-lang="en-US" l10n="CHG" oldref="65"><ahelp hid="HID_DAI_FUNC_WEEKSINYEAR">Calculates the number of weeks of the year in which the date entered occurs.</ahelp> The number of weeks is defined as follows: a week that spans two years is added to the year in which most days of that week occur.</paragraph> 166cdf0e10cSrcweir<paragraph role="heading" id="hd_id3149719" xml-lang="en-US" level="3" l10n="U" oldref="66">Syntax</paragraph> 167cdf0e10cSrcweir<paragraph role="code" id="par_id3145638" xml-lang="en-US" l10n="U" oldref="67">WEEKSINYEAR(Date)</paragraph> 168cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3149946" xml-lang="en-US" l10n="CHG" oldref="68"> 169cdf0e10cSrcweir<emph>Date</emph> is any date in the respective year. The Date parameter must be a valid date according to the locale settings of %PRODUCTNAME.</paragraph> 170cdf0e10cSrcweir<paragraph role="heading" id="hd_id3150037" xml-lang="en-US" level="3" l10n="U" oldref="69">Example</paragraph> 171cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3147614" xml-lang="en-US" l10n="CHG" oldref="70">WEEKSINYEAR(A1) returns 53 if A1 contains 1970-02-17, a valid date for the year 1970.</paragraph> 172cdf0e10cSrcweir</section> 173cdf0e10cSrcweir</sort> 174cdf0e10cSrcweir<paragraph role="heading" id="hd_id3157901" xml-lang="en-US" level="2" l10n="U" oldref="72">Add-ins through %PRODUCTNAME API</paragraph> 1756f9008d8SAriel Constenla-Haile<paragraph role="paragraph" id="par_id3149351" xml-lang="en-US" l10n="U" oldref="73">Add-ins can also be implemented through the %PRODUCTNAME <link href="https://api.openoffice.org/">API</link>.</paragraph> 176cdf0e10cSrcweir<section id="relatedtopics"> 177cdf0e10cSrcweir<embed href="text/scalc/01/04060100.xhp#drking"/> 178cdf0e10cSrcweir</section> 179cdf0e10cSrcweir</body> 180cdf0e10cSrcweir</helpdocument> 181