A class designed to handle all sorts of text searches within a Document.
Search[edit]
Constructors
- Search.new()
Creates a new Search object. The following search options are avaliable:
- needle: string or regular expression
- backwards: false
- wrap: false
- caseSensitive: false
- wholeWord: false
- range: Range or null for whole document
- regExp: false
- start: Range or position
- skipCurrent: false
Methods
- Search.$matchIterator(EditSession session)
Arguments
| session | EditSession | Required. The session to search with |
- Search.find(EditSession session)
Searches for options.needle. If found, this method returns the Range where the text first occurs. If options.backwards is true, the search goes backwards in the session.
Arguments
| session | EditSession | Required. The session to search with |
- Search.findAll(EditSession session)
- [ Range ]
Searches for all occurances options.needle. If found, this method returns an array of Range where the text first occurs. If options.backwards is true, the search goes backwards in the session.
Arguments
| session | EditSession | Required. The session to search with |
- Search.getOptions()
Returns an object containing all the search options.