String.PadLeft Method (Int32)

Right-aligns the characters in this instance, padding with spaces on the left for a specified total length.

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

Syntax

'Declaration
Public Function PadLeft ( _
    totalWidth As Integer _
) As String
public string PadLeft(
    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 right-aligned and padded on the left 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 PadLeft(Int32) method pads the beginning of the returned string. This means that, when used with right-to-left languages, it pads the right 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 leading white space so that its total length is totalWidth characters.

Examples

The following code example demonstrates the PadLeft method.

Dim str As String
str = "BBQ and Slaw"
outputBlock.Text += str.PadLeft(15) ' Displays "   BBQ and Slaw". + vbCrLf
outputBlock.Text += str.PadLeft(5)  ' Displays "BBQ and Slaw". + vbCrLf
string str = "BBQ and Slaw";
outputBlock.Text += str.PadLeft(15) + "\n";  // Displays "   BBQ and Slaw".
outputBlock.Text += str.PadLeft(5) + "\n";   // Displays "BBQ and Slaw".

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.