StringInfo.SubstringByTextElements Method (Int32, Int32)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Retrieves a substring of text elements from the current StringInfo object starting from a specified text element and continuing through the specified number of text elements.

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

Public Function SubstringByTextElements (
	startingTextElement As Integer,
	lengthInTextElements As Integer
) As String


Type: System.Int32

The zero-based index of a text element in this StringInfo object.

Type: System.Int32

The number of text elements to retrieve.

Return Value

Type: System.String

A substring of text elements in this StringInfo object. The substring consists of the number of text elements specified by the lengthInTextElements parameter and starts from the text element index specified by the startingTextElement parameter.

Exception Condition

startingTextElement is less than zero.


startingTextElement is greater than or equal to the length of the string that is the value of the current StringInfo object.


lengthInTextElements is less than zero.


The string that is the value of the current StringInfo object is the empty string ("").


startingTextElement + lengthInTextElements specify an index that is greater than the number of text elements in this StringInfo object.

Consider a string that consists of five text elements, indexed from 0 through 4. If the startingTextElement parameter is 1 and the lengthInTextElements parameter is 3, the SubstringByTextElements method returns a substring that consists of the text elements for which the indexes are 1, 2, and 3.

.NET Framework
Available since 2.0
Return to top