1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
<?xml version="1.0" encoding="UTF-8"?>
<!--***********************************************************************
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRUNTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRUNTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc..
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************-->
<helpdocument version="1.0">
<meta>
<topic id="textscalc0104060111xml" indexer="include" status="PUBLISH">
<title id="tit" xml-lang="en-US">Add-in Functions</title>
<filename>/text/scalc/01/04060111.xhp</filename>
</topic>
<history>
<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
<lastedited date="2004-08-10T08:25:23">UFI: fixed #i25199#</lastedited>
</history>
</meta>
<body>
<bookmark xml-lang="en-US" branch="index" id="bm_id3150870"><bookmark_value>add-ins; functions</bookmark_value>
<bookmark_value>functions; add-ins</bookmark_value>
<bookmark_value>Function Wizard; add-ins</bookmark_value>
</bookmark>
<paragraph role="heading" id="hd_id3150870" xml-lang="en-US" level="1" l10n="U" oldref="1">Add-in Functions</paragraph>
<paragraph role="paragraph" id="par_id3147427" xml-lang="en-US" l10n="U" oldref="2"><variable id="addintext">The following describes and lists the available add-in functions.
</variable></paragraph>
<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>
<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
</caseinline><defaultinline>$[officename] Calc add-in DLL</defaultinline></switchinline>.</paragraph>
<paragraph role="heading" id="hd_id3151075" xml-lang="en-US" level="2" l10n="U" oldref="7">Add-ins supplied</paragraph>
<paragraph role="paragraph" id="par_id3156285" xml-lang="en-US" l10n="U" oldref="8">$[officename] contains examples for the add-in interface of $[officename] Calc. These provide the functions that you find in <emph>Function Wizard</emph> under the <emph>Add-in</emph> category, plus several of the financial functions.</paragraph>
<paragraph role="warning" id="par_id3155446" xml-lang="en-US" l10n="U" oldref="78">In the $[officename] Setup program, you can selectively deinstall the Calc Add-ins. Be aware that you will lose all functions listed under the Add-in category, plus several financial functions, if you do so.</paragraph>
<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>
<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>
<sort order="asc">
<section id="isleapyear">
<bookmark xml-lang="en-US" branch="index" id="bm_id3149566"><bookmark_value>ISLEAPYEAR function</bookmark_value>
</bookmark>
<paragraph role="heading" id="hd_id3149566" xml-lang="en-US" level="2" l10n="U" oldref="14">ISLEAPYEAR</paragraph>
<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>
<paragraph role="heading" id="hd_id3148487" xml-lang="en-US" level="3" l10n="U" oldref="16">Syntax</paragraph>
<paragraph role="paragraph" id="par_id3150205" xml-lang="en-US" l10n="U" oldref="17">ISLEAPYEAR(Date)</paragraph>
<paragraph role="paragraph" id="par_id3159239" xml-lang="en-US" l10n="U" oldref="18">Date: 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>
<paragraph role="heading" id="hd_id3149817" xml-lang="en-US" level="3" l10n="U" oldref="19">Example</paragraph>
<paragraph role="paragraph" id="par_id3150786" xml-lang="en-US" l10n="U" oldref="20">ISLEAPYEAR(A1) returns 1, if A1 contains 2/29/68, the valid date 29th of February 1968 in your locale setting.</paragraph>
<paragraph role="paragraph" id="par_idN107E7" xml-lang="en-US">You may also use ISLEAPYEAR("2/29/68").</paragraph>
<paragraph role="paragraph" id="par_idN107EA" xml-lang="en-US">Never use ISLEAPYEAR(2/29/68), because this would first evaluate 2 divided by 29 devided by 68, and then calculate the ISLEAPYEAR function from this small number as a serial date number.</paragraph>
</section>
<section id="years">
<bookmark xml-lang="en-US" branch="index" id="bm_id3154656"><bookmark_value>YEARS function</bookmark_value>
</bookmark>
<bookmark xml-lang="en-US" branch="hid/HID_DAI_FUNC_DIFFYEARS" id="bm_id3150368" localize="false"/>
<paragraph role="heading" id="hd_id3154656" xml-lang="en-US" level="2" l10n="U" oldref="21">YEARS</paragraph>
<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>
<paragraph role="heading" id="hd_id3154370" xml-lang="en-US" level="3" l10n="U" oldref="23">Syntax</paragraph>
<paragraph role="paragraph" id="par_id3146114" xml-lang="en-US" l10n="U" oldref="24">YEARS(Start date, End date, Type)</paragraph>
<paragraph role="paragraph" id="par_id3145387" xml-lang="en-US" l10n="U" oldref="25">Start date: First date</paragraph>
<paragraph role="paragraph" id="par_id3156290" xml-lang="en-US" l10n="U" oldref="26">End date: Second date</paragraph>
<paragraph role="paragraph" id="par_id3152893" xml-lang="en-US" l10n="U" oldref="27">Type: Calculates the type of difference. Possible values are 0 (interval) and 1 (in calendar years).</paragraph>
</section>
<section id="months">
<bookmark xml-lang="en-US" branch="index" id="bm_id3152898"><bookmark_value>MONTHS function</bookmark_value>
</bookmark>
<bookmark xml-lang="en-US" branch="hid/HID_DAI_FUNC_DIFFMONTHS" id="bm_id3148839" localize="false"/>
<paragraph role="heading" id="hd_id3152898" xml-lang="en-US" level="2" l10n="U" oldref="28">MONTHS</paragraph>
<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>
<paragraph role="heading" id="hd_id3151240" xml-lang="en-US" level="3" l10n="U" oldref="30">Syntax</paragraph>
<paragraph role="paragraph" id="par_id3146869" xml-lang="en-US" l10n="U" oldref="31">MONTHS(Start date, End date, Type)</paragraph>
<paragraph role="paragraph" id="par_id3145075" xml-lang="en-US" l10n="U" oldref="32">Start date: First date</paragraph>
<paragraph role="paragraph" id="par_id3157981" xml-lang="en-US" l10n="U" oldref="33">End date: Second date</paragraph>
<paragraph role="paragraph" id="par_id3150111" xml-lang="en-US" l10n="U" oldref="34">Type: Calculates the type of difference. Possible values include 0 (interval) and 1 (in calendar months).</paragraph>
</section>
<section id="rot13">
<bookmark xml-lang="en-US" branch="index" id="bm_id3159094"><bookmark_value>ROT13 function</bookmark_value>
</bookmark>
<bookmark xml-lang="en-US" branch="hid/HID_DAI_FUNC_ROT13" id="bm_id3153283" localize="false"/>
<paragraph role="heading" id="hd_id3159094" xml-lang="en-US" level="2" l10n="U" oldref="35">ROT13</paragraph>
<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>
<paragraph role="heading" id="hd_id3150893" xml-lang="en-US" level="3" l10n="U" oldref="37">Syntax</paragraph>
<paragraph role="paragraph" id="par_id3159205" xml-lang="en-US" l10n="U" oldref="38">ROT13(Text)</paragraph>
<paragraph role="paragraph" id="par_id3153249" xml-lang="en-US" l10n="U" oldref="39">Text: Enter the character string to be encrypted. ROT13(ROT13(Text)) decrypts the code.</paragraph>
</section>
<section id="daysinyear">
<bookmark xml-lang="en-US" branch="index" id="bm_id3151300"><bookmark_value>DAYSINYEAR function</bookmark_value>
</bookmark>
<bookmark xml-lang="en-US" branch="hid/HID_DAI_FUNC_DAYSINYEAR" id="bm_id3153972" localize="false"/>
<paragraph role="heading" id="hd_id3151300" xml-lang="en-US" level="2" l10n="U" oldref="43">DAYSINYEAR</paragraph>
<paragraph role="paragraph" id="par_id3143220" xml-lang="en-US" l10n="U" oldref="44"><ahelp hid="HID_DAI_FUNC_DAYSINYEAR">Calculates the number of days in the year until a given date.</ahelp></paragraph>
<paragraph role="heading" id="hd_id3145358" xml-lang="en-US" level="3" l10n="U" oldref="45">Syntax</paragraph>
<paragraph role="paragraph" id="par_id3154651" xml-lang="en-US" l10n="U" oldref="46">DAYSINYEAR(Date)</paragraph>
<paragraph role="paragraph" id="par_id3153803" xml-lang="en-US" l10n="U" oldref="47">Date: The date up through which a number of days in the year is calculated. The Date parameter must be a valid date according to the locale settings of %PRODUCTNAME.</paragraph>
<paragraph role="heading" id="hd_id3153487" xml-lang="en-US" level="3" l10n="U" oldref="48">Example</paragraph>
<paragraph role="paragraph" id="par_id3153811" xml-lang="en-US" l10n="U" oldref="49">DAYSINYEAR(A1) returns 366 days if A1 contains 2/29/68, a valid date for the year 1968.</paragraph>
</section>
<section id="daysinmonth">
<bookmark xml-lang="en-US" branch="index" id="bm_id3154737"><bookmark_value>DAYSINMONTH function</bookmark_value>
</bookmark>
<bookmark xml-lang="en-US" branch="hid/HID_DAI_FUNC_DAYSINMONTH" id="bm_id3155593" localize="false"/>
<paragraph role="heading" id="hd_id3154737" xml-lang="en-US" level="2" l10n="U" oldref="50">DAYSINMONTH</paragraph>
<paragraph role="paragraph" id="par_id3149316" xml-lang="en-US" l10n="U" oldref="51"><ahelp hid="HID_DAI_FUNC_DAYSINMONTH">Calculates the number of days in a month until a given date.</ahelp></paragraph>
<paragraph role="heading" id="hd_id3145114" xml-lang="en-US" level="3" l10n="U" oldref="52">Syntax</paragraph>
<paragraph role="paragraph" id="par_id3150955" xml-lang="en-US" l10n="U" oldref="53">DAYSINMONTH(Date)</paragraph>
<paragraph role="paragraph" id="par_id3147501" xml-lang="en-US" l10n="U" oldref="54">Date: The date up through which the days in the month is calculated. The Date parameter must be a valid date according to the locale settings of %PRODUCTNAME.</paragraph>
<paragraph role="heading" id="hd_id3149871" xml-lang="en-US" level="3" l10n="U" oldref="55">Example</paragraph>
<paragraph role="paragraph" id="par_id3155742" xml-lang="en-US" l10n="U" oldref="56">DAYSINMONTH(A1) returns 29 days if A1 contains 2/17/68, a valid date for February 1968.</paragraph>
</section>
<section id="weeks">
<bookmark xml-lang="en-US" branch="index" id="bm_id3149048"><bookmark_value>WEEKS function</bookmark_value>
</bookmark>
<bookmark xml-lang="en-US" branch="hid/HID_DAI_FUNC_DIFFWEEKS" id="bm_id3150435" localize="false"/>
<paragraph role="heading" id="hd_id3149048" xml-lang="en-US" level="2" l10n="U" oldref="57">WEEKS</paragraph>
<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>
<paragraph role="heading" id="hd_id3150393" xml-lang="en-US" level="3" l10n="U" oldref="59">Syntax</paragraph>
<paragraph role="paragraph" id="par_id3147402" xml-lang="en-US" l10n="U" oldref="60">WEEKS(Start date, End date, Type)</paragraph>
<paragraph role="paragraph" id="par_id3151387" xml-lang="en-US" l10n="U" oldref="61">Start date: First date</paragraph>
<paragraph role="paragraph" id="par_id3146324" xml-lang="en-US" l10n="U" oldref="62">End date: Second date</paragraph>
<paragraph role="paragraph" id="par_id3166467" xml-lang="en-US" l10n="U" oldref="63">Type: Calculates the type of difference. The possible values are 0 (interval) and 1 (in numbers of weeks).</paragraph>
</section>
<section id="weeksinyear">
<bookmark xml-lang="en-US" branch="index" id="bm_id3145237"><bookmark_value>WEEKSINYEAR function</bookmark_value>
</bookmark>
<bookmark xml-lang="en-US" branch="hid/HID_DAI_FUNC_WEEKSINYEAR" id="bm_id3146883" localize="false"/>
<paragraph role="heading" id="hd_id3145237" xml-lang="en-US" level="2" l10n="U" oldref="64">WEEKSINYEAR</paragraph>
<paragraph role="paragraph" id="par_id3147410" xml-lang="en-US" l10n="U" oldref="65"><ahelp hid="HID_DAI_FUNC_WEEKSINYEAR">Calculates the number of weeks in a year until a certain date.</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>
<paragraph role="heading" id="hd_id3149719" xml-lang="en-US" level="3" l10n="U" oldref="66">Syntax</paragraph>
<paragraph role="paragraph" id="par_id3145638" xml-lang="en-US" l10n="U" oldref="67">WEEKSINYEAR(Date)</paragraph>
<paragraph role="paragraph" id="par_id3149946" xml-lang="en-US" l10n="U" oldref="68">Date: The date until which the weeks in the year will be calculated. The Date parameter must be a valid date according to the locale settings of %PRODUCTNAME.</paragraph>
<paragraph role="heading" id="hd_id3150037" xml-lang="en-US" level="3" l10n="U" oldref="69">Example</paragraph>
<paragraph role="paragraph" id="par_id3147614" xml-lang="en-US" l10n="U" oldref="70">WEEKSINYEAR(A1) returns 53 if A1 contains 2/17/70, a valid date for the year 1970.</paragraph>
</section>
</sort>
<paragraph role="heading" id="hd_id3157901" xml-lang="en-US" level="2" l10n="U" oldref="72">Add-ins through %PRODUCTNAME API</paragraph>
<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="http://api.openoffice.org/">API</link>.</paragraph>
</body>
</helpdocument>
|
