String::PadRight 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.
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.
- paddingChar
-
Type:
System::Char
A Unicode padding character.
Return Value
Type: System::String^A 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.
| Exception | Condition |
|---|---|
| ArgumentOutOfRangeException | totalWidth is less than zero. |
The PadRight(Int32, Char) 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 |
|---|
If the PadRight method pads the current instance with whitespace characters, this method does not modify the value of the current instance. Instead, it returns a new string that is padded with trailing paddingChar characters so that its total length is totalWidth characters. |
The following example demonstrates the PadRight method.
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
