Function Builder window

How do I open the Function Builder window?
  • In either the
    Library Designer
     decorator panel or the
    Expression Builder
     window, click the
    Functions
     tab, right-click a category name and select
    Add New Function
    .
The value of a function is generated by user-defined logic created in the
Library Designer
 and by conditions that apply during instantiation. Functions are copied between library objects and between library objects of different scope, as long as the decorative elements used in the expressions are common to both library objects.
Use the settings in the
Function Builder
 window to create functions or to modify an existing function after it is imported.
This table describes the settings in the
Function Builder
 window.
Name
Setting
Description
Name
Text entry
The name of the function. This is a required field.
Type
Dropdown menu
Determines whether the function generates a single value or uses IF/ELSE logic to generate one of multiple possible values:
  • Conditional
    : The function uses IF/ELSE logic to generate one of multiple possible values.
  • Calculation
    : The function generates a single value based on a single statement.
Result Type
Dropdown menu
The data type of the function. Options are:
  • Boolean
  • String
  • Numeric
  • Integer
Function Scope
Dropdown menu
The library object that contains the function. The default value is the current library object.
This setting appears if the
Type
 selected is
Calculation
.
Expression
Dropdown menu
A single statement that determines the value generated by the function. The value can be entered manually or generated by an Expression. This is a required field when
Calculated
has been selected in the
Type
 field.
These settings appear if the
Type
selected is
Conditional
.
Statement Definition
Condition
Menu
Provides a visual representation of the conditional statement in menu form.
The
Function Builder
 window displays, at most, one
If this expression is true:
 and one
Return this value:
 field at a time. Select each line in the conditional statement menu to access the statement fields for that line.
  • Click a menu item to make its statement field active.
  • Click the
    Plus Icon
     to the left of a menu item to expand the listing. This icon appears when there are nested statements within the item.
  • Click the
    Minus Icon
     to the left of a menu item to collapse the listing. This icon appears when there are nested statements within the item.
  • Use the scroll bar to access additional menu items if the conditional statement menu has grown too large to fit in the window.
If this expression is true
Text entry
The condition being tested.
The value can be entered manually or generated by an expression. Click the ellipsis (...) button next to the field to open the
Expression Builder
.
This is a required field when
Conditional
 is selected in the
Type
 field.
Return this value
Text entry
The value used if the condition returns TRUE.
The value can be entered manually or generated by an expression. Click the ellipsis (...) button next to the field to open the
Expression Builder
.
This is a required field when
Conditional
 is selected in the
Type
 field.
Else
Text entry
The value used if the condition returns FALSE.
The value can be entered manually or generated by an expression. Click the ellipsis (...) button next to the field to open the
Expression Builder
.
This is a required field when
Conditional
 is selected in the
Type
 field.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal