Template Loop Expression Tokens

 

Template loop expressions are expressions that can only be used within the context of a template loop and allow you to conditionally include or exclude code based on the attributes of the current template.

 

Field Loop Expression

Description

<IF ALLOW_LIST>

The template has allow list values.

<IF ALPHA>

Data type is Alpha.

<IF ALTERNATE_NAME>

The template has an alternate name specified. This token will always return a value because if no alternate name is specified in the repository then it defaults to the templates real name. This token allows you to detect whether the alternate name is different from the real name.

<IF ARRAY>

The template defines an array field.

<IF ARRAY1>

The template defines an array with 1 dimension.

<IF ARRAY2>

The template defines an array with 2 dimensions.

<IF ARRAY3>

The template defines an array with 3 dimensions.

<IF ARRAY4>

The template defines an array with 4 dimensions.

<IF ARRIVE>

The template has an arrive method specified.

<IF AUTO_SEQUENCE>
 

The template defines an auto-sequence field. The underlying storage is an I8.

<IF AUTO_TIMESTAMP>
 

The template defines an auto-time-stamp field. This expression will evaluate to true if the repository template is defined as type AutoTime (AT). The underlying storage is an I8.

<IF BINARY>

The template defines a binary field. Binary fields are also alpha fields.

<IF BOLD>

The template defines a field that should be displayed in bold.

<IF BOOLEAN>

The templates data type is boolean. This only applies to templates whose actual Synergy data type is boolean, not to numeric templates with a coerced type of boolean.

<IF BREAK>

The template defines a break field. This expression matches any type of break condition (change, always or return).

<IF BREAK_ALWAYS>

The template defines a break field. The break template logic always executes whenever the field is processed.

<IF BREAK_CHANGE>

The template defines a break field. The break template logic only executes when the value of the field changes.

<IF BREAK_RETURN>

The template defines a break field. The break template logic only executes when the user presses RETURN on the field.

<IF BZERO>

 

The template defines a numeric field that should be displayed blank if the value is zero.

<IF CHANGE>

The template defines a field that has a change method specified.

<IF CHECKBOX>

The template defines a field that should be displayed as a check-box.

<IF COERCE_BOOLEAN>

The template defines a field whose data type is coerced to boolean.

<IF COMBOBOX>

The template defines a field that should be displayed as a combo-box.

<IF CUSTOM_DBL_TYPE>

 

The template defines a field that has a custom DBL data type specified via a special token.

<IF CUSTOM_SQL_TYPE>

 

The template has a custom SQL data type specified via a special token.

<IF CUSTOM_CONVERT_FUNCTION>

 

The template defines a field that has a custom conversion function specified via a special token.

<IF CUSTOM_STRING_FUNCTION>

 

The template defines a field that has a custom string function specified via a special token.

<IF DATE>

The template defines a field that is a date. This includes all types of date and nullable date types.

<IF DATE_JULIAN>

 

The template defines a field that is a date or nullable date of type YYJJJ or YYYYJJJ.

<IF DATE_NULLABLE>

 

The template defines a field that is a NULLABLE date.

<IF DATE_PERIOD>

 

The template defines a field that is a date or nullable period date (YYPP or YYYYPP).

<IF DATE_YMD>

 

The template defines a field that is a date or nullable date of type YYMMDD or YYYYMMDD.

<IF DATE_YYJJJ>

 

The template defines a field that is a date or nullable date of type YYJJJ.

<IF DATE_YYMMDD>

 

The template defines a field that is a date or nullable date of type YYMMDD.

<IF DATE_YYPP>

 

The template defines a field that is a date or nullable date of type YYPP.

<IF DATE_YYYYJJJ>

 

The template defines a field that is a date or nullable date template of type YYYYJJJ.

<IF DATE_YYYYMMDD>

 

The template defines a field that is a date or nullable date of type YYYYMMDD.

<IF DATE_YYYYPP>

 

The template defines a field that is a date or nullable datye of type YYYYPP.

<IF DATEORTIME>

 

The template defines a field that is a date, time, or nullable date or time.

<IF DATETODAY>

 

The template defines a date field that should default to the current date.

<IF DECIMAL>

The template defines a field whose data type is decimal. Note that date, nullable date and time templates are NOT treated as decimal templates with this conditional test.

<IF DEFAULT>

The template defines a field that has a default value specified.

<IF DESCRIPTION>

The template defines a field that has a description specified.

<IF DISABLED>

The template defines a field that is defined as being initially disabled.

<IF DISPLAY>

The template defines a field that has a display method specified.

<IF DISPLAY_LENGTH>

The template defines a field that has a display length specified.

<IF DRILL>

The template defines a field that has a drill method specified.

<IF EDITFORMAT>

The template defines a field that has an edit format method specified.

<IF ENABLED>

The template defines a field that is defined as being initially enabled.

<IF ENUM>

The template defines a field that is an ENUM field. This is a real language enumeration, not a UI Toolkit enumerated field.

<IF ENUMERATED>

The template defines a field that has a UI Toolkit enumeration specified. This is not the same as being a real language ENUM field.

<IF EXCLUDED_BY_LANGUAGE>

 

The template defines a field that has the excluded by language flag set.

<IF EXCLUDED_BY_REPORTWRITER>

 

The template defines a field that has the excluded by ReportWriter flag set.

<IF EXCLUDED_BY_TOOLKIT>

 

The template defines a field that has the excluded by Toolkit flag set.

<IF EXCLUDED_BY_WEB>

 

The template defines a field that has the excluded by Web flag set.

<IF FORMAT>

The template defines a field that has a display format specified.

<IF HEADING>

The template defines a field that has a report heading specified.

<IF HELPID>

The template defines a field that has a help identifier specified.

<IF HYPERLINK>

The template has a hyperlink method specified.

<IF I1>

The template defines a field that is an I1.

<IF I2>

The template defines a field that is an I2.

<IF I4>

The template defines a field that is an I4.

<IF I8>

The template defines a field that is an I8.

<IF I124>

The template defines a field that is an I1, I2 or I4.

<IF INFOLINE>

The template defines a field that has information line text specified.

<IF INPUT_CENTER>

Input should be performed center justified.

<IF INPUT_LEFT>

Input should be performed left justified.

<IF INPUT_RIGHT>

Input should be performed right justified.

<IF INTEGER>

The template defines a field that whose type is defined as integer.

<IF LEAVE>

The template defines a field that has a leave method specified.

<IF LENGTH_OVER_8>

 

The template defines a field whose length is over 8 characters. This expression is primarily useful when dealing with numeric fields because decimal fields with a length of up to 8 digits are mapped to an int, whereas fields 9 characters or longer are mapped to a long.

 

<IF LONGDESC>

The template defines a field that has a long description specified.

<IF MAPPED>

The template defines a field that has a CodeGen template mapping specified.

<IF MAPPING_FUNCTION>

 

The template defines a field that has a mapping function defined.

<IF NAME_LINK>

 

The template defines a field that allows linking by name.

<IF NEGATIVE_ALLOWED>

The template defines a field that allows negative values. Use of this expression is only appropriate for numeric fields.

<IF NEGATIVE_ORZERO>

The template defines a field that allows negative values or a value of zero. Positive values are not allowed. Use of this expression is only appropriate for numeric fields.

<IF NEGATIVE_REQUIRED>

The template defines a field that requires a negative value. Use of this expression is only appropriate for numeric fields.

<IF NOECHO>

 

The template defines a field that should not echo characters as they are typed.. (Deprecated use <IF NOT ECHO>.)

<IF PAINTCHAR>

The template defines a field that has a custom paint character specified.

<IF PAINTFIELD>

 

The template defines a field that is a paint field. This means that characters will not be displayed, but rather the paint field character (default asterisk) will be displayed instead.

<IF PII_SCRUB>

 

The template defines a field that has a PII_TYPE encoded into its long description or user defined text field.

<IF PRECISION>

The decimal template defines a field that has a precision specified (i.e. it is an implied decimal field).

<IF PROMPT>

The template defines a field that has a prompt specified.

<IF PROMPT_POSITION>

The template defines a field that has a UI prompt position specified.

<IF RADIOBUTTONS>

The template defines a field that should be viewed as a collection of radio-buttons.

<IF RANGE>

The template defines a field that has a numeric range (minimum/maximum values) specified.

<IF READONLY>

The template defines a field that state is specified as initially read-only.

<IF READWRITE>

The template defines a field that state is specified as initially writable.

<IF REPORT_CENTER>

The template defines a field that should be printed center justified on reports.

<IF REPORT_LEFT>

The template defines a field that should be printed left justified on reports.

<IF REPORT_RIGHT>

The template defines a field that should be printed right justified on reports.

<IF REQUIRED>

The template defines a field that is marked as required (i.e. must contain a valid value).

<IF REVERSE>

The template defines a field that should be displayed in reverse video.

<IF SELECTIONS>

The template defines a field that has one or more selection list values.

<IF SELWND>

The template defines a field that has a selection window name specified.

<IF STRUCTFIELD>

The template defines a field that is a struct field.

<IF TEXTBOX>

The template defines a field that should be displayed as a text-box.

<IF TIME>

The template defines a field that is a time fieldof type HHMM or HHMMSS.

<IF TIME_HHMM>

The template defines a field that is a time fieldof type HHMM.

<IF TIME_HHMMSS>

The template defines a field that is a time fieldof type HHMMSS.

<IF TIMEOUT>

The template defines a field that has an input timeout specified.

<IF TIMENOW>

The time template defines a field that should default to the current time.

<IF UNDERLINE>

The template defines a field that content should be displayed underlined.

<IF UNMAPPING_FUNCTION>

 

The template defines a field that has an unmapping function defined.

<IF UPPERCASE>

The template defines a field that value should always be converted to uppercase.

<IF USER>

The template defines a field that is a user defined field.

<IF USER_TYPE>

 

The template defines a field that has a user-defined type string defined.

<IF USERTEXT>

The template defines a field that has user text specified.

<IF USERTIMESTAMP>

The template defines a field that is a user-defined time-stamp field.

<IF VIEW_LENGTH>

The template defines a field that has a view length specified.

 

 


Copyright © 2021  Synergex International, Inc.