Export (0) Print
Expand All

String.PadLeft Method (Int32, Char)

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.

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

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.

ExceptionCondition
ArgumentOutOfRangeException

totalWidth is less than zero.

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.

NoteNote

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.

The following example demonstrates the PadLeft method.


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

Console.WriteLine(str.PadLeft(15, pad));    // Displays "......forty-two".
Console.WriteLine(str.PadLeft(2, pad));     // Displays "forty-two".


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

ADD
Show:
© 2014 Microsoft