Data Type Parameters Table (comprehensive)

From Pengower
Jump to: navigation, search

Key Data Type Options and Parameters

ELEMENT DATA TYPE Parameters Table

Most Data Type options have options with parameters which can be set to refine the functionality and visual aspects of an element on a form. These parameter settings require three types of input, which are indicated by a bracketed suffix, e.g. "NAME (STRING)". When adding values in order to set parameters, please conform to the following conventions:

  • STRING = textstring
  • INT = integer
  • EDIT = either “1” or “0”


DATA TYPE OPTION PARAMETER USAGE
    
ACTION_BUTTON LINKED_ACTION NAME (STRING) Case-sensitive name of action script triggered by the button – must be exact.
    
ATTACHMENT   DOWNLOAD_ONLY n/a n/a
IMAGE n/a n/a
READ_ONLY n/a n/a
STANDARD n/a n/a
    
AUTO_GENERATE   SEQUENTIAL LEADING_TEXT (STRING) Static prefix displayed prior to dynamic component of ID
USER_LINKED LEADING_TEXT (STRING) Static prefix displayed prior to dynamic component of ID
    
CALCULATED   NUMBER NO_OF_DECIMALS_POINTS (INT) The number of decimal points required
    
CONTENT   BASIC n/a n/a
READ_ONLY n/a n/a
STANDARD n/a n/a
    
DATE_TIME   DROP_DOWN_TIME n/a n/a
POPUP_DATE n/a n/a
POPUP_DATE_TIME n/a n/a
READ_ONLY INC_TIME (INT) 1 = Include time
0 = Do not include time
SIMPLE_DATE n/a n/a
SIMPLE_DATE_TIME n/a n/a
SIMPLE_TIME n/a n/a
    
EMBEDDED_TYPE   NO_TITLE n/a n/a
    
GROUP   STANDARD GROUP_NAME (STRING) Case-sensitive name of Group to be displayed– must be exact.
INC EDIT (EDIT) 1 = Include Edit buttons and check boxes
0 = Do not include Edit buttons (checkboxes still shown)
INC DELETE (EDIT) 1 = Include Delete button at bottom of list
0 = Do not include Delete button at bottom of list
    
INFORMATION   INFORMATION TEXT (STRING) Hard-coded HTML content to be displayed by this element. Please note: it is the developer's responsibility to ensure the HTML submitted here is valid and css-compliant.
    
LINKED_COPY   LINKED_ELEMENT NAME (STRING) Case-sensitive name of an element on the Type at the other of end of the relationship this Linked Copy is based on. Please note if using this name in a listing on the current object, it must be indexed.
ALWAYS_UPDATE (INT) [pending]
READ_ONLY (INT) 1 = Display the linked Name of element as read-only text
0 = Display the Linked Name in an editable text box
    
LINKED_DATA   LINKED_ELEMENT NAME (STRING) [pending]
    
MULTI_SELECT   CHECKBOXES RENDER_AS_ROW (INT) 1 = Display the check items horizontally
0 = Display the check items vertically
DOUBLE_LIST PIXEL_WIDTH (INT) Set width in pixels of each of the two multiple section boxes
PIXEL_HEIGHT (INT) Set height in pixels of each of the two multiple section boxes
READ_ONLY n/a n/a
    
NUMBER   CURRENCY SYMBOL (STRING) Symbol appears in brackets in the margin on the left, after the Element Name
POST_TEXT (STRING) Text appears to the right of the input box
NO_OF_DECIMALS_POINTS (INT) The number of decimal points required
FIXED_WIDTH_CURRENCY PIXEL_WIDTH (INT) Set width in pixels of input box
SYMBOL (STRING) Symbol appears in brackets in the margin on the left, after the Element Name
POST_TEXT (STRING) Text appears to the right of the input box
NO_OF_DECIMALS_POINTS (INT) The number of decimal points required
FREE_FORMAT NO_OF_DECIMALS_POINTS (INT) The number of decimal points required
FIXED_WIDTH_FREE_FORMAT PIXEL_WIDTH (INT) Set width in pixels of input box
NO_OF_DECIMALS_POINTS (INT) The number of decimal points required
FIXED_WIDTH_TEXT_ENCASED PIXEL_WIDTH (INT) Set width in pixels of input box
PRE_TEXT (STRING) Text appears in brackets in the margin on the left, after the Element Name
POST_TEXT (STRING) Text appears to the right of the input box
NO_OF_DECIMALS_POINTS (INT) The number of decimal points required
PERCENT_WIDTH_CURRENCY PERCENT_WIDTH (INT) Set width of input box, as percentage of available space on form
SYMBOL (STRING) Symbol appears in brackets in the margin on the left, after the Element Name
POST_TEXT (STRING) Text appears to the right of the input box
NO_OF_DECIMALS_POINTS (INT) The number of decimal points required
PERCENT_WIDTH_FREE_FORMAT PERCENT_WIDTH (INT) Text appears to the right of the input box
NO_OF_DECIMALS_POINTS (INT) The number of decimal points required
PERCENT_WIDTH_TEXT_ENCASED PERCENT_WIDTH (INT) Set width of input box, as percentage of available space on form
PRE_TEXT (STRING) Text appears in brackets in the margin on the left, after the Element Name
POST_TEXT (STRING) Text appears to the right of the input box
NO_OF_DECIMALS_POINTS (INT) The number of decimal points required
READ_ONLY NO_OF_DECIMALS_POINTS (INT) The number of decimal points required
RETURN_ACTION PIXEL_WIDTH (INT) Set width in pixels of input box
NO_OF_DECIMALS_POINTS (INT) The number of decimal points required
ACTION_STRING Case-sensitive name of action script triggered by the Return action – must be exact.
TEXT_ENCASED PRE_TEXT (STRING) Text appears in brackets in the margin on the left, after the Element Name
POST_TEXT (STRING) Text appears to the right of the input box
NO_OF_DECIMALS_POINTS (INT) The number of decimal points required
    
RELATIONSHIP   CALENDAR DATA_ELEMENT (STRING) [pending]
TIME_ELEMENT (STRING) [pending]
YEAR_ RANGE (STRING) [pending]
ADD_NEW (INT) [pending]
MULTI_ADD_AND_UPDATE MAX_NOS_ROWS (INT) Maximum number of related times you can add to the dynamic list
TOTALS (STRING) [pending]
PIXEL_WIDTH_FOR_ROW_TXT (INT) [pending]
PIXEL_WIDTH_FOR_ROW_NUM (INT) [pending]
MULTI_SELECT INC_FILTER (INT) 1 = Display a filter search text field and associated double arrow “Go” button above the mail control.
0 = Do not display the above.
PIXEL_WIDTH (INT) Set width in pixels of both input boxes
PIXEL_HEIGHT (INT) Set height in pixels of both input boxes
READ_ONLY (INT) 1 = Do not display an Edit button
0 = Display an Edit button to the right of the control, allowing the end-user to navigate to the selected object.
READ_ONLY ALT_DISPLAY_TEXT (STRING) (optional) Displays the same hard-coded text for each item in the list, overwriting relationship index display
SUPPRESS_EDIT_OPTION (INT) 1= Display related items as read-only text (can't access the record)
0 = Display related items as links to the record
SEARCH_ONLY READ_ONLY (INT) [Lists related items with a filter tool.]
1 = Displays an Edit button next to search the filter allowing end-user to access the selected record
0 = Does not display Edit button
SEQUENTIAL ORDER_BY_ELEMENT (STRING) [Sequential search listing related items between a range (e.g A – D), with a filter.]
Name of field of related Type you wish to sort on. e.g. “Surname”
DEFAULT_FROM (STRING) Default Start of Range
DEFAULT_TO (STRING) Default End of Range
SINGLE_SELECT INC_FILTER (INT) 1 = Display a filter search text field and associated double arrow “Go” button above the mail control.
0 = Do not display the above.
READ_ONLY (INT) 1 = Do not display an Edit button
0 = Display an Edit button to the right of the control, allowing the end-usur to navigate to the selected object.
SINGLE _SELECT_AND_FIX INC_FILTER (INT) 1 = Display a filter search text field and associated double arrow “Go” button above the mail control.
0 = Do not display the above.
READ_ONLY (INT) 1 = Do not display an Edit button
0 = Display an Edit button to the right of the control, allowing the end-usur to navigate to the selected object.
SINGLE_SELECT_FIXED_WIDTH INC_FILTER (INT) 1 = Display a filter search text field and associated double arrow “Go” button above the mail control.
0 = Do not display the above.
PIXEL_WIDTH (INT) Set width in pixels of input box
READ_ONLY (INT) 1 = Do not display an Edit button
0 = Display an Edit button to the right of the control, allowing the end-usur to navigate to the selected object.
SINGLE_SELECT_OR_ADD INC_FILTER (INT) 1 = Display a filter search text field and associated double arrow “Go” button above the mail control.
0 = Do not display the above.
READ_ONLY (INT) 1 = Do not display an Edit button
0 = Display an Edit button to the right of the control, allowing the end-usur to navigate to the selected object.
    
SELECTABLE   DROP_DOWN n/a n/a
DROP_DOWN_FIXED_WIDTH PIXEL_WIDTH (INT) Set numerical width in pixels of input box
RADIO n/a n/a
READ_ONLY n/a n/a
    
TEXT   INCLUDE_LINK PIXEL_WIDTH (INT) Set width in pixels of input box
FIXED_WIDTH_MULTI LINES (INT) Number of HTML lines to set the element to (effectively the number of carriage returns the end-user should enter before the element begins to scroll)
PIXEL_WIDTH (INT) Set numerical width in pixels of input box
FIXED_WIDTH_SINGLE PIXEL_WIDTH (INT) Set numerical width in pixels of input box
MULTI LINE LINES (INT) Number of HTML lines to set the element to (effectively the number of carriage returns the end-user should enter before the element begins to scroll)
PASSWORD PIXEL_WIDTH (INT) Set numerical width in pixels of input box
PERCENT_WIDTH_MULTI LINES (INT) Number of HTML lines to set the element to (effectively the number of carriage returns the end-user should enter before the element begins to scroll)
PERCENT_WIDTH (INT) Set width of input box, as percentage of available space on form
PERCENT_WIDTH_SINGLE PERCENT_WIDTH (INT) Set width of input box, as percentage of available space on form
SINGLE LINE n/a n/a
READ_ONLY n/a n/a
RETURN_ACTION PIXEL_WIDTH (INT) Set numerical width in pixels of input box
ACTION (STRING) Case-sensitive name of action script triggered by the return action on the text element – name must be exact.
    
TIME_PERIOD   DAY_HOUR_MIN n/a n/a
READ_ONLY n/a n/a
    
TRUE/FALSE   READ_ONLY n/a n/a
STANDARD n/a n/a