String.PadRight Method (Int32)
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Returns a new string of a specified length in which the end of the string is padded with spaces or a specified Unicode character.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- totalWidth
- Type: System.Int32
The number of characters in the resulting string, equal to the number of original characters plus any additional padding characters.
Return Value
Type: System.StringA new string that is equivalent to this instance, but left-aligned and padded on the right with as many spaces as needed to create a length of totalWidth. However, if totalWidth is less than the length of this instance, the method returns a reference to the existing instance. If totalWidth is equal to the length of this instance, the method returns a new string that is identical to this instance.
| Exception | Condition |
|---|---|
| ArgumentOutOfRangeException | totalWidth is less than zero. |
A Unicode space is defined as hexadecimal 0x20.
The PadRight(Int32) method pads the end of the returned string. This means that, when used with right-to-left languages, it pads the left portion of the string.
Note: |
|---|
This method does not modify the value of the current instance. Instead, it returns a new string that is padded with trailing white space so that its total length is totalWidth characters. |
The following code example demonstrates the PadRight method.
Dim str As String str = "BBQ and Slaw" outputBlock.Text += "|" outputBlock.Text += str.PadRight(15) outputBlock.Text += "|" ' Displays "|BBQ and Slaw |". + vbCrLf outputBlock.Text += "|" outputBlock.Text += str.PadRight(5) outputBlock.Text += "|" ' Displays "|BBQ and Slaw|". + vbCrLf
Note: