summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOlivier Hallot <olivier.hallot@libreoffice.org>2017-07-23 23:30:26 -0300
committerOlivier Hallot <olivier.hallot@edx.srv.br>2017-07-24 13:11:53 +0200
commit7e0d91b15d875f6bf7fa94edf96a0bb791d5e8b3 (patch)
tree31393e81caeac4b0012a845b140fe1960f8da2d1
parent1a5e22fbe576e0c75682b01cbb242b3e29c14d45 (diff)
tdf#108675 Help page for VBA function Pmt
Change-Id: I1e35ee31cd96aeee8f1b55a5adb119c50af1a1af Reviewed-on: https://gerrit.libreoffice.org/40349 Reviewed-by: Olivier Hallot <olivier.hallot@edx.srv.br> Tested-by: Olivier Hallot <olivier.hallot@edx.srv.br>
Diffstat
-rw-r--r--AllLangHelp_sbasic.mk1
-rw-r--r--source/auxiliary/sbasic.tree1
-rw-r--r--source/text/sbasic/shared/03140007.xhp76
-rw-r--r--source/text/sbasic/shared/special_vba_func.xhp4
4 files changed, 79 insertions, 3 deletions
diff --git a/AllLangHelp_sbasic.mk b/AllLangHelp_sbasic.mk
index 43b6882dd8..cce356b848 100644
--- a/AllLangHelp_sbasic.mk
+++ b/AllLangHelp_sbasic.mk
@@ -331,6 +331,7 @@ $(eval $(call gb_AllLangHelp_add_helpfiles,sbasic,\
helpcontent2/source/text/sbasic/shared/03140004 \
helpcontent2/source/text/sbasic/shared/03140005 \
helpcontent2/source/text/sbasic/shared/03140006 \
+ helpcontent2/source/text/sbasic/shared/03140007 \
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 0c1cfc8828..b089a120c0 100644
--- a/source/auxiliary/sbasic.tree
+++ b/source/auxiliary/sbasic.tree
@@ -205,6 +205,7 @@
<topic id="sbasic/text/sbasic/shared/03103350.xhp">Option VBASupport Statement [Runtime]</topic>
<topic id="sbasic/text/sbasic/shared/03104100.xhp">Optional (in Function Statement) [Runtime]</topic>
<topic id="sbasic/text/sbasic/shared/03060500.xhp">Or-Operator [Runtime]</topic>
+<topic id="sbasic/text/sbasic/shared/03140007.xhp">Pmt Function [Runtime - VBA]</topic>
<topic id="sbasic/text/sbasic/shared/03010103.xhp">Print Statement [Runtime]</topic>
<topic id="sbasic/text/sbasic/shared/03103400.xhp">Public Statement [Runtime]</topic>
<topic id="sbasic/text/sbasic/shared/03020204.xhp">Put Statement [Runtime]</topic>
diff --git a/source/text/sbasic/shared/03140007.xhp b/source/text/sbasic/shared/03140007.xhp
new file mode 100644
index 0000000000..65e3a784c5
--- /dev/null
+++ b/source/text/sbasic/shared/03140007.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="textsbasicshared03140007xml" indexer="include" status="PUBLISH">
+ <title id="tit" xml-lang="en-US">Pmt Function [Runtime - VBA]</title>
+ <filename>/text/sbasic/shared/03140007.xhp</filename>
+ </topic>
+</meta>
+
+<body>
+
+
+<section id="pmt">
+<bookmark xml-lang="en-US" branch="index" id="bm_id3150499">
+ <bookmark_value>Pmt function</bookmark_value>
+</bookmark>
+
+
+<paragraph id="hd_id3150499" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03140007.xhp" name="Pmt Function [Runtime - VBA]">Pmt Function [Runtime - VBA]</link></paragraph>
+<paragraph id="par_id3151384" role="paragraph" xml-lang="en-US">Calculates the constant periodic payments for a loan or investment.</paragraph>
+</section>
+<embed href="text/sbasic/shared/00000003.xhp#vbasupport"/>
+<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
+<bascode>
+<paragraph id="par_id3143267" role="bascode" localize="false" xml-lang="en-US">Pmt( Rate as Double, NPer as Double , PV as Double , [FV as Variant], [Due as Variant] )</paragraph>
+</bascode>
+<embed href="text/sbasic/shared/00000003.xhp#functvalue"/>
+<paragraph id="par_id3150669" role="paragraph" localize="false" xml-lang="en-US">Double</paragraph>
+<embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
+<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>NPer</emph> is the total number of periods, during which annuity is paid.</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"/>
+<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
+<bascode>
+<paragraph id="par_id230720172323446745" role="bascode" localize="false" xml-lang="en-US">REM ***** BASIC *****</paragraph>
+<paragraph id="par_id230720172323448252" role="bascode" localize="false" xml-lang="en-US">Option VBASUPPORT 1</paragraph>
+<paragraph id="par_id230720172323446103" role="bascode" xml-lang="en-US">' Calculate the monthly payments to a loan that is to be paid in full over 6 years.</paragraph>
+<paragraph id="par_id230720172323448289" role="bascode" xml-lang="en-US">' Interest is 10% per year and payments are made at the end of the month.</paragraph>
+<paragraph id="par_id230720172323447417" role="bascode" localize="false" xml-lang="en-US">Sub ExamplePmt</paragraph>
+<paragraph id="par_id230720172323446526" role="bascode" localize="false" xml-lang="en-US"> Dim myPmt As Double</paragraph>
+<paragraph id="par_id230720172323442370" role="bascode" localize="false" xml-lang="en-US"> myPmt = Pmt( 0.1/12, 72, 100000 )</paragraph>
+<paragraph id="par_id230720172323444810" role="bascode" xml-lang="en-US"> print MyPmt 'is calculated to be -1852,58377757705</paragraph>
+<paragraph id="par_id23072017232344836" 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/04060119.xhp#bm_id3149577">PMT function in CALC</link></paragraph>
+<embed href="text/sbasic/shared/00000003.xhp#VBA-Financial"/>
+</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 6855119123..bec2c7bf47 100644
--- a/source/text/sbasic/shared/special_vba_func.xhp
+++ b/source/text/sbasic/shared/special_vba_func.xhp
@@ -61,12 +61,10 @@
<embed href="text/sbasic/shared/03140004.xhp#mirr"/>
<embed href="text/sbasic/shared/03140005.xhp#nper"/>
<embed href="text/sbasic/shared/03140006.xhp#npv"/>
+<embed href="text/sbasic/shared/03140007.xhp#pmt"/>
<list type="unordered">
<listitem>
- <paragraph id="par_id051820170335299272" role="paragraph" localize="false" xml-lang="en-US">Pmt</paragraph>
- </listitem>
- <listitem>
<paragraph id="par_id051820170335298807" role="paragraph" localize="false" xml-lang="en-US">PPmt</paragraph>
</listitem>
<listitem>
generated by cgit v1.2.3 (git 2.39.1) at 2024-04-23 12:01:25 +0000