.NET Framework Class Library
StringPadRight Method (Int32)

Returns a new string that left-aligns the characters in this string by padding them with spaces on the right, for a specified total length.

Namespace:   System
Assembly:  mscorlib (in mscorlib.dll)
Syntax
Public Function PadRight ( _
	totalWidth As [%$TOPIC/34d75d7s_en-us_VS_110_1_0_0_0_0%] _
) As [%$TOPIC/34d75d7s_en-us_VS_110_1_0_0_0_1%]
public [%$TOPIC/34d75d7s_en-us_VS_110_1_0_1_0_0%] PadRight(
	[%$TOPIC/34d75d7s_en-us_VS_110_1_0_1_0_1%] totalWidth
)
public:
[%$TOPIC/34d75d7s_en-us_VS_110_1_0_2_0_0%]^ PadRight(
	[%$TOPIC/34d75d7s_en-us_VS_110_1_0_2_0_1%] totalWidth
)
member PadRight : 
        totalWidth:[%$TOPIC/34d75d7s_en-us_VS_110_1_0_3_0_0%] -> [%$TOPIC/34d75d7s_en-us_VS_110_1_0_3_0_1%]

Parameters

totalWidth
Type: SystemInt32

The number of characters in the resulting string, equal to the number of original characters plus any additional padding characters.

Return Value

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

totalWidth is less than zero.

Remarks

A Unicode space is defined as hexadecimal 0x0020.

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.

NoteNote

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.

Examples

The following example demonstrates the PadRight method.

Dim str As String
str = "BBQ and Slaw"

Console.Write("|")
Console.Write(str.PadRight(15))
Console.WriteLine("|") ' Displays "|BBQ and Slaw   |".

Console.Write("|")
Console.Write(str.PadRight(5))
Console.WriteLine("|") ' Displays "|BBQ and Slaw|".
string str;
str = "BBQ and Slaw";

Console.Write("|");
Console.Write(str.PadRight(15));
Console.WriteLine("|");       // Displays "|BBQ and Slaw   |".

Console.Write("|");
Console.Write(str.PadRight(5));
Console.WriteLine("|");       // Displays "|BBQ and Slaw|".
String^ str = "BBQ and Slaw";
Console::Write( "|" );
Console::Write( str->PadRight( 15 ) );
Console::WriteLine( "|" ); // Displays "|BBQ and Slaw   |".
Console::Write( "|" );
Console::Write( str->PadRight( 5 ) );
Console::WriteLine( "|" ); // Displays "|BBQ and Slaw|".
Version Information

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8
Platforms

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.