SearchHeaders(Int32,String,Boolean,Boolean,Boolean,Boolean,Boolean,Boolean,Boolean,Boolean,Int32,Int32,Int32,Int32,Int32,Int32) メソッド

検索の開始位置と終了位置、およびセルノートとタグも検索対象に含めるかどうかを指定して、指定した文字列を、指定したシートのヘッダセルの指定した範囲にあるテキストから、指定した基準で検索します。

構文

Visual Basic
C#

'宣言
 
Public Overloads Function SearchHeaders( _
   ByVal sheetIndex As Integer, _
   ByVal searchString As String, _
   ByVal searchRowHeaders As Boolean, _
   ByVal caseSensitive As Boolean, _
   ByVal exactMatch As Boolean, _
   ByVal alternateSearch As Boolean, _
   ByVal useWildcards As Boolean, _
   ByVal includeCellText As Boolean, _
   ByVal includeNotes As Boolean, _
   ByVal includeTags As Boolean, _
   ByVal startRowIndex As Integer, _
   ByVal startColumnIndex As Integer, _
   ByVal endRowIndex As Integer, _
   ByVal endColumnIndex As Integer, _
   ByRef foundRowIndex As Integer, _
   ByRef foundColumnIndex As Integer _
) As SearchFoundFlags

public SearchFoundFlags SearchHeaders( 
   int sheetIndex,
   string searchString,
   bool searchRowHeaders,
   bool caseSensitive,
   bool exactMatch,
   bool alternateSearch,
   bool useWildcards,
   bool includeCellText,
   bool includeNotes,
   bool includeTags,
   int startRowIndex,
   int startColumnIndex,
   int endRowIndex,
   int endColumnIndex,
   ref int foundRowIndex,
   ref int foundColumnIndex
)

パラメータ

sheetIndex: 検索を行うシートのインデックス
searchString: 検索文字列
searchRowHeaders: 列ヘッダの代わりに行ヘッダを検索するかどうか
caseSensitive: 検索文字列の大文字と小文字を区別するかどうか
exactMatch: 完全一致のみを検索するかどうか
alternateSearch: 行、列の方向ではなく列、行の方向に検索するかどうか
useWildcards: 検索文字列のワイルドカード文字（*、?）を有効にするかどうか
includeCellText: セルの内容を検索するかどうか
includeNotes: セルのメモの内容を検索するかどうか
includeTags: セルのタグの内容（タグの文字列表現）を検索するかどうか
startRowIndex: 開始行インデックス
startColumnIndex: 開始列インデックス
endRowIndex: 終了行インデックス
endColumnIndex: 終了列インデックス
foundRowIndex: 検索文字列が見つかった行のインデックス
foundColumnIndex: 検索文字列が見つかった列のインデックス

戻り値の型

文字列が見つかったセルまたはセル項目のタイプを示す SearchFoundFlags 設定が返されます。

また、foundRowIndex と foundColumnIndex は、文字列が見つかったセルの行インデックスおよび列インデックスを返します。

使用例

次のサンプルコードは、行ヘッダのテキストを検索します。

C#
Visual Basic

// Form Load
fpSpread1.Sheets[0].RowHeader.Cells[0, 0].Text = "test";

private void button1_Click(object sender, System.EventArgs e)
{
int x = 0;  
int y = 0; 
FarPoint.Win.Spread.SearchFoundFlags sff; 
sff = fpSpread1.SearchHeaders(0, "test", true, false, false, false, false, true, false, false, 0, 0, 5, 5, ref x, ref y);
listBox1.Items.Add(sff.ToString()); 
listBox1.Items.Add(x.ToString()); 
listBox1.Items.Add(y.ToString()); 
}

' Form Load
FpSpread1.Sheets(0).RowHeader.Cells(0, 0).Text = "test"

Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button1.Click
Dim x As Integer
Dim y As Integer
Dim sff As FarPoint.Win.Spread.SearchFoundFlags
sff = FpSpread1.SearchHeaders(0, "test", True, False, False, False, False, True, False, False, 0, 0, 5, 5, x, y)
ListBox1.Items.Add(sff.ToString())
ListBox1.Items.Add(x)
ListBox1.Items.Add(y)
End Sub

参照

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