summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOlivier Hallot <olivier.hallot@libreoffice.org>2017-06-16 16:54:14 -0300
committerOlivier Hallot <olivier.hallot@edx.srv.br>2017-06-16 23:25:48 +0200
commit8837573f15693f8de45618fc1b3342d87de88ae6 (patch)
treebc6250639833da8b0ae805bfc2fd9a0cc9ebda90
parent2c804b6389a57317d3bdecb7c80fbb6fe2868013 (diff)
tdf#84675 Add help page for IRR function of VBA
Change-Id: If4218b4b9619766e25676d5c4be35db42d51b007 Reviewed-on: https://gerrit.libreoffice.org/38900 Reviewed-by: Olivier Hallot <olivier.hallot@edx.srv.br> Tested-by: Olivier Hallot <olivier.hallot@edx.srv.br>
-rw-r--r--AllLangHelp_sbasic.mk1
-rw-r--r--source/auxiliary/sbasic.tree1
-rw-r--r--source/text/sbasic/shared/03140003.xhp77
-rw-r--r--source/text/sbasic/shared/special_vba_func.xhp2
4 files changed, 80 insertions, 1 deletions
diff --git a/AllLangHelp_sbasic.mk b/AllLangHelp_sbasic.mk
index d2435e002..731bb7d46 100644
--- a/AllLangHelp_sbasic.mk
+++ b/AllLangHelp_sbasic.mk
@@ -327,6 +327,7 @@ $(eval $(call gb_AllLangHelp_add_helpfiles,sbasic,\
helpcontent2/source/text/sbasic/shared/03140000 \
helpcontent2/source/text/sbasic/shared/03140001 \
helpcontent2/source/text/sbasic/shared/03140002 \
+ helpcontent2/source/text/sbasic/shared/03140003 \
helpcontent2/source/text/sbasic/shared/05060700 \
helpcontent2/source/text/sbasic/shared/code-stubs \
helpcontent2/source/text/sbasic/shared/keys \
diff --git a/source/auxiliary/sbasic.tree b/source/auxiliary/sbasic.tree
index 9448d6587..d95a88c48 100644
--- a/source/auxiliary/sbasic.tree
+++ b/source/auxiliary/sbasic.tree
@@ -160,6 +160,7 @@
<topic id="sbasic/text/sbasic/shared/03020202.xhp">Input# Statement [Runtime]</topic>
<topic id="sbasic/text/sbasic/shared/03080502.xhp">Int Function [Runtime]</topic>
<topic id="sbasic/text/sbasic/shared/03140002.xhp">IPmt Function [Runtime - VBA]</topic>
+<topic id="sbasic/text/sbasic/shared/03140003.xhp">IRR Function [Runtime - VBA]</topic>
<topic id="sbasic/text/sbasic/shared/03102200.xhp">IsArray Function [Runtime]</topic>
<topic id="sbasic/text/sbasic/shared/03102300.xhp">IsDate Function [Runtime]</topic>
<topic id="sbasic/text/sbasic/shared/03102400.xhp">IsEmpty Function [Runtime]</topic>
diff --git a/source/text/sbasic/shared/03140003.xhp b/source/text/sbasic/shared/03140003.xhp
new file mode 100644
index 000000000..cd5fc6f75
--- /dev/null
+++ b/source/text/sbasic/shared/03140003.xhp
@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<helpdocument version="1.0">
+<!--
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
+-->
+
+<meta>
+ <topic id="textsbasicshared03140003xml" indexer="include" status="PUBLISH">
+ <title id="tit" xml-lang="en-US">IRR Function [Runtime - VBA]</title>
+ <filename>/text/sbasic/shared/03140003.xhp</filename>
+ </topic>
+</meta>
+
+<body>
+
+
+<section id="irr">
+<bookmark xml-lang="en-US" branch="index" id="bm_id3150499">
+ <bookmark_value>IRR function</bookmark_value>
+</bookmark>
+
+
+<paragraph id="hd_id3150499" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03140003.xhp" name="IRR Function [Runtime - VBA]">IRR Function [Runtime - VBA]</link></paragraph>
+<paragraph id="par_id3151384" role="paragraph" xml-lang="en-US">Calculates the internal rate of return for an investment.</paragraph>
+</section>
+<embed href="text/sbasic/shared/00000003.xhp#vbasupport"/>
+
+<paragraph id="hd_id061420170116474964" role="heading" level="2" xml-lang="en-US"><embedvar href="text/sbasic/shared/00000003.xhp#functsyntax"/></paragraph>
+<bascode>
+<paragraph id="par_id3143267" role="bascode" localize="false" xml-lang="en-US">IRR(Values() as Double , [Guess as Variant])</paragraph>
+</bascode>
+
+<paragraph id="hd_id0614201701254487" role="heading" level="2" xml-lang="en-US"><embedvar href="text/sbasic/shared/00000003.xhp#functvalue"/></paragraph>
+<paragraph id="par_id3150669" role="paragraph" localize="false" xml-lang="en-US">Double</paragraph>
+
+<paragraph id="hd_id061420170125448913" role="heading" level="2" xml-lang="en-US"><embedvar href="text/sbasic/shared/00000003.xhp#functparameters"/></paragraph>
+<paragraph id="par_id061420170730135034" role="paragraph" xml-lang="en-US"><emph>Values(): </emph>The array of values of the cash-flow. The values represent cash flow values at regular intervals, at least one value must be negative (payments), and at least one value must be positive (income).</paragraph>
+<paragraph id="par_id061420170730137782" role="paragraph" xml-lang="en-US"><emph>Guess</emph> An initial estimate at what the IRR will be.</paragraph>
+<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
+<embed href="text/sbasic/shared/00000003.xhp#err5"/>
+
+<paragraph id="hd_id061420170125449765" role="heading" level="2" xml-lang="en-US"><embedvar href="text/sbasic/shared/00000003.xhp#functexample"/></paragraph>
+<bascode>
+<paragraph id="par_id06162017021753974" role="bascode" localize="false" xml-lang="en-US">REM ***** BASIC *****</paragraph>
+<paragraph id="par_id061620170217534991" role="bascode" localize="false" xml-lang="en-US">Option VBASupport 1</paragraph>
+<paragraph id="par_id061620170217535111" role="bascode" localize="false" xml-lang="en-US">Sub ExampleIRR</paragraph>
+<paragraph id="par_id061620170217538573" role="bascode" localize="false" xml-lang="en-US"> Dim cashFlow(0 to 3) As Double</paragraph>
+<paragraph id="par_id06162017021753515" role="bascode" localize="false" xml-lang="en-US"> cashFlow(0) = -10000</paragraph>
+<paragraph id="par_id061620170217538580" role="bascode" localize="false" xml-lang="en-US"> cashFlow(1) = 3500</paragraph>
+<paragraph id="par_id061620170217543462" role="bascode" localize="false" xml-lang="en-US"> cashFlow(2) = 7600</paragraph>
+<paragraph id="par_id061620170217549769" role="bascode" localize="false" xml-lang="en-US"> cashFlow(3) = 1000</paragraph>
+<paragraph id="par_id061620170217542970" role="bascode" localize="false" xml-lang="en-US"> irrValue = IRR(cashFlow) * 100</paragraph>
+<paragraph id="par_id061620170217548258" role="bascode" xml-lang="en-US"> Print irrValue ' returns 11.3321028236252 . The internal rate of return of the cash flow.</paragraph>
+<paragraph id="par_id061620170217544542" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph>
+</bascode>
+
+<section id="relatedtopics">
+<paragraph id="par_id061420170153186192" role="paragraph" xml-lang="en-US"><link href="text/scalc/01/04060103.xhp#bm_id3153948">IRR function in CALC</link></paragraph>
+<paragraph id="par_id06142017015837916" role="paragraph" xml-lang="en-US"><link href="text/sbasic/shared/special_vba_func.xhp">VBA financial functions</link></paragraph>
+</section>
+</body>
+
+</helpdocument> \ No newline at end of file
diff --git a/source/text/sbasic/shared/special_vba_func.xhp b/source/text/sbasic/shared/special_vba_func.xhp
index 582e2ce0e..12d68f22e 100644
--- a/source/text/sbasic/shared/special_vba_func.xhp
+++ b/source/text/sbasic/shared/special_vba_func.xhp
@@ -76,7 +76,7 @@
<paragraph id="par_id051820170331278779" role="paragraph" localize="false" xml-lang="en-US"><link href="text/sbasic/shared/03140002.xhp">IPmt</link></paragraph>
</listitem>
<listitem>
- <paragraph id="par_id051820170335282035" role="paragraph" localize="false" xml-lang="en-US">IRR</paragraph>
+ <paragraph id="par_id051820170335282035" role="paragraph" localize="false" xml-lang="en-US"><link href="text/sbasic/shared/03140003.xhp">IRR</link></paragraph>
</listitem>
<listitem>
<paragraph id="par_id051820170335284205" role="paragraph" localize="false" xml-lang="en-US">MIRR</paragraph>