Parameters

totalWidth

The number of characters in the resulting string, equal to the number of original characters plus any additional padding characters.

Returns

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

Type	Reason
ArgumentException	totalWidth is less than zero.

Remarks

A Unicode space is defined as hexadecimal 0x0020.

The string.PadLeft(int) 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.

Requirements