Any suggestions? Export (0) Print
Expand All

String.PadLeft Method (Int32)

 

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

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

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.

Exception Condition
ArgumentOutOfRangeException

totalWidth is less than zero.

A Unicode space is defined as hexadecimal 0x0020.

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.

System_CAPS_noteNote

If the PadLeftmethod pads the current instance with whitespace characters, 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.

The following example demonstrates the PadLeft method.

string str = "BBQ and Slaw";
Console.WriteLine(str.PadLeft(15));  // Displays "   BBQ and Slaw".
Console.WriteLine(str.PadLeft(5));   // Displays "BBQ and Slaw".

Universal Windows Platform
Available since 4.5
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show:
© 2016 Microsoft