String.PadRight Method (Int32, Char)

Left-aligns the characters in this string, padding on the right with a specified Unicode character, for a specified total length.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)

Syntax

'Declaration
Public Function PadRight ( _
    totalWidth As Integer, _
    paddingChar As Char _
) As String
public string PadRight(
    int totalWidth,
    char paddingChar
)

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.

Exceptions

Exception Condition
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:

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 code example demonstrates the PadRight method.

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

outputBlock.Text += String.Format(str.PadRight(15, pad)) + "\n";    // Displays "forty-two......".
outputBlock.Text += String.Format(str.PadRight(2, pad)) + "\n";    // Displays "forty-two".

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.