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, Char)

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)

public string PadLeft (
	int totalWidth,
	char paddingChar
)
public String PadLeft (
	int totalWidth, 
	char paddingChar
)
public function PadLeft (
	totalWidth : int, 
	paddingChar : char
) : String

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.

Return Value

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

Exception typeCondition

ArgumentException

totalWidth is less than zero.

The following code example demonstrates the PadLeft method.

String^ str = "forty-two";
Console::WriteLine( str->PadLeft( 15, L'.' ) ); // Displays "......forty-two".
Console::WriteLine( str->PadLeft( 2, L'.' ) );  // Displays "forty-two".

Windows 98, Windows 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 .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft