diff options
| author | Olivier Hallot <olivier.hallot@libreoffice.org> | 2017-07-23 23:55:04 -0300 |
|---|---|---|
| committer | Olivier Hallot <olivier.hallot@edx.srv.br> | 2017-07-24 13:16:34 +0200 |
| commit | 60d67acd3b161461bbd0f84c7e12be97553b6ebe (patch) | |
| tree | 9dcdf4485beab1b0f412d9fda50f570d9d3d5547 | |
| parent | 7e0d91b15d875f6bf7fa94edf96a0bb791d5e8b3 (diff) | |
tdf#108676 Help page for VBA function PPmt
Change-Id: I689c08037890630d0bb49305bec23e518bf085c8
Reviewed-on: https://gerrit.libreoffice.org/40350
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/auxiliary/sbasic.tree | 1 | ||||
| -rw-r--r-- | source/text/sbasic/shared/03140008.xhp | 82 | ||||
| -rw-r--r-- | source/text/sbasic/shared/special_vba_func.xhp | 4 |
4 files changed, 85 insertions, 3 deletions
diff --git a/AllLangHelp_sbasic.mk b/AllLangHelp_sbasic.mk index cce356b848..e4c4d2a6d8 100644 --- a/AllLangHelp_sbasic.mk +++ b/AllLangHelp_sbasic.mk @@ -332,6 +332,7 @@ $(eval $(call gb_AllLangHelp_add_helpfiles,sbasic,\ helpcontent2/source/text/sbasic/shared/03140005 \ helpcontent2/source/text/sbasic/shared/03140006 \ helpcontent2/source/text/sbasic/shared/03140007 \ + helpcontent2/source/text/sbasic/shared/03140008 \ 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 b089a120c0..f8453e5fe2 100644 --- a/source/auxiliary/sbasic.tree +++ b/source/auxiliary/sbasic.tree @@ -206,6 +206,7 @@ <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/03140008.xhp">PPmt 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/03140008.xhp b/source/text/sbasic/shared/03140008.xhp new file mode 100644 index 0000000000..c8ac0fb1ed --- /dev/null +++ b/source/text/sbasic/shared/03140008.xhp @@ -0,0 +1,82 @@ +<?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="textsbasicshared03140008xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">PPmt Function [Runtime - VBA]</title> + <filename>/text/sbasic/shared/03140008.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="ppmt"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150499"> + <bookmark_value>PPmt function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3150499" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03140008.xhp" name="PPmt Function [Runtime - VBA]">PPmt Function [Runtime - VBA]</link></paragraph> +<paragraph id="par_id3151384" role="paragraph" xml-lang="en-US">Returns for a given period the payment on the principal for an investment that is based on periodic and constant payments and a constant interest rate.</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, Per 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_id230720172341443986" role="paragraph" xml-lang="en-US"><emph>Per</emph> The period number for which you want to calculate the principal payment (must be an integer between 1 and Nper).</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_id230720172348086669" role="bascode" localize="false" xml-lang="en-US">REM ***** BASIC *****</paragraph> +<paragraph id="par_id230720172348086665" role="bascode" localize="false" xml-lang="en-US">Option VBASupport 1</paragraph> +<paragraph id="par_id230720172348087342" role="bascode" localize="false" xml-lang="en-US">Sub ExamplePPmt</paragraph> +<paragraph id="par_id230720172348083623" role="bascode" xml-lang="en-US">' Calculate the principal payments during months 4 & 5, for a loan that is to be paid in full</paragraph> +<paragraph id="par_id230720172348089449" role="bascode" xml-lang="en-US">' over 6 years. Interest is 10% per year and payments are made at the end of the month.</paragraph> +<paragraph id="par_id23072017234808488" role="bascode" localize="false" xml-lang="en-US">Dim ppMth4 As Double</paragraph> +<paragraph id="par_id230720172348084787" role="bascode" localize="false" xml-lang="en-US">Dim ppMth5 As Double</paragraph> +<paragraph id="par_id230720172348088178" role="bascode" xml-lang="en-US">' Principal payment during month 4:</paragraph> +<paragraph id="par_id230720172348084356" role="bascode" localize="false" xml-lang="en-US">ppMth4 = PPmt( 0.1/12, 4, 72, 100000 )</paragraph> +<paragraph id="par_id230720172348086687" role="bascode" xml-lang="en-US">print ppMth4 ' ppMth4 is calculated to be -1044,94463903636</paragraph> +<paragraph id="par_id230720172348081077" role="bascode" xml-lang="en-US">' Principal payment during month 5:</paragraph> +<paragraph id="par_id230720172348086143" role="bascode" localize="false" xml-lang="en-US">ppMth5 = PPmt( 0.1/12, 5, 72, 100000 )</paragraph> +<paragraph id="par_id230720172348086456" role="bascode" xml-lang="en-US">print ppMth5' ppMth5 is calculated to be -1053,65251102833</paragraph> +<paragraph id="par_id23072017234808812" 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_id3150026">PPMT 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 bec2c7bf47..3b5ab3017a 100644 --- a/source/text/sbasic/shared/special_vba_func.xhp +++ b/source/text/sbasic/shared/special_vba_func.xhp @@ -62,12 +62,10 @@ <embed href="text/sbasic/shared/03140005.xhp#nper"/> <embed href="text/sbasic/shared/03140006.xhp#npv"/> <embed href="text/sbasic/shared/03140007.xhp#pmt"/> +<embed href="text/sbasic/shared/03140008.xhp#ppmt"/> <list type="unordered"> <listitem> - <paragraph id="par_id051820170335298807" role="paragraph" localize="false" xml-lang="en-US">PPmt</paragraph> - </listitem> - <listitem> <paragraph id="par_id051820170335294050" role="paragraph" localize="false" xml-lang="en-US">PV</paragraph> </listitem> <listitem> |