FindString(Int32,String,Int32) メソッド

リストコントロール内で、指定した文字列で始まる項目を検索します。

構文

Visual Basic (宣言)
C#

Public Overloads Function FindString( _
   ByVal findTargetColumnIndex As Integer, _
   ByVal s As String, _
   ByVal startIndex As Integer _
) As Integer

public int FindString( 
   int findTargetColumnIndex,
   string s,
   int startIndex
)

パラメータ

findTargetColumnIndex: 検索対象となるカラムのインデックス (Int32 型)
s: 検索対象の文字列（String 型）
startIndex: ListItemCollectionオブジェクト内の検索開始位置（インデックス）（Int32 型）

戻り値の型

検索対象の文字列で始まる最初の項目のインデックス。

例外

例外解説

例外	解説
System.ArgumentOutOfRangeException	`findTargetColumnIndex`に負の値が設定されています。または `startIndex`に負の値または項目の総数以上の値が設定されています。

System.ArgumentOutOfRangeException

findTargetColumnIndexに負の値が設定されています。

または

startIndexに負の値または項目の総数以上の値が設定されています。

解説

FindStringメソッドは、Itemsプロパティが参照するListItemCollectionオブジェクトを検索し、指定した文字列で始まる最初の項目の0から始まるインデックスが返されます。項目が見つからなかった場合は-1が返されます。

使用例

次のサンプルコードは、FindStringメソッドの使用方法を示します。

Visual Basic
C#

Imports GrapeCity.Web.Input.IMList
Imports GrapeCity.Web.Input.Core.ListBox
Imports System.Diagnostics

' コントロールにカラムを設定します。
GcListBox1.Columns.Add(New ListColumn("カラム1"))
GcListBox1.Columns.Add(New ListColumn("カラム2"))
GcListBox1.Columns.Add(New ListColumn("カラム3"))

' コントロールに項目を追加します。
GcListBox1.Items.Add(New ListItem(New SubItem("AAA"), New SubItem("abcde"), New SubItem(DateTime.Parse("2015/12/01"))))
GcListBox1.Items.Add(New ListItem(New SubItem("BBB"), New SubItem("bcdef"), New SubItem(DateTime.Parse("2015/12/15"))))
GcListBox1.Items.Add(New ListItem(New SubItem("CCC"), New SubItem("cdefg"), New SubItem(DateTime.Parse("2015/11/01"))))
GcListBox1.Items.Add(New ListItem(New SubItem("DDD"), New SubItem("defgh"), New SubItem(DateTime.Parse("2015/11/15"))))

' FindStringメソッドを使って検索します。
Dim foundIndex As Integer = GcListBox1.FindString(1, "bcd", 0)

' 検索結果をデバッグウィンドウに表示します。
Debug.WriteLine(GcListBox1.Items(foundIndex).Text)

using GrapeCity.Web.Input.IMList;
using GrapeCity.Web.Input.Core.ListBox;
using System.Diagnostics;

// コントロールにカラムを設定します。
GcListBox1.Columns.Add(new ListColumn("カラム1"));
GcListBox1.Columns.Add(new ListColumn("カラム2"));
GcListBox1.Columns.Add(new ListColumn("カラム3"));

// コントロールに項目を追加します。
GcListBox1.Items.Add(new ListItem(new SubItem("AAA"), new SubItem("abcde"), new SubItem(DateTime.Parse("2015/12/01"))))
GcListBox1.Items.Add(new ListItem(new SubItem("BBB"), new SubItem("bcdef"), new SubItem(DateTime.Parse("2015/12/15"))))
GcListBox1.Items.Add(new ListItem(new SubItem("CCC"), new SubItem("cdefg"), new SubItem(DateTime.Parse("2015/11/01"))))
GcListBox1.Items.Add(new ListItem(new SubItem("DDD"), new SubItem("defgh"), new SubItem(DateTime.Parse("2015/11/15"))))

// FindStringメソッドを使って検索します。
int foundIndex = GcListBox1.FindString(1, "bcd", 0);

// 検索結果をデバッグウィンドウに表示します。
Debug.WriteLine(GcListBox1.Items(foundIndex).Text);

参照

GcListBox クラス
 GcListBox メンバ
 オーバーロード一覧