Bridge

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

Returns a new string that right-aligns the characters in this instance by padding them on the left with a specified Unicode character, for a specified total length.

Namespace:  System
Assembly:  Bridge (in Bridge.dll)

Syntax

[TemplateAttribute]
public string PadLeft(
	int totalWidth,
	char ch
)
<TemplateAttribute> _
Public Function PadLeft ( _
	totalWidth As Integer, _
	ch As Char _
) As String
[TemplateAttribute]
public:
String^ PadLeft(
	int^ totalWidth, 
	wchar_t^ ch
)

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.
ch
Type: System..::..Char

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

ExceptionCondition
System..::..ArgumentOutOfRangeExceptiontotalWidth is less than zero.

See Also

String Class
PadLeft Overload
System Namespace