Field Loop Expansion Tokens

 

Field loop expansion tokens are used to insert information about the current field being processed within the context of a field loop into the output stream. Field loop tokens can only be used inside a field loop.

Field Loop Token

Description

<FIELD#>

Inserts the 1-based index of the current field in the record, without considering array elements or group fields as individual fields.

<FIELD#_ZERO>

Inserts the 0-based index of the current field in the record, without considering array elements or group fields as individual fields.

<FIELD#LOGICAL>

Inserts the 1-based index of the current field in the record. Array elements and group fields are considered as individual fields. For example a structure with three fields, one of which is an array of 8 elements, is treated as having 10 fields.

<FIELD#LOGICAL_ZERO>

Inserts the 0-based index of the current field in the record. Array elements and group fields are considered as individual fields. For example a structure with three fields, one of which is an array of 8 elements, is treated as having 10 fields.

<FIELD_ALTNAME>

Inserts the alternate name of the field. Array fields are represented in Synergy format, for example ALTNAME[1]. If no alternate name is available then the real name is used.

<FIELD_ARRIVEM>

Inserts the name of the fields arrive method if present, or by nothing if not.

<FIELD_BASENAME>

Inserts the base name of the field. Array field dimensions are not included in the base name.

<FIELD_BREAK_MODE>

Inserts a value indicating whether the field is a break field, and if so what type of break field.

<FIELD_CHANGEM>

Inserts the name of the fields change method if present, or by nothing if not.

<FIELD_COL>

Inserts the screen column for placement of the field on the screen in a cell-based environment. If the field has a column position specified then this is used, otherwise the default of column 15 is used.

<FIELD_CSCONVERT>

Inserts a string indicating the appropriate C# string to numeric conversion method to use to attempt to parse a string into a numeric value.

<FIELD_CSDEFAULT>

Inserts a C# default value based on the fields data type.

<FIELD_CSTYPE>

Inserts a string indicating the C# equivalent data type of the field.

<FIELD_DEFAULT>

Inserts the fields default value, if present.

<FIELD_DESC>

Inserts the description of the field.

<FIELD_DIMENSION1_INDEX>

When CodeGen encounters array fields it "flattens" those arrays out into multiple fields each of which is of the same type and size. When processing a field which was formally part of an array, this token can be used to insert the original dimension two index of the field. For non-array fields inserts a single zero (0).

<FIELD_DIMENSION2_INDEX>

When CodeGen encounters array fields it "flattens" those arrays out into multiple fields each of which is of the same type and size. When processing a field which was formally part of an array, this token can be used to insert the original dimension three index of the field. For non-array fields inserts a single zero (0).

<FIELD_DIMENSION3_INDEX>

When CodeGen encounters array fields it "flattens" those arrays out into multiple fields each of which is of the same type and size. When processing a field which was formally part of an array, this token can be used to insert the original dimension four index of the field. For non-array fields inserts a single zero (0).

<FIELD_DIMENSION4_INDEX>

When CodeGen encounters array fields it "flattens" those arrays out into multiple fields each of which is of the same type and size. When processing a field which was formally part of an array, this token can be used to insert the original dimension one index of the field. For non-array fields inserts a single zero (0).

<FIELD_DRILLM>

Inserts the name of the fields drill method if present, or by nothing if not.

<FIELD_DRILL_PIXEL_COL>

Inserts the pixel column for placement of a fields drill button on a form.

<FIELD_ELEMENT>

For array fields inserts the one-based element number of the field currently being processed by the field loop. For multi-dimension arrays the token inserts a comma-separated list of current index numbers. For non-array fields the token does not cause anything to be written to the output stream.

<FIELD_ELEMENT0>

For array fields inserts the one-based element number of the field currently being processed by the field loop. For multi-dimension arrays the token inserts a comma-separated list of current index numbers. For non-array fields the token inserts 0.

<FIELD_ENUMLENGTH>

Inserts the maximum length of the fields’ enumerated values.

<FIELD_ENUMWIDTH>

Inserts the pixel width for the maximum length of the fields’ enumerated values.

<FIELD_FORMATNAME>

Inserts the name of the fields Repository format, or nothing if no format is specified.

<FIELD_FORMATSTRING>

Inserts the format string value of the fields Repository format, or nothing if no format is specified.

 

<FIELD_HEADING>

Inserts the fields report heading. If no heading exists then the field prompt is used. If no prompt exists then the fields SQL name is used. Array fields will have the element number appended (e.g. Phone #1).

<FIELD_HELPID>

Inserts the fields help identifier if present.

<FIELD_HYPERM>

Inserts the name of the fields hyperlink method if present, or by nothing if not.

<FIELD_INFOLINE>

Inserts the fields’ information line text if present.

<FIELD_INPUT_LENGTH>

Inserts the maximum number of characters that can be typed into a UI input field representing the current field.

<FIELD_LDESC>

Inserts the fields’ long description.

<FIELD_LEAVEM>

Inserts the name of the fields leave method if present, or by nothing if not.

<FIELD_MAXVALUE>

Inserts the maximum value which should be associated with a numeric field. The token should only be used for numeric fields, so you should only use it within an <IF NUMERIC> field loop expression.

<FIELD_MINVALUE>

Inserts the minimum value which should be associated with a numeric field. The token should only be used for numeric fields, so you should only use it within an <IF NUMERIC> field loop expression.

<FIELD_NAME>

Inserts the name of the field. Array fields are represented in Synergy real array format,  and group fields are represented by a full path.

<FIELD_NETNAME>

Inserts a .NET compatible name for the current field. Array fields are expanded to multiple individual fields, with the name being suffixed with the array element number, for example 'FIELDNAME1', 'FIELDNAME2' etc.

<FIELD_NET_ALTNAME>

Inserts a .NET compatible version of the alternate name for the current field.

 

<FIELD_NOECHO_CHAR>

Inserts the character that should be used to represent each character typed into a field, in place of the actual character (think password fields).

<FIELD_OCDEFAULT>

Inserts an Objective-C default value based on the fields data type.

<FIELD_OCTYPE>

Inserts a string indicating the Objective-C equivalent data type of the field.

<FIELD_ODBCNAME>

Inserts an ODBC-compatible name for the current field. Array fields are expanded to multiple individual fields, with the name being suffixed with an underscore and the array element number, for example 'FIELDNAME_1', 'FIELDNAME_2' etc.

<FIELD_ORIGINAL_NAME>

Inserts the original name of the field as defined in the repository. A fields original name never changes, and does not include any array dimensions or paths resulting from the expansion of array or group fields.

<FIELD_ORIGINAL_NAME_MODIFIED>

 

Inserts the original name of the field as defined in the repository, modified to include any array dimensions or paths resulting from the expansion of array or group fields.

<FIELD_PATH>

Inserts the path of the field. Array fields are represented in Synergy format, for example structure.fieldname[1]. 

<FIELD_PATH_CONV>

Inserts the path of the field. Array fields are represented in Synergy format, for example structure.fieldname[1]. If the fields user text or long description contains an @UNMAPF=function; expression then the conversion function will also be applied.

<FIELD_PIXEL_COL>

Inserts the pixel column for placement of the field within a UI form. If the field has a column position specified then this is used, otherwise the default of column 15 is used.

<FIELD_PIXEL_ROW>

Inserts the pixel row for placement of the field within a UI form. If the field has a row position defined then this is used, otherwise the logical field number (which includes array elements) is used to calculate the default row.

<FIELD_PIXEL_WIDTH>

Inserts the pixel width for default sizing of the field when represented as a TextBox.

<FIELD_POSITION>

Inserts the one-based byte position of the field in the record.

<FIELD_POSITION_ZERO>

Inserts the zero-based byte position of the field in the record.

<FIELD_PRECISION>

Inserts the precision of an implied-decimal field or an empty string. Only the precision is inserted, with no leading period.

<FIELD_PRECISION2>

Inserts the precision of an implied-decimal field including a leading period, or an empty string.

<FIELD_PROMPT>

Inserts the fields prompt.

<FIELD_RANGE_MAX>

Inserts the numeric fields’ maximum value.

<FIELD_RANGE_MIN>

Inserts the numeric fields’ minimum value.

<FIELD_REGEX>

Inserts a regular expression that can be used to constrain and validate user input to a field based on the repository definition of the field. The regular expression inserted depends on the type of field.

<FIELD_ROW>

Inserts the screen row for placement of the field on the screen in a cell based environment. If the field has a row position defined then this is used, otherwise the logical field number (which includes array elements) is used to calculate the default row.

<FIELD_SAMPLE_DATA>

 

Inserts sample date for the field, with alpha data surrounded by double quotes.

<FIELD_SAMPLE_DATA_NOQUOTES>

 

Inserts sample date for the field, with alpha data NOT surrounded by double quotes.

<FIELD_SELECTION_COUNT>
 

Inserts the number of selection list values that are associated with the field.

<FIELD_SELECTIONS>

Inserts a comma separated list of the fields’ selection list values.

<FIELD_SELECTIONS1>

Inserts a quoted string containing a pipe (|) delimited list of the fields selection list values.

<FIELD_SELLENGTH>

Inserts the maximum length of the fields’ selection list values.

<FIELD_SELWND>

Inserts the name of the selection window associated with the current field. If the field does not have a selection window then the token inserts nothing.

<FIELD_SIZE>

Inserts the size of the field in bytes.

<FIELD_SNDEFAULT>

Inserts a Synergy .NET default value based on the fields data type.

<FIELD_SNTYPE>

Inserts a string indicating the Synergy NET data type of the field.

<FIELD_SPEC>

Inserts a Synergy data type definition for the field.

<FIELD_SQLNAME>

Inserts a SQL-compatible name for the current field. Array fields are expanded to multiple individual fields, with the name being suffixed with the array element number, for example 'FIELDNAME1', 'FIELDNAME2' etc.

<FIELD_SQL_ALTNAME>

Inserts a SQL-compatible version of the alternate name for the current field.

 

<FIELD_SQLTYPE>

Inserts a SQL compatible data definition of the field.

<FIELD_TEMPLATE>

Inserts the name of the Repository template from which the field inherited its attributes or by a null string if no template is referenced.

<FIELD_TKSCRIPT>

Inserts a UI Toolkit .field script file command for the field.

<FIELD_TYPE>

Inserts a character indicating the synergy data type of field.

<FIELD_TYPE_NAME>

Inserts a string indicating the Synergy data type of field.

<FIELD_UTEXT>

Inserts the fields’ user-defined text string.

<FIELD_VBDEFAULT>

Inserts a VB.NET default value based on the fields data type.

<FIELD_VBTYPE>

Inserts a string indicating the VB.NET data type of the field.

<HARMONY_ROLES>

 

Inserts the content of a special string defined in the fields long description. See the full description for more information.

<MAPPED_FIELD>

Inserts the name of the mapped field in the mapped structure. To use this token you must use @MAP=structure; in the structures user text field or long description and @MAP=field; in each fields user text field or long description.

<MAPPED_PATH>

Inserts the name of the mapped path in the mapped structure. To use this token you must use @MAP=structure; in the structures user text field or long description and @MAP=field; in each fields user text field or long description. 

<MAPPED_PATH_CONV>

Inserts the name of the mapped path in the mapped structure . To use this token you must use @MAP=structure; in the structures user text field or long description and @MAP=field; in each fields user text field. If there is also an @MAPF=function; in the user text or long description then that conversion function will also be applied.

<PROMPT_COL>

Inserts the screen column for placement of the prompt on the screen in a character based environment. If the prompt has a column position specified then this is used, otherwise the default of column 1 is used.

<PROMPT_PIXEL_COL>

Inserts the pixel column for placement of the prompt on a windows form. If the prompt has a column position specified then this is used, otherwise the default of column 1 is used.

<PROMPT_PIXEL_ROW>

Inserts the pixel row for placement of the prompt on a windows form. If the prompt has a row position defined then this is used, otherwise the logical field number (which includes array elements) is used to calculate the default row.

<PROMPT_PIXEL_WIDTH>

Inserts the pixel width for default sizing of the prompt when represented as a label.

<PROMPT_ROW>

Inserts the screen row for placement of the prompt on the screen in a character based environment. If the prompt has a row position defined then this is used, otherwise the logical field number (which includes array elements) is used to calculate the default row.

 

 


Copyright © 2018  Synergex International, Inc.