|
|
| Line 4: |
Line 4: |
|
| |
|
| ==Syntax== | | ==Syntax== |
| {{Template:String:PAI syntax}} | | {{Template:Record:PAI syntax}} |
| {{Template:String:PrintAllInformation syntax}} | | {{Template:Record:PrintAllInformation syntax}} |
|
| |
|
| ===Syntax terms=== | | ===Syntax terms=== |
| <table class="syntaxTable"> | | <table class="syntaxTable"> |
| <tr><th>%outString</th> | | <tr><th>record</th> |
| <td>A string variable to receive the result of the <var>Center</var> / <var>Centre</var> method.</td></tr> | | <td>A <var>Record</var> object.</td></tr> |
| <tr><th>string</th>
| | </table> |
| <td>The string to which the method is applied.</td></tr>
| |
| | |
| <tr><th>length</th>
| |
| <td>The number of characters desired in the output <var class="term">%string</var>. If this value is greater than the length of the method object <var class="term">string</var>, the method object <var class="term">string</var> is padded on both the right and left to the requested length. If the method object is shorter than <var class="term">length</var>, it is cropped on both the left and right.</td></tr>
| |
| | |
| <tr><th><var>Pad</var></th>
| |
| <td>This is an optional, [[Notation conventions for methods#Named parameters|name required]], parameter that defines the character used to pad <var class="term">string</var> on the right and left (if the <var class="term">length</var> value is greater than the length of <var class="term">string</var>). If an uneven number of pad characters is required, the location of the extra pad character is determined by the value of the <var>OffsetLeft</var> parameter. The default for <var class="term">c</var> is a blank character (<code>' '</code>). Specifying an explicit null (<code><nowiki>''</nowiki></code>) results in no padding.</td></tr>
| |
|
| |
|
| <tr><th><var>OffsetLeft</var></th>
| | ==Usage notes== |
| <td>An optional, name-required, argument that is a <var>[[Boolean enumeration|Boolean]]</var> enumeration value indicating where to put the extra character if the requested padding or cropping is asymmetric. If the required number of pad characters or characters to be cropped is not even, the default (<code>False</code>) is to produce an extra character on the right.</td></tr>
| |
| </table>
| |
|
| |
|
| {{Template:Record:PAI and PrintAllInformation footer}} | | {{Template:Record:PAI and PrintAllInformation footer}} |
Latest revision as of 19:27, 11 July 2014
Print All Information from record (Record class)
PrintAllInformation is a synonym for the PAI subroutine.
Syntax
record:PAI
record:PrintAllInformation
Syntax terms
Usage notes