Form Field Properties
Manager Contents
User Contents

CATSWeb Form Field Properties may be changed at design time via the Field Properties page, or changed dynamically at runtime via Event Hooks.

CATSWeb Event Hooks are automatic operations that CATSWeb performs in real time and can enable you to implement custom business rules and operations when specific conditions or events occur. Event Hooks can utilize Configurable Actions or can call external code functions that are defined by CATSWeb Data Links.

  • CATSWeb Configurable Actions are configurable operations that require little or no coding to enable. The Modify Form Field Properties Configurable Action allows any number of form field properties to be dynamically modified at runtime.
  • CATSWeb Data Links can be used to retrieve data from a variety of sources for use with CATSWeb. Some Data Links can be used to dynamically modify form field properties, but these.require you to write code in an external language, such as VB.NET or SQL. For more information on these capabilities, see the CATSWeb Technical Note titled Implementing Dynamic Forms. If you do not have this document, you may request it from AssurX Technical Support.
    • ActiveX DLL Data Links, ActiveX DLL with Parameter Data Links and Web Service Data Links can be used to run external code functions that are contained within .NET Class DLLs. In most cases, these are written using Visual Basic .NET. When Data Links are used to modify form field properties, these are the preferred methods because .NET Class DLLs can return values in colHTML. The Developer and API CATSWeb College courses provide details on how to write .NET Class DLLs for use in conjunction with CATSWeb (contact sales for details).
    • Stored Procedure Data Links and Stored Procedure (External) Data Links can be used to run external code functions (SQL Stored Procedures) that are contained within your CATSWeb or other database. Since stored procedures cannot directly return data within colHTML, their use is more limited. The Developer CATSWeb College course provides details on how to write stored procedures for use in conjunction with CATSWeb (contact sales for details).
    • SQL Data Links can be used to run external SQL that is contained within your CATSWeb database. Since SQL cannot directly return data within colHTML, their use is more limited.

Where applicable, the Property Name (in the table below) is linked to information on the corresponding setting in the Field Definition or Interface Preference page.

Property Name Information API Constant
Apply to Section Used to specify that the property changes you are making for the current field are to apply to that field and all fields that follow up to (but not including) the next Section Break (True/False). CWEB_SUFFIX_FORSECTION
Auto Reload Used to specify whether or not the field automatically triggers a reload event when its value is changed (True/False). CWEB_SUFFIX_AUTO_RELOAD
Caption Used to change the caption of a field, or the text that is displayed in Section Breaks. To change the text that is displayed in a Fixed Text Area, use the Fill Specification property. CWEB_SUFFIX_CAPTION
Caption Background Color Used to change the background color of the caption cell for a normal field, or the background color for a Section Break or Fixed Text Area control. The color must be either a valid HTML color code (including the leading "#" character), or a color variable. For example:

"#3333FF"
 CWEB_SUFFIX_CAPTION_BACKGROUNDCOLOR
Caption Font Face Used to specify the HTML font face that is used for captions. See the HTML Font Faces list in CATSWeb for examples. CWEB_SUFFIX_CAPTION_FONT_FACE
Caption Font Size Used to specify the HTML font size that is used for caption text. CWEB_SUFFIX_CAPTION_FONT_SIZE
Caption Is Bold Used to specify whether or not the field caption is shown in bold text (True/False). CWEB_SUFFIX_CAPTION_BOLD
Caption Is Italic Used to specify whether or not the field caption is shown in italic text (True/False). CWEB_SUFFIX_CAPTION_ITALIC
Caption Tag HTML After Used to specify arbitrary HTML that will be placed immediately after the caption text ends (i.e. to the right of the caption). This capability would typically be used to insert a custom button or link. This is an indexed property, which means it can be set multiple times to add multiple HTML elements. CWEB_SUFFIX_CAPTION_TAG_HTML_AFTER
Caption Tag HTML Before Used to specify arbitrary HTML that will be placed immediately before the caption text begins (i.e. to the left of the caption). This capability would typically be used to insert a custom button or link. This is an indexed property, which means it can be set multiple times to add multiple HTML elements. CWEB_SUFFIX_CAPTION_TAG_HTML_BEFORE
Column Span Used to specify the number of columns that a field spans. CWEB_SUFFIX_FORM_COLUMN_SPAN
Columns Used to specify the number of columns for a Memo (HTML Textarea) field. CWEB_SUFFIX_COLUMNS
Control Type Used to change the control type, such as to change a text box into a pull-down list. The value must be a CWEB_CTLTYPE_ numeric value (e.g., CWEB_CTLTYPE_TEXT or CWEB_CTLTYPE_COMBO). CWEB_SUFFIX_CONTROLTYPE
Description Used to change the description of the field. This is the information that is displayed to users via Tool Tip help (when they float their mouse near the end of the field caption). CWEB_SUFFIX_DESCRIPTION
Editable Used to change the editability of a field (True/False). CWEB_SUFFIX_EDITABLE
Extra Fill Values If the field is bound to a list, this setting allows extra values to be specified which are prepended to the list. Multiple values must be delimited with dual pipe characters ("||"). CWEB_SUFFIX_EXTRAFILLVALUES
Field Background Color Used to change the background color of the field cell for all fields except Section Breaks and Fixed Text Areas (use the _CAPCLR suffix for those field types). The color must be either a valid HTML color code (including the leading "#" character), or a color variable. For example:

"#3333FF"
 CWEB_SUFFIX_FIELD_BACKGROUNDCOLOR
Field Font Face Used to specify the HTML font face that is used for field data when the field is in read-only mode. See the HTML Font Faces list in CATSWeb for examples. CWEB_SUFFIX_FIELD_FONT_FACE
Field Font Size Used to specify the HTML font size that is used for field data when the field is in read-only mode. CWEB_SUFFIX_FIELD_FONT_SIZE
Field Is Bold Used to specify whether or not the field data is shown in bold text when the field is in read-only mode (True/False). CWEB_SUFFIX_FIELD_BOLD
Field Is Italic Used to specify whether or not the field data is shown in italic text when the field is in read-only mode (True/False). CWEB_SUFFIX_FIELD_ITALIC
Field Tag Attributes Used to specify additional attributes for insertion into the HTML field tag. This capability would typically be used to add event handlers for script code implementations. CWEB_SUFFIX_FIELD_TAG_ATTRIBUTES
Field Tag HTML After Used to specify arbitrary HTML that will be placed immediately after the field tag ends (i.e. to the right of the field). This capability would typically be used to insert a custom button or link. This is an indexed property, which means it can be set multiple times to add multiple HTML elements. CWEB_SUFFIX_FIELD_TAG_HTML_AFTER
Field Tag HTML Before Used to specify arbitrary HTML that will be placed immediately before the field tag begins (i.e. to the left of the field). This capability would typically be used to insert a custom button or link. This is an indexed property, which means it can be set multiple times to add multiple HTML elements. CWEB_SUFFIX_FIELD_TAG_HTML_BEFORE
Field Text Color Used to specify the HTML text color used for data in a field that is in read-only mode. Does not apply to Section Break, Fixed Text Area, or Text Cell control. The color must be either a valid HTML color code (including the leading "#" character), or a color variable. For example:

"#000000"
 CWEB_SUFFIX_FIELD_TEXT_COLOR
Field Value Used to change the value of a field instead of a property of the field. N/A
Fill Field If the field is bound to a list via a data link, this specifies the field in the data link's returned data that the list values are read from. It is identical to the Data Field setting for Data Links. CWEB_SUFFIX_FILLFIELD
Fill Specification Used to change the list binding for a field, or to change the text that is displayed in a Fixed Text Area. For list bindings, the value must be specified in AssurX's coded format, which is described in CATSWeb Database Schema Documentation in the following location:

Table: MultipleViewFields_Server
Field: ControlSource

Here are some examples:

Example1: "SP|sp_GetSomethingProc|db|ei" calls the stored procedure sp_GetSomething and passes the system's Database Name and the current user's EmployeeID as parameters. See the Session Parameters topic for a listing of additional parameter codes (use the listed URL Token values but omit the curly braces). The parameter codes are also listed in the CATSWeb constants file as CWEB_SESSPARAM_ constants.

Example2: "LI|Full=0|Affiliate=1" wlll cause an option group to display two options labeled "Full" and "Affiliate" with values of 0 and 1 respectively.

Example3: "LI|List Item 1|List Item 2|ListItem 3" will cause a list to directly display the delimited items, like this:

List Item 1
List Item 2
List Item 3

Example4: "AX|LinkTest.DataClass|GetAccessData" calls the GetAccesData property procedure in the ActiveX DLL object with programmatic ID "LinkTest.DataClass".

Example5: "WS|[My Web Service Data Link]" calls the Web Service specified by the "[My Web Service Data Link]" Web Service Data Link. Note that you must have the CATSWeb Web Services Data Links option installed to perform calls to Web Services.

Example6: "LS|My CATSWeb List" binds the field to the "My CATSWeb List" standard list.

Example 7: "SQ|Select MyField From MyTable" uses the SQL statement specified to retrieve list values.

NOTE: The first two characters in the examples above ("SP", "LI", etc.) are CWEB_SRCTYPE_ constants in the CATSWeb public constants file.

 CWEB_SUFFIX_FILLSPEC
Format Active only when a field is in read-only mode, this is used to specify the Format specification for a field. CWEB_SUFFIX_FORMAT
Form Body HTML After Used to specify HTML that is placed immediately below the main body of the form (i.e. immediately below the HTML table that makes up the form).

This is an indexed property, which means it can be set multiple times to add multiple HTML elements. An arbitrary Field Name may be specified in the Form Field Property Change form since this setting is not tied to any field.

This property may also be used to insert Display Parts. To do this, specify a token like this as the new property value:

{Display Part: Your Display Part Name}

Note that this is the same technique that is used to insert Display Parts into Fixed Text Areas on forms.
 CWEB_FLD_FORM_DATA_AFTER
Form Body HTML Before Used to specify HTML that is placed below the page title and utility links and above the main body of the form (i.e. just above the HTML table that makes up the form).

This is an indexed property, which means it can be set multiple times to add multiple HTML elements. An arbitrary Field Name may be specified in the Form Field Property Change form since this setting is not tied to any field.

This property may also be used to insert Display Parts. To do this, specify a token like this as the new property value:

{Display Part: Your Display Part Name}

Note that this is the same technique that is used to insert Display Parts into Fixed Text Areas on forms.
 CWEB_FLD_FORM_DATA_BEFORE
Graphics File Used to change the graphics file for graphical "fields" such as submit or reload buttons. CWEB_SUFFIX_GRAPHICS_FILE
Hidden Outside Form Used to specify that the field is made invisible and hidden outside the form layout table, instead of occupying the cell(s) it would otherwise occupy in the form based on its order setting. For example, Event Hooks or Data Links may utilize hidden fields for state tracking. Hiding them outside the form eliminates vestigial display artifacts that may otherwise remain due to the empty table cells (True/False). CWEB_SUFFIX_HIDDEN_OUTSIDE_FORM_TABLE
Hide Drill Downs Set this True/False property to True to hide the drill down links on a field. For example, if a text field has a drill down link associated with it, the field's caption will be a link when the record is viewed. Setting this property to True causes the caption to be displayed as a normal caption without the link. If this property is set to True for a drill down button, the button/link are made invisible, just as they would be if Visible had been set to False. CWEB_SUFFIX_HIDE_DRILL_DOWNS
Link Present This True/False property may be used to remove Utility and Workflow links from a form. To remove a link, specify False as the new value. Field Name must be one of the following values:

CWEB_BTNKEY_ADD_NOTE_LINK = "ADDNOTELINK"

CWEB_BTNKEY_ADD_NOTE = "ADDNOTE"

CWEB_BTNKEY_ADD_LINK = "ADDLINK"

CWEB_BTNKEY_ADD_ATTACHMENT = "ADDATTACHMENT"

CWEB_BTNKEY_ADD_SIGNATURE = "ADDSIGNATURE"

CWEB_BTNKEY_EDIT = "EDIT"

CWEB_BTNKEY_COPY = "COPY"

CWEB_BTNKEY_EDIT_DISPOSITION = "EDITDISPOSITION"

CWEB_BTNKEY_ENTER_FINAL_DISPOSITION = "ENTERFINALDISPOSITION"

CWEB_BTNKEY_REASSIGN = "REASSIGN"

CWEB_BTNKEY_REASSIGN_DISPOSITION = "REASSIGNDISPOSITION"

CWEB_BTNKEY_REASSIGN_ACTION = "REASSIGNACTION"

CWEB_BTNKEY_REASSIGN_TO_DIFFERENT_ACTION = "REASSIGNTODIFFERENTACTION"

CWEB_BTNKEY_ASSIGN_TO_ACTION = "ASSIGNTOACTION"

CWEB_BTNKEY_CREATE_NEW_ACTION = "CREATENEWACTION"

CWEB_BTNKEY_REDISPOSITION = "REDISPOSITION"

CWEB_BTNKEY_FORWARD_BY_EMAIL = "FORWARDBYEMAIL"

CWEB_BTNKEY_ROUTE_TO_AFFILIATE = "ROUTETOAFFILIATE"

CWEB_BTNKEY_VIEW_EDIT_HISTORY = "VIEW_EDIT_HISTORY"

CWEB_BTNKEY_UNLOCK = "UNLOCK"

CWEB_BTNKEY_PRINT_VIEW = "PRINTVIEW"

CWEB_BTNKEY_VIEW_ISSUES = "VIEWISSUES"

CWEB_BTNKEY_EDIT_EFFECTIVENESS = "EDITEFFECTIVENESS"

CWEB_BTNKEY_ADD_SUBTASK = "ADDSUBTASK"

CWEB_BTNKEY_UNVOID = "UNVOID"

CWEB_BTNKEY_CWCLIENT_HIGHLIGHT_CHANGES = "HIGHLIGHTCHANGES"

CWEB_BTNKEY_TAG = "TAG"

CWEB_BTNKEY_SUBSCRIBE = "SUBSCRIBE"

 CWEB_SUFFIX_PRESENT
List Style If a field is bound to a list, either statically via its Field Definition or dynamically via CWEB_SUFFIX_CONTROLTYPE and CWEB_SUFFIX_FILLSPEC, this setting specifies the type of list. One of the following values:

CWEB_LIST_STYLE_PULLDOWN (0)
CWEB_LIST_STYLE_LIST (1)
CWEB_LIST_STYLE_MULTISELECT (2)

If CWEB_LIST_STYLE_LIST or CWEB_LIST_STYLE_MULTISELECT is specified, the setting will only take effect if the Multi-select Lists option has been installed in the system. Note that CWEB_LIST_STYLE_LIST is a multi-row, single-select list.
 CWEB_SUFFIX_LIST_STYLE
Main Submit Button HTML After Used to specify arbitrary HTML that will be placed immediately after the main submit button on the form (i.e. to the right of the button). This capability would typically be used to insert a custom button or link. This is an indexed property, which means it can be set multiple times to add multiple HTML elements. CWEB_FLD_MAIN_SUBMIT_AFTER
Main Submit Button HTML Before Used to specify arbitrary HTML that will be placed immediately before the main submit button on the form (i.e. to the left of the button). This capability would typically be used to insert a custom button or link. This is an indexed property, which means it can be set multiple times to add multiple HTML elements. CWEB_FLD_MAIN_SUBMIT_BEFORE
Multi-select Display If a field is bound to a multi-select list, either statically via its Field Definition or dynamically via CWEB_SUFFIX_CONTROLTYPE, CWEB_SUFFIX_FILLSPEC and CWEB_SUFFIX_LIST_STYLE, this setting specifies how values from the list are displayed when the field is in read-only mode. It is identical to the Multi-select Display setting on the Field Definition page (present only when the Multi-select Lists option is installed).One of the following values:

CWEB_MULTISELECT_DISPLAY_DEFAULT (0) - Comma/space-delimited format.

CWEB_MULTISELECT_DISPLAY_BR_BREAKS (1) - Line breaks separate values.

CWEB_MULTISELECT_DISPLAY_DL_LIST (2) - Values are displayed in an HTML Definition (<DL>) list.

CWEB_MULTISELECT_DISPLAY_UL_LIST (3) - Values are displayed in an HTML <UL> list.
 CWEB_SUFFIX_MULTI_SELECT_DISPLAY
Reload Button Used to specify whether or not the field has an iconic reload button associated with it (True/False). CWEB_SUFFIX_RELOADBUTTON
Row Span Used to specify the number of rows that a field spans. CWEB_SUFFIX_FORM_ROW_SPAN
Rows Used to specify the number of rows for a Memo (HTML Textarea) field, or for a multi-row list. CWEB_SUFFIX_ROWS
Sort Order Used to change the sort order for a subform record listing. The property must be set during an event hook for the subform that runs during the Form Load View event. Field Name must be set to "Sort Order", and the New Value must be a valid SQL order clause (ex: "Text001 ASC"). The property value is set as the value of the ADO.NET DataTable DefaultView.Sort and must meet its requirements and constraints. CWEB_SUFFIX_SORT_ORDER
Text Color Used to change the text color of the caption cell for a normal field, or the text color for a Section Break, Fixed Text Area, or Text Cell control. The color must be either a valid HTML color code (including the leading "#" character), or a color variable. For example:

"#000000"
 CWEB_SUFFIX_TEXTCOLOR
Use Full Row Used to specify whether or not the field consumes a full row in the HTML table that renders the form (True/False). CWEB_SUFFIX_USEFULLROW
Visible Used to change the visibility of a field (True/False). CWEB_SUFFIX_VISIBLE