summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOlivier Hallot <olivier.hallot@libreoffice.org>2017-06-16 18:29:59 -0300
committerOlivier Hallot <olivier.hallot@edx.srv.br>2017-06-17 12:55:40 +0200
commit91095e4d234dfb17218c76f096d0c107cf16cec8 (patch)
tree0e2daf39f53e92224b4ce90022557ee9209165e6
parenta7dd65f811df7ef82c575a1c3c0be074cb880924 (diff)
tdf#84675 Add help page for NPer function of VBA
Change-Id: Id601138bc4ad390f8ec6c14fe41dc1f936ab5aab Reviewed-on: https://gerrit.libreoffice.org/38903 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/03140005.xhp78
-rw-r--r--source/text/sbasic/shared/special_vba_func.xhp2
4 files changed, 81 insertions, 1 deletions
diff --git a/AllLangHelp_sbasic.mk b/AllLangHelp_sbasic.mk
index 6ef725554..405556ea8 100644
--- a/AllLangHelp_sbasic.mk
+++ b/AllLangHelp_sbasic.mk
@@ -329,6 +329,7 @@ $(eval $(call gb_AllLangHelp_add_helpfiles,sbasic,\
helpcontent2/source/text/sbasic/shared/03140002 \
helpcontent2/source/text/sbasic/shared/03140003 \
helpcontent2/source/text/sbasic/shared/03140004 \
+ helpcontent2/source/text/sbasic/shared/03140005 \
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 b690cf868..a0085f6a3 100644
--- a/source/auxiliary/sbasic.tree
+++ b/source/auxiliary/sbasic.tree
@@ -193,6 +193,7 @@
<topic id="sbasic/text/sbasic/shared/03020412.xhp">Name Statement [Runtime]</topic>
<topic id="sbasic/text/sbasic/shared/03060400.xhp">Not-Operator [Runtime]</topic>
<topic id="sbasic/text/sbasic/shared/03030203.xhp">Now Function [Runtime]</topic>
+<topic id="sbasic/text/sbasic/shared/03140005.xhp">NPer Function [Runtime - VBA]</topic>
<topic id="sbasic/text/sbasic/shared/03080000.xhp">Numeric Functions</topic>
<topic id="sbasic/text/sbasic/shared/03080802.xhp">Oct Function [Runtime]</topic>
<topic id="sbasic/text/sbasic/shared/03050500.xhp">On Error GoTo ... Resume Statement [Runtime]</topic>
diff --git a/source/text/sbasic/shared/03140005.xhp b/source/text/sbasic/shared/03140005.xhp
new file mode 100644
index 000000000..e46c2b9c4
--- /dev/null
+++ b/source/text/sbasic/shared/03140005.xhp
@@ -0,0 +1,78 @@
+<?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="textsbasicshared03140005xml" indexer="include" status="PUBLISH">
+ <title id="tit" xml-lang="en-US">NPer Function [Runtime - VBA]</title>
+ <filename>/text/sbasic/shared/03140005.xhp</filename>
+ </topic>
+</meta>
+
+<body>
+
+
+<section id="nper">
+<bookmark xml-lang="en-US" branch="index" id="bm_id3150499">
+ <bookmark_value>NPer function</bookmark_value>
+</bookmark>
+
+
+<paragraph id="hd_id3150499" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03140005.xhp" name="NPer Function [Runtime - VBA]">NPer Function [Runtime - VBA]</link></paragraph>
+<paragraph id="par_id3151384" role="paragraph" xml-lang="en-US">Calculates the number of periods for a loan or 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">NPer (Rate as Double, Pmt as Double, PV as Double, [FV 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_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> is the (present) cash value of an investment.</paragraph>
+<paragraph id="par_id061620170603217534" role="paragraph" xml-lang="en-US"><emph>FV</emph> (optional) is the future value of the loan / 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_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_id061420170142119551" role="bascode" localize="false" xml-lang="en-US">Sub ExampleNPer</paragraph>
+<paragraph id="par_id061420170142169416" role="bascode" localize="false" xml-lang="en-US"> Dim period As Double</paragraph>
+<paragraph id="par_id06142017014218316" role="bascode" localize="false" xml-lang="en-US"> period = NPer( 0.06, 153.75, 2600)</paragraph>
+<paragraph id="par_id061420170142332315" role="bascode" xml-lang="en-US"> Print period ' returns -12,02. The payment period covers 12.02 periods.</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/04060118.xhp#bm_id3156435">NPER 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 e4101b8f5..550395d4c 100644
--- a/source/text/sbasic/shared/special_vba_func.xhp
+++ b/source/text/sbasic/shared/special_vba_func.xhp
@@ -82,7 +82,7 @@
<paragraph id="par_id051820170335284205" role="paragraph" localize="false" xml-lang="en-US"><link href="text/sbasic/shared/03140004.xhp">MIRR</link></paragraph>
</listitem>
<listitem>
- <paragraph id="par_id051820170335297182" role="paragraph" localize="false" xml-lang="en-US">NPer</paragraph>
+ <paragraph id="par_id051820170335297182" role="paragraph" localize="false" xml-lang="en-US"><link href="text/sbasic/shared/03140005.xhp">NPer</link></paragraph>
</listitem>
<listitem>
<paragraph id="par_id051820170335299474" role="paragraph" localize="false" xml-lang="en-US">NPV</paragraph>