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

指定のシート内の指定のヘッダセル範囲のテキストから、指定の基準に一致する指定の文字列を検索します。

構文

Visual Basic
C#

'Declaration
 
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 パラメータは、文字列が見つかったセルの行インデックスおよび列インデックスを返します。

解説

includeCellTextオプションは、SearchHeadersメソッドでヘッダに含まれるセルのテキストを検索することを意味します。

例

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

C#
Visual Basic

// Page Load
FpSpread1.Sheets[0].RowHeader.Cells[0, 0].Text = "Row Header";
private void Button1_Click(object sender, System.EventArgs e)
{ 
int x = 0;
int y = 0;
FarPoint.Web.Spread.SearchFoundFlags sff;
sff = FpSpread1.SearchHeaders(0, "Row Header", true, false, false, false, false, true, false, false, 0, 0, 2, 2, ref x, ref y);
ListBox1.Items.Add(sff.ToString());
ListBox1.Items.Add(x.ToString());
ListBox1.Items.Add(y.ToString());
}

' Page Load
FpSpread1.Sheets(0).RowHeader.Cells(0, 0).Text = "Row Header"
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.Web.Spread.SearchFoundFlags
sff = FpSpread1.SearchHeaders(0, "Row Header", True, False, False, False, False, True, False, False, 0, 0, 2, 2, x, y)
ListBox1.Items.Add(sff.ToString())
ListBox1.Items.Add(x)
ListBox1.Items.Add(y)
End Sub

参照

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