Home » Products » UltraEdit/UEStudio » Menu Commands (UE) » Search

Find command

This command displays a dialog box for searching the document for the specified text. 

 

 

The string to search for is specified in the Find What [1] field.  A single or multi-line string up to 20,000 bytes may be used.  The user will determine which direction the search will be executed by pressing the Next or Previous button to initialize the search.  In HEX mode, the search is performed in the direction specified with the Direction radio buttons.  If the string is not found, the search wraps around to the other end of the file and continues the search.  If the string is not matched a message indicating that the string is not found is displayed.

 

In addition to searching for printable characters, tab characters and newline (Carriage Return/Line Feed) characters may be searched for.  To search for a Tab character, use "^t" characters in the dialog.  To search for the newline characters, use "^p" characters for CR/ LF, "^n" for LF only and "^r" for CR only in the dialog.  To search for a "^" character, use "^^" in the dialog.

 

Additionally, the characters "^s" will be replaced with any text that is highlighted when a find is executed and the characters "^c" will be replaced with the contents of the clipboard (up to 30,000 characters).  This is useful particularly for macros.  When recording a macro, the option exists to include a find of a specified character string, or using "^s" the macro records the "^s" and when replayed will determine the text highlighted at the time the macro is playing back, likewise when using "^c", these characters will be replaced with the contents of the clipboard at the time the macro is playing back.

 

Special character summary:

Symbol

Function

^^

searches for a "^" character

^s

searches for selected (highlighted) text when a macro is running

^c

searches for the contents of the clipboard when a macro is running

^b

matches a page break

^p

matches a newline (CR/LF) (paragraph) (DOS Files)

^r

matches a newline (CR Only) (paragraph) (MAC Files)

^n

matches a newline (LF Only) (paragraph) (UNIX Files)

^ t

matches a tab character

 

Note - ^ refers to the character '^' NOT Control Key + value.

 

If the button is pressed the find history is displayed.

 

If the button is pressed the Favorites submenu with the following options is presented:

 

Add to Favorites

adds current item in combobox to Favorites list

Edit Favorites

presents Edit Find/Replace Favorites dialog where users can name favorite search strings, organize the list and remove items from the list

Favorites

presents submenu displaying the Favorites list.  Strings may be selected from the list to populate the combobox

 

If the button is pressed a list of regular expression options appropriate to the selected Regular Expression Engine is displayed.  This button is subdued unless the Regular Expressions checkbox is selected.

 

To select all text between the cursor position and the search target, hold down the SHIFT key at the time the search is started with the Find Next button.

 

Count All

Count All presents a dialog indicating the number of times the current search string occurs in the active file.  If Find Where is limited to Selected Text, the number of items returned will be restricted to the selected text.  If Search In Column is selected, the number of items returned will be restricted to the specified columns.

 

Find Where [3]

The user may specify if the search should be executed in the Current File, Selected Text or All Open Files in the Find Where section and the replace will be limited to the specified area.  If All Open Files is selected, pressing Find Next will automatically move focus to the first occurrence in the next open file.  This functionality replaces the Find Next through all opened files option from older versions.

 

The following search options [2] exist:

 

Match Whole Word Only

By default, the search will not be restricted to matching whole words only. This option allows the search to be restricted to whole words only. This is useful for searching for 'a', or 'A' without finding all words including 'a'. If a search has already occurred in a document, the default selection will match the previous search.

 

Match Case

By default, the search will not be case sensitive. The option to make the search case sensitive is given. If a search has already occurred in the document, the default selection for case sensitivity is that of the previous search.  This option also affects regular expressions.  If this is not checked, [A-Za-z] and [A-Z] are equal to [a-z].

 

Regular Expressions

If this option is selected the search will be executed using the regular expression type selected under the Advanced section.

 

Advanced Options [4]

Pressing the Advanced button extends the Find in Files dialog to display additional search options.

 

Regular Expressions

Perl Compatible Regular Expressions

If this option is selected the editor will use Perl style regular expressions based on the Boost C++ Libraries.

 

UltraEdit Style Regular Expressions

If this option is selected the editor will use UltraEdit style regular expressions.

 

UNIX Style Regular Expressions

If this option is selected the editor will use UNIX style regular expressions.

 

For information regarding creation of regular expressions see Regular Expressions or Perl Regular Expressions help.

 

Highlight All Items Found

This option causes all items matching the search string to be highlighted (shown as selected text) when the Find Next button is pressed.

 

List Lines Containing String

This option causes UltraEdit to search for all occurrences of the string in the active document and to list them in a dialog box. By double-clicking on one of the result lines (or selecting it and clicking on Goto) UltraEdit will position to that line in the file.  The Lines Containing Find String dialog includes a Shown Lines checkbox option.  If this is selected, the line numbers associated with the matched strings will be displayed in the Lines Containing Find String dialog.

 

Close this dialog after find

If this option is selected, and a matching string is found when Next is pressed, the Find dialog is closed.

 

Search In Column

If this option is selected the search will be restricted to the specified start and end columns.  The number specified for the end column must be greater than the number specified for the start column (except when searching an entire line).  To search an entire line, "0" and "-1" should be used.  It is important to note that column numbering begins with "0" so From Col. would have to be set to "0" to search from the beginning of a line.

 

If the editor active window is in Hex mode, an additional option exists:

 

ASCII

By default, in Hex mode, the search will be for hexadecimal characters.  Optionally the find may be configured to search for ASCII characters.

 

When a find operation is complete the text is highlighted.

 

Initially after the find is performed, a slim dialog box is displayed enabling easy selection of find and find next. This may be disabled by changing the INI settings.

 

Hide Lines

If this button is pressed all lines matching the specified search string will be hidden in the active file using code folding.

 

Show Lines

If this button is pressed only lines matching the specified search string will be displayed in the active file.  All non-matching lines will be hidden using code folding.

 

Shortcut:        ALT+F3 or CTRL+F  

Attachments
There are no attachments for this article.
Related Articles
Select to matching brace command
Viewed 2403 times since Thu, Oct 13, 2011
Quick Find command
Viewed 1770 times since Mon, Feb 10, 2014
Find Prev command
Viewed 1203 times since Thu, Oct 13, 2011
Find Symbol
Viewed 2216 times since Thu, Oct 13, 2011
Replace in Files command
Viewed 1865 times since Thu, Oct 13, 2011
Word Count command
Viewed 4882 times since Thu, Oct 13, 2011
Toggle Bookmark command
Viewed 2403 times since Thu, Oct 13, 2011
Miscellaneous
Viewed 2079 times since Thu, Oct 13, 2011
Goto Line/Page/Bookmark command
Viewed 3513 times since Thu, Oct 13, 2011
Save Bookmarks
Viewed 2426 times since Thu, Oct 20, 2011