Show/Hide Toolbars

EmEditor Help

Navigation: EmEditor Help > Macro Reference > Filters Collection > Methods

EmEditor Macro Reference: Add Method

Scroll Prev Top Next More
EmEditor Home - EmEditor Help - EmEditor Macro Reference - Filters Collection

Add Method

Adds an item.

[JavaScript]

list.Add( strFilter, bEnabled, iColumn, nFlags, xBegin, xEnd );

[VBScript]

list.Add strFilter, bEnabled, iColumn, nFlags, xBegin, xEnd

Parameters

strFilter

Specifies a string to search for.

bEnabled

Specifies whether this filter is enabled.

iColumn

Specifies the one-based index of the column of the text you want to search, 0 if you want to search for whole lines, or -1 if you want to specify the beginning and end of the text in characters as xBegin and xEnd.

nFlags

Specifies a combination of the following values.

eeFindLogicalOr

Specifies a logical disjunction (logical OR) to the previous level in case of multiple levels of the filter.

eeFindNegative

Shows the Filter toolbar and excludes the lines that match the specified string.

eeFindReplaceCase

Matches cases.

eeFindReplaceEscSeq

Uses escape sequences. Cannot be combined with eeFindReplaceRegExp.

eeFindReplaceOnlyWord

Matches only whole words.

eeFindReplaceRegExp

Uses a regular expression for the searched string. Cannot be combined with eeFindReplaceEscSeq.

xBegin

Specifies the index of beginning of the column (in logical characters) of the text you want to search, or 0 if you want to count the last portion of the text and specify as xEnd. The iColumn must be -1 to enable this field.

xEnd

Specifies the index of end of the column (in logical characters) of the text you want to search, or 0 if you want to search all the rest of the text. The iColumn must be -1 to enable this field.

Version

Supported on EmEditor Professional Version 16.0 or later.

Copyright © 2003-2016 by Emurasoft, Inc.