System.String.PadLeft Method

Returns a new string that right-aligns the characters in this instance by padding them on the left with a specified Unicode character, for a specified total length.

Syntax

public string PadLeft (int totalWidth, char paddingChar)

Parameters

totalWidth
The number of characters in the resulting string, equal to the number of original characters plus any additional padding characters.
paddingChar
A Unicode padding character.

Returns

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

TypeReason
ArgumentException totalWidth is less than zero.

Remarks

The string.PadLeft(int, 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.

Requirements

Namespace: System
Assembly: mscorlib (in mscorlib.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0, 4.0.0.0