Difference between revisions of "Find Dialog"

Latest revision as of 23:59, 28 June 2023

The Find dialog lets you search your model--or these Analytica docs--to find an object by its identifier, or for text in its title, description, or other text attributes. To open the dialog, click the magnifying glass icon , press Ctrl+F, or select Find on the Object menu. If you first select an identifier or other text in a definition or other text attribute, the Dialog opens with that text copied into the Search for field.

In attribute menu: By default, it searches for an Identifier containing the search text. Use this menu to select another attribute to search, including Title, Units, Description, Definition, or All text attributes. It finds any object whose selected attribute(s) contains the text being searched for.

Checkboxes

Case sensitive: Check to match letters exactly with upper- and lower-case. By default it ignores case.
Include system objects: Check to include built-in system functions and variables in your search.
Regular expression: Check to use wildcards and other options in your search string using a regular expression. Regular expressions offer powerful matching options. Here are a few of the most useful:

- ^Text: Find only objects starting with "Text". This would include an identifier (or other attribute) like "IsText" that contains "Text" but doesn't start with "Text".
- Text$: Find objects whose identifier (or other attribute) ends with the characters "text".
- Va\d+ : Find identifiers with "Va" followed by one or more numeric digits, such as "Va1" or "Va13".
- \bword\b: Find "word" only when in appears as a whole word -- with a space, punctuation, or other word boundary on each side.

Show matches with : When you check this, it tags each matching node in its parent Diagram with the Find icon:

Buttons

Find: Open the first matching object. If there are more matches, you can visit them in turn by selecting Find Next from the Object menu, or press Ctrl+G.
List: Open a list of matches in the Outline window. From there you can double-click any item to see it in its Diagram window.
on the Wiki: Opens a browser window and searches the Analytica Wiki online for the specified text. It ignores any attribute selection or checkbox options, including regular expression.

Find in Table tab

If you open the Find Dialog while viewing a table, it shows the Find in Table tab, which lets you search for text within the cells of the table:

Case sensitive: Select this for case-sensitive matching, so that upper and lower case must be as you type it.
Match entire cell: Select this if you want to find a cell that contains only the search text and nothing more.

Table search does not work with regular expressions.

History

Analytica 4.0: Introduced Find in Table.
Analytica 4.6 and earlier: The Find Objects and Find-in-Table dialogs were separate. From a table, the option of searching for objects was not available. To search for objects while viewing a table, bring a non-table window into the foreground, then select Find.
Analytica 5.0: Introduced the Text option, the use of regular expressions, the option to depict the found set with a magnifying glass icon, the option to List matches in the Outline window, the combination of Find in Table and Find Objects in the same dialog, and the question mark button on the title bar that jumps to this page.

@@ Line 1: / Line 1: @@
-[[Category:Windows and dialogs]]
+   [[Category:Windows and dialogs]]
-''Note: Many aspects of the dialog described here are new to [[Analytica 4.7]].''
 __TOC__
+The Find dialog lets you search your model--or these Analytica docs--to find an object by its identifier, or for text in its title, description, or other text attributes. To open the dialog, click the magnifying glass icon [[File:Find icon.png|alt=Find icon with magnifying glass]], press ''Ctrl+F, or'' select '''Find''' on the [[Object menu]].  If you first select an identifier or other text in a definition or other text attribute, the Dialog opens with that text copied into the '''Search for''' field.
-The Find dialog is accessed by selecting '''Find''' on the '''Object''' menu, or by pressing ''Ctrl+F''. It can also be accessed from the '''Find''' button on the [[Object Finder dialog]]. If you access the Find dialog while viewing a table, a [[#Find in Table|Find in Table]] tab is present, which searches for text within the cells of the table.
 :[[image:Find Dialog.png]]
+In attribute menu: By default, it searches for an Identifier containing the search text. Use this menu to select another attribute to search, including Title, Units, Description, Definition, or All text attributes. It finds any object whose selected attribute(s) contains the text being searched for.
-== Find Objects ==
+==== '''Checkboxes''' ====
+* '''Case sensitive:''' Check to match letters exactly with upper- and lower-case. By default it ignores case.
-Select the '''Find Objects''' tab to search for objects within your model, or for system functions by name or pattern.  This will be the only option when you access the [[Find Dialog]] when not viewing a table.
+* '''Include system objects:''' Check to include built-in system functions and variables in your search.
+* '''Regular expression:'''  Check to use wildcards and other options in your search string using a [[regular expression]]. Regular expressions offer powerful matching options. Here are a few of the most useful:
-=== Search pattern ===
+** <code>^Text</code>: Find only objects starting with "Text". This would include an identifier (or other attribute) like "IsText" that contains "Text" but doesn't start with "Text".
+** <code>Text$</code>: Find objects whose identifier (or other attribute) ends with the characters "text".
-Find will locate objects having the text you type anywhere within the '''Identifier''', '''Title''' or any textual attribute if you select '''Text'''. The search text is a [[regular expression]] (except when you search '''on the Wiki'''), so in addition to simple textual searches, you can use wildcards. Some useful ones include:
+** <code>Va\d+</code> : Find identifiers with "Va" followed by one or more numeric digits, such as "Va1" or "Va13".
+**<code>\bword\b</code>: Find "word" only when in appears as a whole word -- with a space, punctuation, or other word boundary on each side.
-* <code>^Text</code> : Find only objects starting with "Text". This would exclude cases where the letters "text" occur as a substring inside the identifier, title or text.
-* <code>Va\d+</code> : Find identifiers with "Va" followed by one or more numeric digits, such as "Va1" or "Va13".
-*<code>Text$</code>: Find text ending with the characters "text".
-*<code>\bword\b</code>: Finds "word" only when in appears as a whole word -- there must be a word boundary on each side.
-If you have some text selected when you bring up the [[Find Dialog]], the selected text is inserted into the text box for you.
-All searches are case-insensitive.
-=== Attribute to search ===
-You can search by [[Identifier]], [[Title]] or '''Text'''. The attribute selection is ignored when you use '''on the Wiki'''. When you select '''Text''', all textual attributes are searched for the indicated text, including the [[Description]], [[Definition]], [[Units]], [[Title]], [[Identifier]], [[User-defined attributes]], etc.
-=== Show matches with [[image:magnifying glass.png]] ===
-When this is checked, objects in the "found set" will be tagged in the user-interface with a magnifying glass object, e.g.,
+* '''Show matches with [[image:magnifying glass.png]]''': When you check this, it tags each matching node in its parent Diagram with the Find icon:
 :[[image:Found Set Sales model details.png]]
-=== Buttons ===
+==== Buttons ====
-* '''Find''': Press this to jump to the first object matching your criteria. From there you can select '''Find Next''' on the '''Object menu''', or press ''Ctrl+G'', to visit the remaining matches.
+* '''Find''': Open the first matching object. If there are more matches, you can visit them in turn by selecting '''Find Next''' from the [[Object menu]], or press ''Ctrl+G''.
-* '''List''': Opens a list of matches in the [[Outline Window]]. From there you can double-click on matches of interest.
+* '''List''': Open a list of matches in the [[Outline window]]. From there you can double-click any item to see it in its Diagram window.
-* '''on the Wiki''': Opens a browser window and searches the Analytica Wiki for the indicated text.  The "found set" from the previous search is not changed.
+* '''on the Wiki''': Opens a browser window and searches the Analytica Wiki online for the specified text.  It ignores any attribute selection or checkbox options, including regular expression.
-* '''Cancel''': End the dialog without searching.
-== Find in Table ==
+==== Find in Table tab ====
+If you open the  [[Find Dialog]] while viewing a table, it shows the [[#Find in Table|Find in Table]] tab, which lets you search for text within the cells of the table:
 :[[image:Find in Table.png]]
-These options appear when you bring up the [[Find Dialog]] while viewing a table. This searches for the indicated text within the cells of the table.  The search text is literal text, not a [[regular expression]].
 * '''Case sensitive''': Select this for case-sensitive matching, so that upper and lower case must be as you type it.
-* '''Match entire cell''': Select this to exclude finding the pattern within the text of a cell.
+* '''Match entire cell''': Select this if you want to find a cell that contains only the search text and nothing more.
+Table search does not work with [[regular expression|regular expressions]].
 == History ==
@@ Line 57: / Line 39: @@
 * [[What's new in Analytica 4.0?|Analytica 4.0]]: Introduced Find in Table.
 * [[Analytica 4.6]] and earlier: The Find Objects and Find-in-Table dialogs were separate. From a table, the option of searching for objects was not available. To search for objects while viewing a table, bring a non-table window into the foreground, then select '''Find'''.
-* [[Analytica 4.7]]: Introduced the '''Text''' option, the use of [[regular expression]]s, the option to depict the found set with a magnifying glass icon, the option to '''List''' matches in the [[Outline Window]], the combination of Find in Table and Find Objects in the same dialog, and the question mark button on the title bar that jumps to this page.
+* [[Analytica 5.0]]: Introduced the '''Text''' option, the use of [[regular expression]]s, the option to depict the found set with a magnifying glass icon, the option to '''List''' matches in the [[Outline window]], the combination of Find in Table and Find Objects in the same dialog, and the question mark button on the title bar that jumps to this page.
 == See Also ==
-* [[FindObjects]] function
-* [[Outline Window]]
 * [[Object Finder dialog]]
+* [[FindObjects]] function lets you write an expression that searches the model.
+* [[Find variables and other objects]]
+* [[Outline window]]
 * [[Regular Expressions]]