String.EndsWith Method (String, StringComparison)
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Determines whether the end of this string matches the specified string when compared using the specified comparison option.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- value
- Type: System.String
The string to match.
- comparisonType
- Type: System.StringComparison
One of the enumeration values that determines how this string and value are compared.
Return Value
Type: System.Booleantrue if the value parameter matches the end of this string; otherwise, false.
| Exception | Condition |
|---|---|
| ArgumentNullException | value is null. |
| ArgumentException | comparisonType is not a StringComparison value. |
The EndsWith method compares the value parameter to the substring at the end of this string and returns a value that indicates whether they are equal. To be equal, value must be a reference to this same string, be the empty string (""), or match the end of this string. The type of comparison performed by the EndsWith method depends on the value of the comparisonType parameter.
The following code example determines whether a string ends with a particular substring. The results are affected by the choice of culture, whether case is ignored, and whether an ordinal comparison is performed.
// This example demonstrates the // System.String.EndsWith(String, StringComparison) method. using System; using System.Threading; class Example { public static void Demo(System.Windows.Controls.TextBlock outputBlock) { string intro = "Determine whether a string ends with another string, " + "using\n different values of StringComparison."; StringComparison[] scValues = { StringComparison.CurrentCulture, StringComparison.CurrentCultureIgnoreCase, StringComparison.InvariantCulture, StringComparison.InvariantCultureIgnoreCase, StringComparison.Ordinal, StringComparison.OrdinalIgnoreCase }; outputBlock.Text += intro + "\n"; // Display the current culture because the culture-specific comparisons // can produce different results with different cultures. outputBlock.Text += String.Format("The current culture is {0}.\n", Thread.CurrentThread.CurrentCulture.Name) + "\n"; // Determine whether three versions of the letter I are equal to each other. foreach (StringComparison sc in scValues) { outputBlock.Text += String.Format("StringComparison.{0}:", sc) + "\n"; Test(outputBlock, "abcXYZ", "XYZ", sc); Test(outputBlock, "abcXYZ", "xyz", sc); outputBlock.Text += "\n"; } } protected static void Test(System.Windows.Controls.TextBlock outputBlock, string x, string y, StringComparison comparison) { string resultFmt = "\"{0}\" {1} with \"{2}\"."; string result = "does not end"; // if (x.EndsWith(y, comparison)) result = "ends"; outputBlock.Text += String.Format(resultFmt, x, result, y) + "\n"; } } /* This code example produces the following results: Determine whether a string ends with another string, using different values of StringComparison. The current culture is en-US. StringComparison.CurrentCulture: "abcXYZ" ends with "XYZ". "abcXYZ" does not end with "xyz". StringComparison.CurrentCultureIgnoreCase: "abcXYZ" ends with "XYZ". "abcXYZ" ends with "xyz". StringComparison.InvariantCulture: "abcXYZ" ends with "XYZ". "abcXYZ" does not end with "xyz". StringComparison.InvariantCultureIgnoreCase: "abcXYZ" ends with "XYZ". "abcXYZ" ends with "xyz". StringComparison.Ordinal: "abcXYZ" ends with "XYZ". "abcXYZ" does not end with "xyz". StringComparison.OrdinalIgnoreCase: "abcXYZ" ends with "XYZ". "abcXYZ" ends with "xyz". */