String.PadLeft Method (Int32)
Updated: August 2011
Right-aligns the characters in this instance, padding with spaces on the left for a specified total length.
Assembly: mscorlib (in mscorlib.dll)
'Declaration Public Function PadLeft ( _ totalWidth As Integer _ ) As String 'Usage Dim instance As String Dim totalWidth As Integer Dim returnValue As String returnValue = instance.PadLeft(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 ValueType: 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.
A Unicode space is defined as hexadecimal 0x20.
The 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.
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.
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.