Export (0) Print
Expand All
1 out of 2 rated this helpful - Rate this topic

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, 
	wchar_t paddingChar
)
public String PadLeft (
	int totalWidth, 
	char paddingChar
)
public function PadLeft (
	totalWidth : int, 
	paddingChar : char
) : 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.

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 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.

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 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
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.