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.
Assembly: mscorlib (in mscorlib.dll)
Public Function PadLeft ( _ totalWidth As [%$TOPIC/0zk6ydzx_en-us_VS_110_1_0_0_0_0%] _ ) As [%$TOPIC/0zk6ydzx_en-us_VS_110_1_0_0_0_1%]
public [%$TOPIC/0zk6ydzx_en-us_VS_110_1_0_1_0_0%] PadLeft( [%$TOPIC/0zk6ydzx_en-us_VS_110_1_0_1_0_1%] totalWidth )
public: [%$TOPIC/0zk6ydzx_en-us_VS_110_1_0_2_0_0%]^ PadLeft( [%$TOPIC/0zk6ydzx_en-us_VS_110_1_0_2_0_1%] totalWidth )
member PadLeft : totalWidth:[%$TOPIC/0zk6ydzx_en-us_VS_110_1_0_3_0_0%] -> [%$TOPIC/0zk6ydzx_en-us_VS_110_1_0_3_0_1%]
The number of characters in the resulting string, equal to the number of original characters plus any additional padding characters.
Return ValueType: SystemString
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 0x0020.
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.
The following example demonstrates the PadLeft method.
Dim str As String str = "BBQ and Slaw" Console.WriteLine(str.PadLeft(15)) ' Displays " BBQ and Slaw". Console.WriteLine(str.PadLeft(5)) ' Displays "BBQ and Slaw".
string str = "BBQ and Slaw"; Console.WriteLine(str.PadLeft(15)); // Displays " BBQ and Slaw". Console.WriteLine(str.PadLeft(5)); // Displays "BBQ and Slaw".
String^ str = "BBQ and Slaw"; Console::WriteLine( str->PadLeft( 15 ) ); // Displays " BBQ and Slaw". Console::WriteLine( str->PadLeft( 5 ) ); // Displays "BBQ and Slaw".
Windows 8.1, Windows Server 2012 R2, 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.