0 out of 1 rated this helpful - Rate this topic

String.PadLeft Method (Int32)

.NET Framework 4.5

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)

Syntax

C++

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.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	totalWidth is less than zero.

Remarks

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.

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

Examples

The following example demonstrates the PadLeft method.

C++

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

Version Information

.NET Framework

Supported in: 4.5, 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

.NET for Windows Store apps

Supported in: Windows 8

Platforms

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Reference

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)