diff options
| author | Olivier Hallot <olivier.hallot@libreoffice.org> | 2017-06-14 19:42:00 -0300 |
|---|---|---|
| committer | Olivier Hallot <olivier.hallot@edx.srv.br> | 2017-06-15 01:52:30 +0200 |
| commit | 382289ba413f625b8cb41bb6702ad4c7b0e74ab0 (patch) | |
| tree | 8d1442bed5a3057aa80689fa6830d28aa96fa32e | |
| parent | ff87da57d195fd80f4c5cb51925f3b4db75ef020 (diff) | |
tdf#84675 Add help page for IPmt function of VBA
Change-Id: Iddb382d9735c25f2ca77f8141457fb6bb497a696
Reviewed-on: https://gerrit.libreoffice.org/38809
Reviewed-by: Olivier Hallot <olivier.hallot@edx.srv.br>
Tested-by: Olivier Hallot <olivier.hallot@edx.srv.br>
| -rw-r--r-- | AllLangHelp_sbasic.mk | 1 | ||||
| -rw-r--r-- | source/text/sbasic/shared/03140002.xhp | 77 | ||||
| -rw-r--r-- | source/text/sbasic/shared/special_vba_func.xhp | 2 |
3 files changed, 79 insertions, 1 deletions
diff --git a/AllLangHelp_sbasic.mk b/AllLangHelp_sbasic.mk index 4d8075d258..d2435e0026 100644 --- a/AllLangHelp_sbasic.mk +++ b/AllLangHelp_sbasic.mk @@ -326,6 +326,7 @@ $(eval $(call gb_AllLangHelp_add_helpfiles,sbasic,\ helpcontent2/source/text/sbasic/shared/03132500 \ helpcontent2/source/text/sbasic/shared/03140000 \ helpcontent2/source/text/sbasic/shared/03140001 \ + helpcontent2/source/text/sbasic/shared/03140002 \ 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/03140002.xhp b/source/text/sbasic/shared/03140002.xhp new file mode 100644 index 0000000000..a4ebc9cb38 --- /dev/null +++ b/source/text/sbasic/shared/03140002.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="textsbasicshared03140002xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">IPmt Function [Runtime - VBA]</title> + <filename>/text/sbasic/shared/03140002.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="ipmt"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150499"> + <bookmark_value>IPmt function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3150499" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03140002.xhp" name="IPmt Function [Runtime - VBA]">IPmt Function [Runtime - VBA]</link></paragraph> +<paragraph id="par_id3151384" role="paragraph" xml-lang="en-US">Calculates the periodic amortizement for an investment with regular payments and a constant interest rate.</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">IPmt(Rate as Double, Per as Double, NPer 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_id061420170730135034" role="paragraph" xml-lang="en-US"><emph>Rate</emph> is the periodic interest rate.</paragraph> +<paragraph id="par_id061420170730137782" role="paragraph" xml-lang="en-US"><emph>Per</emph> is the period, for which the compound interest is calculated. Period=NPER if compound interest for the last period is calculated.</paragraph> +<paragraph id="par_id061420170730134582" role="paragraph" xml-lang="en-US"><emph>NPer</emph> is the total number of periods, during which annuity is paid.</paragraph> +<paragraph id="par_id061420170730144688" role="paragraph" xml-lang="en-US"><emph>PV</emph> is the present cash value in sequence of payments.</paragraph> +<paragraph id="par_id061420170730148520" role="paragraph" xml-lang="en-US"><emph>FV</emph> (optional) is the desired value (future value) at the end of the periods.</paragraph> +<paragraph id="par_id061420170730141431" role="paragraph" xml-lang="en-US"><emph>Due</emph> (optional) is the due date for the periodic payments.</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 ExampleIPmt</paragraph> +<paragraph id="par_id061420170142169416" role="bascode" localize="false" xml-lang="en-US"> Dim myIPmt As Double</paragraph> +<paragraph id="par_id06142017014218316" role="bascode" localize="false" xml-lang="en-US"> myIPmt = IPmt(0.05,5,7,15000)</paragraph> +<paragraph id="par_id061420170142332315" role="bascode" xml-lang="en-US"> Print myIPmt ' returns -352.97 currency units. The compound interest during the fifth period (year) is 352.97 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_id3149339">IPMT 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 f42d5b8b2c..582e2ce0e1 100644 --- a/source/text/sbasic/shared/special_vba_func.xhp +++ b/source/text/sbasic/shared/special_vba_func.xhp @@ -73,7 +73,7 @@ <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> + <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> |