用指定的字串以及設定來篩選文檔。
nCount = document.Filter( strFilter, iColumn, flags[, xBegin[, xEnd]] );
nCount = document.Filter( strFilter, iColumn, flags[, xBegin[, xEnd]] )
strFilter
指定一個要搜尋的字串。
iColumn
指定您想要搜尋的以 1 為基準文字的欄位的索引;如果您要搜尋整行,可以指定 0 ;如果您要用字元數把開始以及結束的文字指定為xBegin 和 xEnd,可以指定 -1。
flags
從如下值中指定一個組合。
eeFindContinue |
指定下次調用的 Filter 方法不會清除篩選記錄。在調用 Filter 方法之后,這個篩選不會被馬上應用。您可以在您要進行多個級別的篩選時,使用這個標志。它與 eeFindKeepPrevious 標志相同,但由于實際的篩選不會在每次調用消息時被應用,這個方法更適用于多個篩選級別。 |
eeFindKeepPrevious |
指定 Filter 方法不能在應用新篩選前清除已存在的篩選記錄。您可以在您要進行多個級別的篩選時,使用這個標志。 |
eeFindLogicalOr |
指定一個邏輯分離 (logical OR) 到之前的層級上在多層級篩選的情況下。 |
eeFindNegative |
顯示篩選工具列并排除與指定字串符合的行。 |
eeFindRemoveLast |
刪除前一次添加的篩選級別。 |
eeFindReplaceCase |
大小寫需符合。 |
eeFindReplaceEscSeq |
使用逸出序列。不能與 eeFindReplaceRegExp 合用。 |
eeFindReplaceOnlyWord |
整個單字需符合。 |
eeFindReplaceRegExp |
使用規則運算式搜尋字串。不能與 eeFindReplaceEscSeq 合用。 |
xBegin
指定您想要搜尋的文字的欄位開始的索引 (用邏輯字元數) ;您也可以指定 0 如果您想要把文字的最后一部分作為 xEnd。要使這個欄位有效,iColumn 值必須是 -1。
xEnd
指定您想要搜尋的文字的欄位結束的索引 (用邏輯字元數) ;您也可以指定 0 如果您想要搜尋所有剩下的文字。要使這個欄位有效,iColumn 值必須是 -1。
返回值是與指定字串符合的行數。如果指定字串是一個空字串,返回值是 -1。如果指定的是 eeFindContinue,返回值則為 0。
支持 EmEditor Professional 14.7 或之后的版本。