String.PadRight String.PadRight String.PadRight Method

Definition

Returns a new string of a specified length in which the end of the current string is padded with spaces or with a specified Unicode character.

Overloads

PadRight(Int32) PadRight(Int32) PadRight(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.

PadRight(Int32, Char) PadRight(Int32, Char) PadRight(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.

PadRight(Int32) PadRight(Int32) PadRight(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.

public:
 System::String ^ PadRight(int totalWidth);
public string PadRight (int totalWidth);
Public Function PadRight (totalWidth As Integer) As String
Parameters
totalWidth
Int32 Int32 Int32

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

Returns

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

Examples

The following example demonstrates the PadRight method.

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|".
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|".

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.

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 white space so that its total length is totalWidth characters.

See Also

PadRight(Int32, Char) PadRight(Int32, Char) PadRight(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.

public:
 System::String ^ PadRight(int totalWidth, char paddingChar);
public string PadRight (int totalWidth, char paddingChar);
Public Function PadRight (totalWidth As Integer, paddingChar As Char) As String
Parameters
totalWidth
Int32 Int32 Int32

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

paddingChar
Char Char Char

A Unicode padding character.

Returns

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

Examples

The following example demonstrates the PadRight method.

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|".
string str = "forty-two";
char pad = '.';

Console.WriteLine(str.PadRight(15, pad));    // Displays "forty-two......".
Console.WriteLine(str.PadRight(2,  pad));    // Displays "forty-two".
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|".

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.

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.

See Also

Applies to