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: Bridge (in Bridge.dll)

Syntax

C++

[TemplateAttribute]
public string PadLeft(
	int totalWidth
)

<TemplateAttribute> _
Public Function PadLeft ( _
	totalWidth As Integer _
) As String

[TemplateAttribute]
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

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
System..::..ArgumentOutOfRangeException	totalWidth is less than zero.

String..::..PadLeft Method (Int32)

Syntax

Parameters

Return Value

Exceptions

See Also