PadLeft Method (Int32, Char)
Collapse the table of content
Expand the table of content

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

public string PadLeft(
	int totalWidth,
	char paddingChar


Type: System.Int32

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

Type: System.Char

A Unicode padding character.

Return Value

Type: System.String

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.

Exception Condition

totalWidth is less than zero.

The PadLeft(Int32, Char) 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.


If the PadLeft method pads the current instance with whitespace characters, this method does not modify the value of the current instance. Instead, it returns a new string that is padded with leading paddingChar characters so that its total length is totalWidth characters.

The following example demonstrates the PadLeft method.

using System.Data.Odbc;

class Program
    static void Main()
        OdbcConnectionStringBuilder builder = 
            new OdbcConnectionStringBuilder();
        builder.ConnectionString = GetConnectionString();

        // Call TryGetValue method for multiple
        // key names. Demonstrate that the search is not
        // case sensitive.
        DisplayValue(builder, "Driver");
        DisplayValue(builder, "SERVER");
        // How about a property you did not set?
        DisplayValue(builder, "DNS");
        // Invalid keys?
        DisplayValue(builder, "Invalid Key");
        // Null values?
        DisplayValue(builder, null);

        Console.WriteLine("Press any key to continue.");

    private static string GetConnectionString()
        // To avoid storing the connection string in your code,
        // you can retrieve it from a configuration file using the 
        // System.Configuration.ConfigurationSettings.AppSettings property. 
        return "Driver={SQL Server};Server=(local);" +

    private static void DisplayValue(OdbcConnectionStringBuilder builder, string key)
        object value = null;

        // Although TryGetValue handles missing keys,
        // it does not handle passing in a null (Nothing in Visual Basic)
        // key. This example traps for that particular error, but
        // throws any other unknown exceptions back out to the
        // caller. 
            if (builder.TryGetValue(key, out value))
                Console.WriteLine("{0}='{1}'", key, value);
                Console.WriteLine("Unable to retrieve value for '{0}'", key);
        catch (ArgumentNullException ex)
            Console.WriteLine("Unable to retrieve value for null key.");

Universal Windows Platform
Available since 4.5
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
© 2015 Microsoft