This documentation is archived and is not being maintained.

StringInfo.SubstringByTextElements Method (Int32)

Note: This method is new in the .NET Framework version 2.0.

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
)
public String SubstringByTextElements (
	int startingTextElement
)
public function SubstringByTextElements (
	startingTextElement : int
) : String

Parameters

startingTextElement

The index of a text element in this StringInfo object.

Return Value

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 typeCondition

ArgumentOutOfRangeException

startingTextElement is less than zero.

-or-

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

The startingTextElement index is zero-based.

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

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0
Show: