.NET Framework Class Library
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)
Syntax
Public Function PadRight ( _
	totalWidth As [%$TOPIC/36f2hz3a_en-us_VS_110_1_0_0_0_0%], _
	paddingChar As [%$TOPIC/36f2hz3a_en-us_VS_110_1_0_0_0_1%] _
) As [%$TOPIC/36f2hz3a_en-us_VS_110_1_0_0_0_2%]
public [%$TOPIC/36f2hz3a_en-us_VS_110_1_0_1_0_0%] PadRight(
	[%$TOPIC/36f2hz3a_en-us_VS_110_1_0_1_0_1%] totalWidth,
	[%$TOPIC/36f2hz3a_en-us_VS_110_1_0_1_0_2%] paddingChar
)
public:
[%$TOPIC/36f2hz3a_en-us_VS_110_1_0_2_0_0%]^ PadRight(
	[%$TOPIC/36f2hz3a_en-us_VS_110_1_0_2_0_1%] totalWidth, 
	[%$TOPIC/36f2hz3a_en-us_VS_110_1_0_2_0_2%] paddingChar
)
member PadRight : 
        totalWidth:[%$TOPIC/36f2hz3a_en-us_VS_110_1_0_3_0_0%] * 
        paddingChar:[%$TOPIC/36f2hz3a_en-us_VS_110_1_0_3_0_1%] -> [%$TOPIC/36f2hz3a_en-us_VS_110_1_0_3_0_2%]
public function PadRight(
	totalWidth : [%$TOPIC/36f2hz3a_en-us_VS_110_1_0_4_0_0%], 
	paddingChar : [%$TOPIC/36f2hz3a_en-us_VS_110_1_0_4_0_1%]
) : [%$TOPIC/36f2hz3a_en-us_VS_110_1_0_4_0_2%]

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: SystemString
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.
Exceptions
ExceptionCondition
ArgumentOutOfRangeException

totalWidth is less than zero.

Remarks

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.

NoteNote

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.

Examples

The following example demonstrates the PadRight method.

Dim str As String 
Dim pad As Char
str = "forty-two"
pad = Convert.ToChar(".") 
Console.WriteLine(str.PadRight(15, pad)) ' Displays "|forty-two......|".
Console.WriteLine(str.PadRight(2,  pad)) ' Displays "|forty-two|".
string str = "forty-two";
char pad = '.';

Console.WriteLine(str.PadRight(15, pad));    // Displays "forty-two......".
Console.WriteLine(str.PadRight(2,  pad));    // Displays "forty-two".
String^ str = "forty-two";
Console::Write( "|" );
Console::Write( str->PadRight( 15, '.' ) );
Console::WriteLine( "|" ); // Displays "|forty-two......|".
Console::Write( "|" );
Console::Write( str->PadRight( 5, '.' ) );
Console::WriteLine( "|" ); // Displays "|forty-two|".
Version Information

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8