StringInfo.SubstringByTextElements メソッド

定義

現在の StringInfo オブジェクトからテキスト要素の部分文字列を取得します。

オーバーロード

SubstringByTextElements(Int32)

指定されたテキスト要素から最後のテキスト要素までの範囲内で、現在の StringInfo オブジェクトからテキスト要素の部分文字列を取得します。

SubstringByTextElements(Int32, Int32)

指定されたテキスト要素から指定された数のテキスト要素までの範囲内で、現在の StringInfo オブジェクトからテキスト要素の部分文字列を取得します。

SubstringByTextElements(Int32)

指定されたテキスト要素から最後のテキスト要素までの範囲内で、現在の StringInfo オブジェクトからテキスト要素の部分文字列を取得します。

public:
 System::String ^ SubstringByTextElements(int startingTextElement);
public string SubstringByTextElements (int startingTextElement);
member this.SubstringByTextElements : int -> string
Public Function SubstringByTextElements (startingTextElement As Integer) As String

パラメーター

startingTextElement
Int32

この StringInfo オブジェクトのテキスト要素の 0 から始まるインデックス。

戻り値

String

startingTextElement パラメーターで指定されたテキスト要素インデックスから、このオブジェクトの最後のテキスト要素までの範囲内にある、この StringInfo オブジェクトのテキスト要素の部分文字列。

例外

startingTextElement が 0 未満です。

  • または - 現在の StringInfo オブジェクトの値である文字列は、空の文字列 ("") です。

注釈

0 から 4 のインデックスが付く 5 つのテキスト要素で構成される文字列を考え考えてみることができます。 パラメーターが 1 の場合、 メソッドは、インデックスが startingTextElement SubstringByTextElements 1、2、3、4 のテキスト要素で構成される部分文字列を返します。

適用対象

SubstringByTextElements(Int32, Int32)

指定されたテキスト要素から指定された数のテキスト要素までの範囲内で、現在の StringInfo オブジェクトからテキスト要素の部分文字列を取得します。

public:
 System::String ^ SubstringByTextElements(int startingTextElement, int lengthInTextElements);
public string SubstringByTextElements (int startingTextElement, int lengthInTextElements);
member this.SubstringByTextElements : int * int -> string
Public Function SubstringByTextElements (startingTextElement As Integer, lengthInTextElements As Integer) As String

パラメーター

startingTextElement
Int32

この StringInfo オブジェクトのテキスト要素の 0 から始まるインデックス。

lengthInTextElements
Int32

取得するテキスト要素の数。

戻り値

String

この StringInfo オブジェクト内のテキスト要素の部分文字列。 部分文字列は、lengthInTextElements パラメーターで指定された数のテキスト要素で構成され、startingTextElement パラメーターで指定されたテキスト要素インデックスから開始します。

例外

startingTextElement が 0 未満です。

  • または - startingTextElement は、現在の StringInfo オブジェクトの値である文字列の長さ以上です。

  • または - lengthInTextElements が 0 未満です。

  • または - 現在の StringInfo オブジェクトの値である文字列は、空の文字列 ("") です。

  • または - startingTextElement + lengthInTextElements は、この StringInfo オブジェクト内のテキスト要素の数より大きいインデックスを指定します。

注釈

0 から 4 のインデックスが付く 5 つのテキスト要素で構成される文字列を考え考えてみることができます。 パラメーターが 1 で、 パラメーターが 3 の場合、 メソッドは、インデックスが startingTextElement lengthInTextElements SubstringByTextElements 1、2、および 3 のテキスト要素で構成される部分文字列を返します。

適用対象