• _CSeti_FindQuery

  • Purpose: Provides an optional query to customize search results within a form.

  • Syntax: __CSeti_FindQuery

• _Create_Stat_Cols_Rows_Graph_End

  • Purpose: Finishes the configuration of a statistical graph.

  • Syntax: __Create_Stat_Cols_Rows_Graph_End

• _DB_Connection_String(DB_Connection_String)

  • Purpose: Temporarily changes the database connection string for the current script.

  • Syntax: __DB_Connection_String("connection_string")

• _DB_Connection_String_Clear()

  • Purpose: Resets the connection string to default after a temporary change.

  • Syntax: __DB_Connection_String_Clear()

• _Display_Fatal_Errors

  • Purpose: Displays queries and errors encountered during ODBC interactions, aiding in troubleshooting.

  • Syntax: __Display_Fatal_Errors

• _Display_Integrity_Validations

  • Purpose: Shows the query and criteria used to check if a record can be safely deleted.

  • Syntax: __Display_Integrity_Validations

• _ExecuteSQL(Query_to_Execute)

  • Purpose: Executes an SQL statement (e.g., update, insert, delete) on the database.

  • Syntax: __ExecuteSQL("SQL Query Here")

• _ExportSQL(Query, FullPath_FileName, IncludeTitles)

  • Purpose: Exports query results from the database to a file (often CSV format).

  • Syntax: __ExportSQL("SQL Query", "c:\path\to\file.csv", True/False)

• _Map_Create(Place_for_the_map_in_form, Field_name_with_latitude_info, Field_name_with_longitude_info, width, height, Field_for_pin_placement, Leaflet_token_access)

  • Purpose: Creates a map on the form using Leaflet. Requires parameters and does not accept variables.

  • Syntax: __Map_Create("div_id", "lat_field", "lon_field", 500, 300, "pin_field", "access_token")

• _Map_Create_End

  • Purpose: Completes the map configuration.

  • Syntax: __Map_Create_End

• _Map_Create_Start

  • Purpose: Starts the configuration for a map creation.

  • Syntax: __Map_Create_Start

• _Menu_Create(String_to_Replace_URL_occurrences)

  • Purpose: Creates a menu, dynamically replacing a placeholder in URLs.

  • Syntax: __Menu_Create("...replace_this_part...")

• _Menu_Create_End

  • Purpose: Completes the menu creation.

  • Syntax: __Menu_Create_End

• _Menu_Create_Start

  • Purpose: Begins the definition of a menu creation.

  • Syntax: __Menu_Create_Start

• _Move_Fields_Up(List_of_Fields_CSV)

  • Purpose: Repositions form fields one line up within the form layout.

  • Syntax: __Move_Fields_Up("field1, field2, ...")

Report Generation

• _Report_Commands

  • Purpose: Specifies available actions for the report.

  • Syntax: __Report_Commands "Report,Export"

  • Options: "Report" (display), "Export" (submit with seticom=10)

• _Report_DisplayListMaxResults

  • Purpose: Controls the maximum rows in report displays.

  • Syntax: __Report_DisplayListMaxResults (Default: 10)

• _Report_DisplayListWidth

  • Purpose: Sets the display width (in characters) for reports.

  • Syntax: __Report_DisplayListWidth (Default: 90)

• _Report_Init

  • Purpose: Initializes the report, clearing previous settings.

  • Syntax: __Report_Init

• _Report_OnlyResults

  • Purpose: Displays only the report results (hides other elements).

  • Syntax: __Report_OnlyResults (Default: F). Set to 'T'. Must be after '_Report_Init'.

• _Report_Query

  • Purpose: Defines the SQL query to retrieve report data.

  • Syntax: __Report_Query "SELECT..." (Can include Xbuilder_Hyperlink for linkable rows).

• _Report_Row

  • Purpose: Configures the layout of data rows in the report.

  • Syntax: __Report_Row (Options for TextField, Validated TextField, CheckBox, Text Area)

• _Report_TargetURL

  • Purpose: Sets the target URL for hyperlinks defined with 'Xbuilder_Hyperlink'.

  • Syntax: __Report_TargetURL "/target_page" (Must be after _Report_Init).

• _Report_Title

  • Purpose: Sets the title of the report.

  • Syntax: __Report_Title "Report Title"

Database Retrieval

• _RetrieveSQL(Query, VarResult)

  • Purpose: Fetches data from the database and stores it in a variable.

  • Syntax: __RetrieveSQL("SELECT...", "myResultVariable")

Database Retrieval

• _RetrieveSQL_Simple(Query, VarResult)

  • Purpose: Fetches data from the database (simpler version of _RetrieveSQL).

  • Syntax: __RetrieveSQL_Simple("SELECT...", "myResultVariable")

  • Notes: Doesn't return field type information.

Screen/Form Configuration

• _Screen_Commands

  • Purpose: Defines available actions on a data entry/manipulation screen.

  • Syntax: __Screen_Commands "Find,FindSp,New,Delete,Update"

  • Options:

    • "Find": Submits seticom=1

    • "FindSp": Submits seticom=2

    • "New": Submits seticom=3

    • "Delete": Submits seticom=4

    • "Update": Submits seticom=5

Screen Creation

• _Screen_Create(name_of_the_form, accepted_commands, table_name, search_fields, defaults, list_of_fields, Screen_Reduction_in_Pixels, function_to_run_before_the_screen, function_to_run_after_the_screen, Screen_Width)

  • Purpose: Automatically creates a data input/manipulation screen.

  • Syntax: Requires nine parameters (doesn't accept variables). Example provided.

  • Notes: Many options for controlling field display and validation.

• _Screen_Create_Start

  • Purpose: Initiates the definition of a screen created with _Screen_Create.

  • Syntax: __Screen_Create_Start

• _Screen_Create_End

  • Purpose: Completes the definition of a screen created with _Screen_Create.

  • Syntax: __Screen_Create_End

Screen Configuration

• _Screen_Commands

  • Purpose: Specifies allowed actions on the screen.

  • Syntax: __Screen_Commands "Find, FindSp, New, Delete, Update"

  • Options: (related to seticom values):

    • "Find": Submits seticom=1

    • "FindSp": Submits seticom=2

    • "New": Submits seticom=3

    • "Delete": Submits seticom=4

    • "Update": Submits seticom=5

• _Screen_DisplayListMaxResults

  • Purpose: Sets the maximum rows shown in "FindSP" operations.

  • Syntax: __Screen_DisplayListMaxResults (Default: 10)

• _Screen_DisplayListWidth

  • Purpose: Controls display width (in characters) for "FindSP" operations.

  • Syntax: __Screen_DisplayListWidth (Default: 90)

• _Screen_Id_Visible

  • Purpose: Toggles visibility of the main record ID field on the form.

  • Syntax: __Let __Screen_Id_Visible="T" (or "F" to hide)

• _Screen_Init

  • Purpose: Initializes the screen, clearing previous values.

  • Syntax: __Screen_Init

• _Screen_Marquee

  • Purpose: Toggles operation status display (completion messages).

  • Syntax: __Screen_Marquee

  • Notes: Status available in _Marquee_Message variable.

Screen Configuration

• _Screen_NewDefaults

  • Purpose: Sets the initial values or conditions for creating a new record.

  • Syntax: __Screen_NewDefaults "field1=value1, field2=value2 ..."

  • Important: This command is mandatory for setting up forms correctly.

• _Screen_OldCmps

  • Purpose: Toggles inclusion of hidden fields with previous data (useful for update operations)

  • Syntax: __Screen_OldCmps (True or False, default is False)

  • Notes: Old values are passed with names like CmpOld_FieldName

• _Screen_Row

  • Purpose: Configures the layout of a specific field on a form.

  • Syntax: __Screen_Row "FieldFormattingOptions >FieldName" (See Screen_Create for formatting details)

  • Notes: Can be used with variables, strings, or calculations.

• _Screen_Search

  • Purpose: Defines which fields can be used for searching within the form.

  • Syntax: __Screen_Search "Field1, Field2, ..."

• _Screen_TableName_Key

  • Purpose: Crucially links the form to its database table and primary key.

  • Syntax: __Screen_TableName_Key "TableName, KeyFieldName"

  • Optional: Can specify database connection server (##:TableName).

Report Generation

• _ShowReport

  • Purpose: Displays a report based on previously configured settings.

  • Syntax: __ShowReport

  • Important: The system creates a variable ReportShow_Error to capture database query errors.

Screen Configuration

• _Screen_TextAreaCols

  • Purpose: Controls the width (in columns) of text areas on a form.

  • Syntax: __Screen_TextAreaCols (Default: 85 columns)

• _Screen_TextAreaRows

  • Purpose: Controls the height (in rows) of text areas on a form.

  • Syntax: __Screen_TextAreaRows (Default: 8 rows)

• _Screen_Title

  • Purpose: Sets the title of the screen/form.

  • Syntax: __Screen_Title "My Form Title"

Screen Display and Behavior (ShowScreen)

• _ShowScreen

  • Purpose: Displays a configured form, allowing data input or manipulation.

  • Notes:

    • Provides image upload fields with variables like imagefield_SCREENVARNAME_FileName, ..._FileExtension, and ... (binary data).

    • Includes various commands for form setup (Screen_Init, Screen_Commands, etc.) – see previous breakdowns for details.