User Tools

Site Tools


syntax:functions:padend
no way to compare when less than two revisions

Differences

This shows you the differences between two versions of the page.


Previous revision
Last revision
syntax:functions:padend [2021/08/02 03:57] craigt
Line 1: Line 1:
 +====== PadEnd(text, pad_char, total_len) ======
 +Category:  Text function
  
 +\\ 
 +=====Description=====
 +This function pads the end of //text// with //pad_char// up to a total length defined by //total_len//.
 +
 +\\ 
 +=====Arguments=====
 +^Argument^Type^Description^
 +|text|Text|The text value to be padded.|
 +|pad_char|Text (a single character)|The character to append to the end of //text// repeatedly until the total string length of //total_len// is reached.|
 +|total_len|Number|The total length of the result string including //text// plus all repeated instances of //pad_text//.|
 +
 +**Return value type:** Text
 +
 +\\ 
 +=====Remarks=====
 +//text// and //pad_char// are implicitly converted to text values if required.
 +
 +Entering a value for //pad_char// longer than a single character results in an error message.
 +
 +Entering a value for //total_len// equal to or less than the length of //text// simply returns the value of //text//.
 +
 +\\ 
 +=====Examples=====
 +
 +  padend('99', '0', 5) = '99000'
 +  padend('1000', '0', 3) = '1000'  //Result length entered (3) is less than the length of '1000' (4)
 +
 +\\ 
 +===== See also =====
 +  * [[syntax:functions:padstart|PadStart(text, pad_char, total_len)]]
syntax/functions/padend.txt · Last modified: 2021/08/14 22:21 by craigt

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki