Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

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)

public string PadLeft (
	int totalWidth
)
public String PadLeft (
	int totalWidth
)
public function PadLeft (
	totalWidth : int
) : String
Not applicable.

Parameters

totalWidth

The number of characters in the resulting string, equal to the number of original characters plus any additional padding characters.

Return Value

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. Or, if totalWidth is less than the length of this instance, a new String object that is identical to this instance.

Exception typeCondition

ArgumentException

totalWidth is less than zero.

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.

The following code 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".

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0

Community Additions

Show:
© 2014 Microsoft