Description
Returns a modified copy of the calling String with characters added to achieve the specified length.
Timing Precision Mode
This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.
Click here to see the documentation for this object in nanosecond timing precision mode.
Overload List
Signatures
|
Return Value
|
Description
|
VirtualString.Pad(Variable side, Variable totalLength)
|
String
|
Returns a modified copy of the calling String with spaces added so that the length of the returned String is equal to totalLength. If totalLength is less-than or equal-to the length of the calling String, no spaces are added. When side is "Left" or "Right", spaces are prepended or appended to the calling String, respectively. When side is "Both", spaces are alternately prepended and then appended.
|
VirtualString.Pad(Variable side, Variable totalLength, String padCharacter)
|
String
|
Returns a modified copy of the calling String withpadCharacter added so that the length of the returned String is equal to totalLength. If totalLength is less-than or equal-to the length of the calling String, no characters are added. When side is "Left" or "Right", characters are prepended or appended to the calling String, respectively. When side is "Both", characters are alternately prepended and then appended.
|
See also
VirtualString Object
|