Search [edit]

A class designed to handle all sorts of text searches within a Document.

Constructors

    • new Search()

    Creates a new Search object. The following search options are avaliable:

    Creates a new Search object. The following search options are avaliable:

    • needle: The string or regular expression you're looking for
    • backwards: Whether to search backwards from where cursor currently is. Defaults to false.
    • wrap: Whether to wrap the search back to the beginning when it hits the end. Defaults to false.
    • caseSensitive: Whether the search ought to be case-sensitive. Defaults to false.
    • wholeWord: Whether the search matches only on whole words. Defaults to false.
    • range: The Range to search within. Set this to null for the whole document
    • regExp: Whether the search is a regular expression or not. Defaults to false.
    • start: The starting Range or cursor position to begin the search
    • skipCurrent: Whether or not to include the current line in the search. Default to false.

    Methods

    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.

    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

    sessionEditSession

    Required. The session to search with

    Searches for all occurances options.needle. If found, this method returns an array of Ranges where the text first occurs. If options.backwards is true, the search goes backwards in the session.

    Searches for all occurances options.needle. If found, this method returns an array of Ranges where the text first occurs. If options.backwards is true, the search goes backwards in the session.

    Arguments

    sessionEditSession

    Required. The session to search with

    Returns an object containing all the search options.

    Returns an object containing all the search options.

    Searches for options.needle in input, and, if found, replaces it with replacement.

    Searches for options.needle in input, and, if found, replaces it with replacement.

    Arguments

    inputString

    Required. The text to search in

    replacementString

    Required. The replacing text

    Returns

    String

    If options.regExp is true, this function returns input with the replacement already made. Otherwise, this function just returns replacement.

    • If options.needle was not found, this function returns null.

    Sets the search options via the options parameter.

    Sets the search options via the options parameter.

    Arguments

    optionsObject

    Required. An object containing all the new search properties