SubstringByTextElements Method (Int32)

StringInfo.SubstringByTextElements Method (Int32)

 

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

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

public string SubstringByTextElements(
	int startingTextElement
)

Parameters

startingTextElement
Type: System.Int32

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

Return Value

Type: System.String

A substring of text elements in this StringInfo object, starting from the text element index specified by the startingTextElement parameter and continuing through the last text element in this object.

Exception Condition
ArgumentOutOfRangeException

startingTextElement is less than zero.

-or-

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

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

.NET Framework
Available since 2.0
Return to top
Show:
© 2016 Microsoft