summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOlivier Hallot <olivier.hallot@libreoffice.org>2017-06-14 17:00:09 -0300
committerOlivier Hallot <olivier.hallot@edx.srv.br>2017-06-14 23:47:34 +0200
commitff87da57d195fd80f4c5cb51925f3b4db75ef020 (patch)
tree554262115e574bd5f0f4ac4370caaac4940a1bbb
parent0283e29b71806416024f2ced843ce927e99be7b3 (diff)
tdf#84675 Add help page for FV function of VBA
Change-Id: Ic1ac6629eed117d6d2ec8802162e69a45e599a0c Reviewed-on: https://gerrit.libreoffice.org/38802 Reviewed-by: Olivier Hallot <olivier.hallot@edx.srv.br> Tested-by: Olivier Hallot <olivier.hallot@edx.srv.br> (cherry picked from commit 969c5806ff0d958e8dc19d1abe98a1493842e4ca) Reviewed-on: https://gerrit.libreoffice.org/38804
-rw-r--r--AllLangHelp_sbasic.mk1
-rw-r--r--source/text/sbasic/shared/03140001.xhp76
-rw-r--r--source/text/sbasic/shared/special_vba_func.xhp2
3 files changed, 78 insertions, 1 deletions
diff --git a/AllLangHelp_sbasic.mk b/AllLangHelp_sbasic.mk
index 8459df924b..4d8075d258 100644
--- a/AllLangHelp_sbasic.mk
+++ b/AllLangHelp_sbasic.mk
@@ -325,6 +325,7 @@ $(eval $(call gb_AllLangHelp_add_helpfiles,sbasic,\
helpcontent2/source/text/sbasic/shared/03132400 \
helpcontent2/source/text/sbasic/shared/03132500 \
helpcontent2/source/text/sbasic/shared/03140000 \
+ helpcontent2/source/text/sbasic/shared/03140001 \
helpcontent2/source/text/sbasic/shared/05060700 \
helpcontent2/source/text/sbasic/shared/code-stubs \
helpcontent2/source/text/sbasic/shared/keys \
diff --git a/source/text/sbasic/shared/03140001.xhp b/source/text/sbasic/shared/03140001.xhp
new file mode 100644
index 0000000000..8246842a67
--- /dev/null
+++ b/source/text/sbasic/shared/03140001.xhp
@@ -0,0 +1,76 @@
+<?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="textsbasicshared03140001xml" indexer="include" status="PUBLISH">
+ <title id="tit" xml-lang="en-US">FV Function [Runtime - VBA]</title>
+ <filename>/text/sbasic/shared/03140001.xhp</filename>
+ </topic>
+</meta>
+
+<body>
+
+
+<section id="fv">
+<bookmark xml-lang="en-US" branch="index" id="bm_id3150499">
+ <bookmark_value>FV function</bookmark_value>
+</bookmark>
+
+
+<paragraph id="hd_id3150499" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03140001.xhp" name="FV Function [Runtime - VBA]">FV Function [Runtime - VBA]</link></paragraph>
+<paragraph id="par_id3151384" role="paragraph" xml-lang="en-US">Returns the future value of an investment based on periodic, constant payments and a constant interest rate (Future Value).</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">FV(Rate as Double, NPer as Double, Pmt as Double, [PV as Variant], [Due 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_id06142017042024114" role="paragraph" xml-lang="en-US"><emph>Rate</emph> is the periodic interest rate.</paragraph>
+<paragraph id="par_id061420170420241668" role="paragraph" xml-lang="en-US"><emph>NPer</emph> is the total number of periods (payment period).</paragraph>
+<paragraph id="par_id061420170420248911" role="paragraph" xml-lang="en-US"><emph>Pmt</emph> is the annuity paid regularly per period.</paragraph>
+<paragraph id="par_id061420170420246794" role="paragraph" xml-lang="en-US"><emph>PV</emph> (optional) is the (present) cash value of an investment.</paragraph>
+<paragraph id="par_id061420170420241932" role="paragraph" xml-lang="en-US"><emph>Due</emph> (optional) defines whether the payment is due at the beginning or the end of a period.</paragraph>
+<paragraph id="par_id0614201704292615" role="paragraph" xml-lang="en-US">0 - the payment is due at the end of the period;</paragraph>
+<paragraph id="par_id061420170429263061" role="paragraph" xml-lang="en-US">1 - the payment is due at the beginning of the period.</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_id061420170142119551" role="bascode" localize="false" xml-lang="en-US">Sub ExampleFV</paragraph>
+<paragraph id="par_id061420170142169416" role="bascode" localize="false" xml-lang="en-US"> Dim myFV As Double</paragraph>
+<paragraph id="par_id06142017014218316" role="bascode" localize="false" xml-lang="en-US"> myFV = =FV(0.04, 2, 750, 2500)</paragraph>
+<paragraph id="par_id061420170142332315" role="bascode" xml-lang="en-US"> Print myFV ' returns 4234.00 currency units. The value at the end of the investment is 4234.00 currency units.</paragraph>
+<paragraph id="par_id061420170142255740" 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/04060118.xhp#bm_id3151205">FV 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>
diff --git a/source/text/sbasic/shared/special_vba_func.xhp b/source/text/sbasic/shared/special_vba_func.xhp
index 34296bdd92..f42d5b8b2c 100644
--- a/source/text/sbasic/shared/special_vba_func.xhp
+++ b/source/text/sbasic/shared/special_vba_func.xhp
@@ -70,7 +70,7 @@
<paragraph id="par_id051820170331271603" role="paragraph" localize="false" xml-lang="en-US"><link href="text/sbasic/shared/03140000.xhp">DDB</link></paragraph>
</listitem>
<listitem>
- <paragraph id="par_id051820170331278736" role="paragraph" localize="false" xml-lang="en-US">FV</paragraph>
+ <paragraph id="par_id051820170331278736" role="paragraph" localize="false" xml-lang="en-US"><link href="text/sbasic/shared/03140001.xhp">FV</link></paragraph>
</listitem>
<listitem>
<paragraph id="par_id051820170331278779" role="paragraph" localize="false" xml-lang="en-US">IPmt</paragraph>