Open the search function over Edit | Find and replace (see Running a search).
Use the Find and replace dialog to search for (and replace) certain captions or items within your project. The following table gives an overview of the various features within the Find and replace dialog.
Table 13: Controls for find and replace
|
Find |
Enter the term to be found.
TIP: To reuse terms from previous searches, click the arrow to the right of the field and select the required term. |
|
Find as |
Select whether you would like to search using simple text or by wildcards or regular expressions. |
|
Replace by |
(Optional) Enter the text that will replace the text found. |
|
Find scope |
If you would like to further narrow the search, you can select which objects you would like to search for here:
-
Current document: Only the current document is included in the search.
-
Current document and its extensions: Only the current document and all of its extensions are included in the search.
-
Current document and its parent documents: Only the current document and all of its parent items are included in the search.
-
Below the selected object: Only the objects below the current object are included in the search.
-
All API Designer objects: All objects are included in the search. |
|
Find options |
Configure other search settings:
-
Case sensitive: API Designer finds only occurrences of the text that match the case that you have entered into the Find field.
-
Whole word: Only the whole word is included in the search. Example: If you enter Person, the search will only find “person” and not “persons.”
-
Match entire value: API Designer finds only objects containing the exact values that match the text you have entered into the Find field.
-
Filter by type: Select the objects to which your search will be limited. |
|
Find |
Finds and opens the next occurrence of the term. |
|
Find all |
Triggers a search that lists all occurrences of the text in the Find results pane. |
|
Find results |
Lists all occurrences of the term. |
|
Replace |
Replaces the occurrence of the term that you have highlighted in Find results with the text that you have entered in the Replace by field. |
|
Replace all |
Replaces all occurrences of the term that you have selected in the Replace column under Find results with the text that you have entered in the Replace by field. |
Wildcards
Use wildcards to replace a single character, or a string of characters, using a single character when searching for strings. The most common wildcards are the question mark (?), to symbolize an individual character, and the asterisk (*), to symbolize any combination of characters.
To use wildcards in the Find and replace dialog, enter the search term into the Find field and select the Wildcards option from the Find as list.
|
Examples
The following table gives some examples of wildcard searches:
|
P*n |
Finds "person," "position," "plugin," and so on. |
|
Per* |
Finds "person," "personal," "perfection," and so on. |
|
AP?.json |
Finds "API.json" but not "APIProject.json." | |
Regular expressions
Regular expressions (also known as "regex" or "regexp") are similar to wildcards in that they also allow you to find strings. Regular expressions are more effective than wildcards, however.
To use regular expressions in the Find and replace dialog, enter the search term into the Find field and select the Regular expressions option from the Find as list.
|
Examples
The following table gives some examples of regular expressions:
|
[a-z] |
Any lowercase Latin letter |
|
[A-Z] |
Any uppercase Latin letter |
|
\d |
A digit |
|
\D |
A character that is not a digit |
|
\w |
A letter, a digit, or an underscore |
|
\W |
A character that is neither a letter, a number, nor an underscore |
|
\s |
Blank space |
|
\S |
A character that is not a blank space |
|
{n} |
The preceding term must occur exactly "n" number of times.
Example: C{3} finds "CCC” |
|
| |
Alternatives
Example: Regex|Regexp finds "Regex" or "Regexp” |
|
? |
The preceding term is optional, it can occur once, but does not need to, that is, the term either occurs once or not at all. | |
Related topics
You can perform a search of the whole project, or parts of it, at any time.
To run a search
-
Click Edit | Find and replace on the menu bar.
-
In the Find and replace dialog, enter a search term in the Find field.
-
In the Find as list, select whether you would like to search using simple text or by wildcards or regular expressions.
-
(Optional) In the Replace by field, enter the text to replace the text in the search.
-
In the Find scope list, select which objects you would like to include in the search.
-
(Optional) In the Find options pane, click 
Expand to configure further search settings.
-
Click Find or Find all.
The search results are displayed in the Find results pane
-
In the Find options pane, click Expand to configure further search settings.
-
(Optional) Double-click a result in the results list.
This marks and displays the corresponding nodes in the definition tree view.
-
(Optional) To replace a result, highlight it in the Find results pane and click Replace.
-
(Optional) To replace several results, enable the checkbox next to the relevant results and click Replace all.
Related topics
Open the Multilingual captions dialog using 
Captions.
Use the Multilingual captions dialog to add, edit, or delete captions in multiple languages. You can use this text later in your API or web application.
Before adding or editing multilingual captions, define objects in your project that output captions in your API. You create keys for these objects. You assign a text to the keys for each language. This means that the keys are translated into the different languages you wish to use.
You can create and edit keys and translations on the Captions tab in the Multilingual captions dialog The following table gives an overview of the various features within the Multilingual captions dialog.
Related topics
You can create multilingual captions at any time.
To create a multilingual caption
-
Click Captions on the menu bar.
-
Click 
Add on the toolbar in the Multilingual captions dialog.
-
In the Edit pane, enter a unique value in the Key field to be used to reference the text.
NOTE: If you have not added a translation for a language, the API will use the caption that has been saved under Key.
-
Select the caption’s language in the Language list.
-
Enter the caption to be shown for the selected language in the Text field.
-
Repeat the previous two steps for all the required languages.
-
Click 
Save on the toolbar in the Multilingual captions dialog.
-
Click Apply.
Related topics
Delete