Article
11/18/2011

String.PadRight Method (Int32)

Microsoft Silverlight will reach end of support after October 2021. Learn more.

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

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

Syntax

'Declaration
Public Function PadRight ( _
    totalWidth As Integer _
) As String

public string PadRight(
    int totalWidth
)

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.

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

Exception	Condition
ArgumentOutOfRangeException	totalWidth is less than zero.

Remarks

A Unicode space is defined as hexadecimal 0x20.

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

Dim str As String
str = "BBQ and Slaw"

outputBlock.Text += "|"
outputBlock.Text += str.PadRight(15)
outputBlock.Text += "|" ' Displays "|BBQ and Slaw   |". + vbCrLf

outputBlock.Text += "|"
outputBlock.Text += str.PadRight(5)
outputBlock.Text += "|" ' Displays "|BBQ and Slaw|". + vbCrLf

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.

Partager via