58
58
<h3>Return Value</h3> If the length of <i>s</i> is at least <i>totalWidth</i>, then a new <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemStringClassTopic.asp">String</a> identical to <i>s</i> is returned. Otherwise, <i>s</i> will be padded on the left with as many <i>paddingChar</i> characters as needed to create a length of <i>totalWidth</i>. <h3>Exceptions</h3>
59
59
The function will fail in any of the following circumstances:
60
<div style="margin-left: 40px;"><ul><li><i>totalWidth</i> is less than zero.</li></ul></div><h3>Remarks</h3> Note that only the first character of <i>paddingChar</i> will be used when padding the result. <h3>Examples</h3><ul class="examples"><li><pre class="code">string::pad-left('test', 10, ' ') ==> ' test'</pre></li><li><pre class="code">string::pad-left('test', 10, 'test') ==> 'tttttttest'</pre></li><li><pre class="code">string::pad-left('test', 3, ' ') ==> 'test'</pre></li><li><pre class="code">string::pad-left('test', -4, ' ') ==> ERROR</pre></li></ul><h3>Requirements</h3><div style="margin-left: 20px;"><b>Assembly:</b> NAnt.Core (0.85.1932.0)
60
<div style="margin-left: 40px;"><ul><li><i>totalWidth</i> is less than zero.</li></ul></div><h3>Remarks</h3> Note that only the first character of <i>paddingChar</i> will be used when padding the result. <h3>Examples</h3><ul class="examples"><li><pre class="code">string::pad-left('test', 10, ' ') ==> ' test'</pre></li><li><pre class="code">string::pad-left('test', 10, 'test') ==> 'tttttttest'</pre></li><li><pre class="code">string::pad-left('test', 3, ' ') ==> 'test'</pre></li><li><pre class="code">string::pad-left('test', -4, ' ') ==> ERROR</pre></li></ul><h3>Requirements</h3><div style="margin-left: 20px;"><b>Assembly:</b> NAnt.Core (0.85.2344.0)