• Article

TextInfo.ToLower Method (String)

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Converts the specified string to lowercase.

Namespace:  System.Globalization
Assembly:  mscorlib (in mscorlib.dll)

Syntax

'Declaration
<SecuritySafeCriticalAttribute> _
Public Overridable Function ToLower ( _
    str As String _
) As String

[SecuritySafeCriticalAttribute]
public virtual string ToLower(
    string str
)

Parameters

Return Value

Type: System.String
The specified string converted to lowercase.

Exceptions

Exception Condition
ArgumentNullException

str is null.

Remarks

The returned string might differ in length from the input string. For more information on casing, refer to sections of the Unicode standard that deal with case and case algorithms at the Unicode Web site. The current implementation preserves the length of the string. However, this behavior is not guaranteed and could change in future implementations.

Casing semantics depend on the culture in use. For the invariant culture, the casing semantics are not culture-sensitive. For a specific culture, the casing semantics are sensitive to that culture.

If a security decision depends on a string comparison or a case-change operation, the application should use the CultureInfo.InvariantCulture to ensure that the behavior is consistent regardless of the culture settings of the system. However, the invariant culture must be used only by processes that require culture-independent results, such as system services. Otherwise, it produces results that might be linguistically incorrect or culturally inappropriate.

For more information on cultures, see CultureInfo.

Examples

The following code example changes the casing of a string based on the "en-US" culture.

Imports System.Globalization

Public Class Example
   Public Shared Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)
      ' Defines the string with mixed casing.
      Dim myString As String = "wAr aNd pEaCe"

      ' Creates a TextInfo based on the "en-US" culture.
      Dim myTI As TextInfo = New CultureInfo("en-US").TextInfo

      ' Changes a string to lowercase.
      outputBlock.Text += String.Format("""{0}"" to lowercase: {1}", myString, myTI.ToLower(myString)) & vbCrLf

      ' Changes a string to uppercase.
      outputBlock.Text += String.Format("""{0}"" to uppercase: {1}", myString, myTI.ToUpper(myString)) & vbCrLf
   End Sub 
End Class 
' This example produces the following output.
'       "wAr aNd pEaCe" to lowercase: war and peace
'       "wAr aNd pEaCe" to uppercase: WAR AND PEACE

using System;
using System.Globalization;

public class Example
{
   public static void Demo(System.Windows.Controls.TextBlock outputBlock)
   {
      // Defines the string with mixed casing.
      string myString = "wAr aNd pEaCe";

      // Creates a TextInfo based on the "en-US" culture.
      TextInfo myTI = new CultureInfo("en-US").TextInfo;

      // Changes a string to lowercase.
      outputBlock.Text += String.Format("\"{0}\" to lowercase: {1}", myString, myTI.ToLower(myString)) + "\n";

      // Changes a string to uppercase.
      outputBlock.Text += String.Format("\"{0}\" to uppercase: {1}", myString, myTI.ToUpper(myString)) + "\n";
   }
}
/*
This example produces the following output.
      "wAr aNd pEaCe" to lowercase: war and peace
      "wAr aNd pEaCe" to uppercase: WAR AND PEACE
*/

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.