find Parameter

Specifies default options for both the find command and the Editor - Find and Replace dialog box.

Scope: View

Syntax

query find.{cancel|case|columnnums|columns|findstring|
            forward|history|historysize|mark|match|
            prompt|replacestring|scope|wrap} 
query findoptions 
set find.{cancel|case|columns|forward|history|mark|
          match|prompt|wrap} {on|off} 
set find.{columnnums Number1 Number2} 
set find.{findstring String} 
set find.{historysize Number} 
set find.{replacestring String} 
set find.{scope all|current|selection} 

Options

cancel 
Set to on to cancel the Find and Replace dialog box after a successful find operation.
case 
Set to on to make find operations character case sensitive.
columnnums 
Specify left and right column positions using integer values between 1 and 2499, inclusive. If the columns parameter is set on, find operations search only text between and including these columns.
columns 
Set to on to restrict find operations to the columns specified by the find.columnnums parameter.
findoptions 
Display the present value of all find parameter options set to on. Also, display the value of the find.scope parameter.
findstring 
Set the string or match pattern to find. If you set a search pattern, that pattern must adhere to the rules of regular expression, and the match option must be set on.
forward 
Set to on to search forward from the cursor location. If set to off, the find operation will search backward from the cursor position.
history 
Set to on to save the current find string or match pattern in the find-history log. The maximum number of entries in this log is set by the historysize option.
historysize 
Set the maximum find-history log size, using an integer value between 1 and 25, inclusive.
mark 
Set to on to mark found text or match patterns.
match 
Set to on to specify that the find operation treat the search item as a match pattern conforming to the rules of regular expression, and not as a text string.
prompt 
Set to on to set the Replace, then Find radio button as a default in the Editor - Find and Replace dialog box.
replacestring 
Set the new string to replace the found string.
scope 
Set the scope of the find operation. Valid values are:
all 
Search the entire document.
current 
Search only the current element.
selection 
Search only selected text.
wrap 
Set to on if you want the find operation to search the entire document, regardless of the position of the cursor at the time the search is started. Otherwise, the find operation will stop when it reaches the beginning or end of the file, depending on your chosen search direction.

This option has no effect if the forward option is set to off.

Description

The find parameter sets options used by the find command. All parameter options are saved between editing sessions except:

When the find command is run with a specified search string, that search string becomes the new value of the find.findstring parameter.

Examples

  1. To set the search string to lost, type:
    set find.findstring lost 
  2. To restrict find operations to between columns 10 and 25, type:
    set find.columnnums 10 25 
    set find.columns on 

    The first line only defines the column boundaries. The second line instructs the Editor to restrict find operations to bounds set by the find.columnnums parameter.

  3. To redefine the maximum number of find operations stored in the history log to six entries, type:
    set find.historysize 6 

API Return Code

-2 
Invalid option specified.

find Command