| StringPadRight Method (Int32, Char) |
Returns a new string that left-aligns the characters in this string by padding them on the right with a specified Unicode character, for a specified total length.
Namespace: System
Assembly: mscorlib (in mscorlib.dll) Version: 4.0.0.0
SyntaxC#
public string PadRight( int totalWidth, char paddingChar )
Parameters
- totalWidth
- Type: SystemInt32
The number of characters in the resulting string, equal to the number of original characters plus any additional padding characters. - paddingChar
- Type: SystemChar
A Unicode padding character.
Return Value
Type: StringA new string that is equivalent to this instance, but left-aligned and padded on the right with as many paddingChar characters 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.
Exceptions| Exception | Condition |
|---|---|
| ArgumentOutOfRangeException | totalWidth is less than zero. |
See Also