Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

CompareInfo.IsSuffix Method (String, String, CompareOptions)

Determines whether the specified source string ends with the specified suffix using the specified CompareOptions value.

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

'Declaration
<SecuritySafeCriticalAttribute> _
Public Overridable Function IsSuffix ( _
	source As String, _
	suffix As String, _
	options As CompareOptions _
) As Boolean

Parameters

source
Type: System.String
The string to search in.
suffix
Type: System.String
The string to compare with the end of source.
options
Type: System.Globalization.CompareOptions
The CompareOptions value that defines how source and suffix should be compared. options is either the value Ordinal used by itself, or the bitwise combination of one or more of the following values: IgnoreCase, IgnoreSymbols, IgnoreNonSpace, IgnoreWidth, and IgnoreKanaType.

Return Value

Type: System.Boolean
true if the length of suffix is less than or equal to the length of source and source ends with suffix; otherwise, false.

ExceptionCondition
ArgumentNullException

source is Nothing.

-or-

suffix is Nothing.

ArgumentException

options contains an invalid CompareOptions value.

Every string starts and ends with an empty substring (""); therefore, if suffix is an empty string, this method returns true.

The CompareOptions.StringSort value is not valid for this method.

The following example determines whether a string is the prefix or suffix of another string using CompareOptions.


Imports System.Globalization

Public Class Example

   Public Shared Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)

      ' Defines the strings to compare.
      Dim myStr1 As [String] = "calle"
      Dim myStr2 As [String] = "llegar"
      Dim myXfix As [String] = "LLE"

      ' Uses the CompareInfo property of the InvariantCulture.
      Dim myComp As CompareInfo = CultureInfo.InvariantCulture.CompareInfo

      outputBlock.Text += String.Format("IsSuffix ""{0}"", ""{1}""", myStr1, myXfix) & vbCrLf
      outputBlock.Text += String.Format("   With no CompareOptions            : {0}", myComp.IsSuffix(myStr1, myXfix)) & vbCrLf
      outputBlock.Text += String.Format("   With None                         : {0}", myComp.IsSuffix(myStr1, myXfix, CompareOptions.None)) & vbCrLf
      outputBlock.Text += String.Format("   With Ordinal                      : {0}", myComp.IsSuffix(myStr1, myXfix, CompareOptions.Ordinal)) & vbCrLf
      outputBlock.Text += String.Format("   With IgnoreCase                   : {0}", myComp.IsSuffix(myStr1, myXfix, CompareOptions.IgnoreCase)) & vbCrLf

      outputBlock.Text += String.Format("IsPrefix ""{0}"", ""{1}""", myStr2, myXfix) & vbCrLf
      outputBlock.Text += String.Format("   With no CompareOptions            : {0}", myComp.IsPrefix(myStr2, myXfix)) & vbCrLf
      outputBlock.Text += String.Format("   With None                         : {0}", myComp.IsPrefix(myStr2, myXfix, CompareOptions.None)) & vbCrLf
      outputBlock.Text += String.Format("   With Ordinal                      : {0}", myComp.IsPrefix(myStr2, myXfix, CompareOptions.Ordinal)) & vbCrLf
      outputBlock.Text += String.Format("   With IgnoreCase                   : {0}", myComp.IsPrefix(myStr2, myXfix, CompareOptions.IgnoreCase)) & vbCrLf

   End Sub 'Main 

End Class 'SamplesCompareInfo


'This code produces the following output.
'
'IsSuffix "calle", "LLE"
'   With no CompareOptions            : False
'   With None                         : False
'   With Ordinal                      : False
'   With IgnoreCase                   : True
'IsPrefix "llegar", "LLE"
'   With no CompareOptions            : False
'   With None                         : False
'   With Ordinal                      : False
'   With IgnoreCase                   : True



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

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

Community Additions

ADD
Show:
© 2015 Microsoft