Article
11/18/2011

String.PadLeft Method (Int32, Char)

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

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

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

Syntax

'Declaration
Public Function PadLeft ( _
    totalWidth As Integer, _
    paddingChar As Char _
) As String

public string PadLeft(
    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 right-aligned and padded on the left 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 PadLeft(Int32, Char) 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.

Note:
This method does not modify the value of the current instance. Instead, it returns a new string that is padded with leading paddingChar characters so that its total length is totalWidth characters.

Examples

The following code example demonstrates the PadLeft method.

Dim str As String
Dim pad As Char
str = "forty-two"
pad = "."c
outputBlock.Text += str.PadLeft(15, pad) ' Displays "......forty-two". + vbCrLf
outputBlock.Text += str.PadLeft(2, pad) ' Displays "forty-two". + vbCrLf

string str = "forty-two";
char pad = '.';

outputBlock.Text += String.Format(str.PadLeft(15, pad)) + "\n";    // Displays "......forty-two".
outputBlock.Text += String.Format(str.PadLeft(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.

Share via