User Defined Function Editor Dialog Box

You can use the User Defined Function Editor dialog box to write a user-defined function (UDF) which you can call in a formula or another user-defined function. This topic describes the options in the dialog box.

Designer displays the User Defined Function Editor dialog box when you do one of the following:

In the Catalog Manager, right-click the User Defined Functions node, select New Function on the shortcut menu, type a name for the new function and then select OK, or right-click a UDF and select Edit from the shortcut menu.
In the Data panel, right-click a UDF and select Edit from the shortcut menu.
Select <New Function…> under the User Defined Functions node where a formula list is available.

User Defined Function Editor

The following shows all the options that Designer provides in the dialog box. Some of them are not available depending on where you open the dialog box.

Menu

File
- New Function
  Select to create a formula.
- New Summary
  Select to open the New Summary dialog box to create a summary.
- New Parameter
  Select to open the New Parameter dialog box to create a parameter.
- Import UDF Classes
  Select to open the UDF Classes dialog box to import user-defined formula classes.
- Save
  Select to save the formula.
- Save As
  Select to save the formula with a different name.
- Close
  Select to close the dialog box.
Edit
- Undo
  Select to undo an action.
- Redo
  Select to redo an action.
- Cut
  Select to cut the specified text in the function expression panel.
- Copy
  Select to copy the specified text in the function expression panel.
- Paste
  Select to paste the text that you cut or copied in the function expression panel.
- Delete
  Select to delete the specified ted text in the function expression panel.
- Search
  Select to open the Find/Replace dialog box to search for text in the function expression panel and replace the found text with different text.
View
- Fields Panel
  Select to show the Fields panel.
- Functions Panel
  Select to show the Functions panel.
- Operators Panel
  Select to show the Operators panel.
- Sort Tree
  Select to sort the functions in the Functions panel and fields in the Fields panel by names.
User Defined Function
- Check
  Select to test the syntax of your function. If the syntax is incorrect, Designer gives the opportunity to correct the errors.
- Add Bookmark
  Select to add a bookmark to a specific position.
- Go to Previous Bookmark
  Select to go to the previous bookmark.
- Go to Next Bookmark
  Select to go to the next bookmark.
- Clear all Bookmarks
  Select to clear all of the bookmarks.
- Comment/Uncomment
  Select to add or remove comments.
- Add Operators
  Select to add a general operator in the function expression panel.
- Color Converter
  Select to open the color palette to insert the HEX code of a color.
- Auto Finish
  Select to enable the automatic input of the other part of a sign pair right after you type in the first part when editing the function.
- User Defined Function References
  Select to show the user-defined functions that reference the selected UDF method in the Functions panel.
Help
Select to view information about the dialog box.

Toolbar

New Function
Select to create a function.
New Summary
Select to create a summary.
New Parameter
Select to create a parameter.
Save
Select to save the function.
Save As
Select to save the function as a new function by specifying a new name.
Sort Tree
Select to sort the functions in the Functions panel and fields in the Fields panel by names.
Fields Panel
Select to show the Fields panel.
Functions Panel
Select to show the Functions panel.
Operators Panel
Select to show the Operators panel.
Help
Select to view information about the dialog box.

Fields panel

This panel displays a list of fields that are available to functions. Those fields may contain table columns, business view elements, formulas, summaries, parameters, and special fields. Select one field and double-click it to insert it into the function expression panel at the insertion point.

Functions panel

This panel displays a list of the Report built-in functions and imported user-defined formula functions that are available to functions. When you select one function and double-click it, Designer inserts the selected function into the function expression panel at the insertion point completely with its required syntax items (parentheses, commas, and so on).

Operators panel

This panel displays a list of the Report built-in operators that are available to functions. Select one operator and double-click it to insert it into the function expression panel at the insertion point.

Function expression panel

You can edit your function in this panel. There are several ways to work with function:

Select an object from the Fields, Functions, and Operators panels, and then double-click the object, Designer then inserts it in the function.
Type your function in the panel directly.
Use the preceding two methods together.
Paste function text from the text document of other programs.

The toolbar in this panel provides the following buttons that facilitate the process of editing a function.

Cut
Select to cut the specified text in the panel.
Copy
Select to copy the specified text in the panel.
Paste
Select to paste the text that you cut or copied in the panel.
Delete
Select to delete the specified text in the panel.
Undo
Select to undo an action.
Redo
Select to redo an action.
Search
Select to open the Find/Replace dialog box to search for text in the panel and replace the found text with different text.
Check
Select to test the syntax of the function. If the syntax is incorrect, Designer gives you the opportunity to correct the errors.
Add Bookmark
Select to add a bookmark to a specific position.
Go to Previous Bookmark
Select to go to the previous bookmark.
Go to Next Bookmark
Select to go to the next bookmark.
Clear All Bookmarks
Select to clear all of the bookmarks.
Comment/Uncomment
Select to add or remove comments.
Add Operators
Select to add a general operator in the panel.
Color Converter
Select to open the color palette to insert the HEX code of a color.

Previous Topic Next Topic