ScriptCase 9 Macro Documentation

scriptcase

SQL

sc_begin_trans

This macro starts a set of transations in the database.

sc_change_connection

This macro dynamically change the application connections.

sc_commit_trans

This macro effective a set of transations in the database.

sc_concat

With this macro you can concat fields on select for every database.

sc_connection_edit

This macro edits an existing connection at runtime.

sc_connection_new

This macro creates new connections dinamically.

sc_error_continue

This macro deactivates the Scriptcase standard database error treatment message for an event.

sc_error_delete

This macro configure the variable that contains the database error message that can occurs during the exclusion of a record.

sc_error_insert

This macro configure the variable that contains the database error message that can occurs during the addition of a record.

sc_error_update

This macro configure the variable that contains the database error message that can occurs during the update of a record.

sc_exec_sql

This macro execute SQL commands passed as parameter or a SQL command in the SQL field action type.

sc_lookup

This macro executes a SELECT command stored in the second parameter and returns the data in a variable.

sc_reset_change_connection

This macro erases the changes made using “sc_change_connection”.

sc_reset_connection_edit

This macro undoes the connection edits made by macro “sc_connection_edit”.

sc_reset_connection_new

This macro undoes the connections made by the macro “sc_connection_new”.

sc_rollback_trans

This macro discards a set of transations in the data base.

sc_select

This macro executes the commands passed in the second parameter and returns the dataset in a variable.

sc_select_field

This macro modify dynamically a field that will be recovered in the grid.

sc_select_order

This macro modify dynamically the grids “ORDER BY” clause field.

sc_select_where

This macro adds dynamically a condition to the grid WHERE clause.

sc_set_fetchmode

This macro allows to change the type of return from the dataset of the select commands

sc_sql_injection

This macro it used protect the field/variable against “SQL injection”.

sc_sql_protect

This macro protects the value passed as parameter according with the used database.

sc_where_current

This macro its used to make a reference of the where clause currently used.

sc_where_orig

This macro saves the where clause content of the original application select.

Date

sc_date

This macro calculates and returns increments and decrements using dates.

sc_date_conv

This macro converts the date field passed as parameter with an input format to another field with an output format.

sc_date_dif

This macro calculates the difference between two dates (passed as parameters) returning the result in days.

sc_date_dif_2

This macro calculates the difference between two dates returning the amount of days, months and years.

sc_date_empty

This macro checks if a date field its empty retuning a boolean.

sc_time_diff

Calculate difference in hours, returning the amount of hours, minutes and seconds.

Control

sc_ajax_javascript

This macro allows the execution of JavaScript methods in form/control events

sc_alert

This macro shows a Javascript alert message screen.

sc_apl_conf

This macro modify the application execution property.

sc_calc_dv

This macro calculate verify digits.

sc_changed

This macro returns “true” if the field name have been changed.

sc_confirm

This macro shows a Javascript confirm screen.

sc_decode

This macro returns the encrypted field or variable to its original value.

sc_encode

This macro returns the field or variable with the content encrypted.

sc_error_exit

This macro Interrupts the application execution if there are error messages generated by the macro “sc_error_message”.

sc_error_message

This macro generate an error message.

sc_exit

This macro forces the application exit.

sc_getfield

This macro assign the properties of a field to a javascript variable.

sc_get_language

This macro returns the abbreviation of the language used.

sc_get_regional

This macro returns the abbreviation of the regional settings used.

sc_get_theme

This macro returns the application theme name.

sc_groupby_label

This macro dynamically modify the field label displayed in groupby lines.

sc_image

This macro loads images passed as parameter to use in the application.

sc_include

This macro its used to “include” PHP routines.

sc_include_lib

This macro its used to select dynamically the application libraries.

sc_include_library

This macro includes a PHP file from a library in the application.

sc_label

This macro its used to modify dynamically the grid form field label.

sc_language

This macro returns the language and regional settings.

sc_link

This macro dynamically creates or modifies links between grid applications and other applications.

sc_log_add

This macro will add a register into the log table.

sc_log_split

This macro returns what was inserted in the “description” field of the log table in an array format.

sc_mail_send

This macro its used to send e-mails.

sc_make_link

This macro is used to create a string with the link data to another application.

sc_master_value

This macro update a Master Application object from a Detail Application.

sc_redir

This macro its used to redirects to other application or URL.

sc_reset_global

This macro delete session variables received as parameter.

sc_seq_register

This macro provide the register sequential number.

sc_set_global

This macro its used to register session variables.

sc_set_groupby_rule

Macro is used to select an specific GROUP BY rule.

sc_set_language

This macro allows to dynamically change the application language.

sc_set_regional

This macros allows to dynamically change the application regional settings.

sc_set_theme

This macro its used to dinamically define the application themes.

sc_site_ssl

This macro verifies if its been used a safe/secure site. (https protocol)

sc_trunc_num

This macro its used to set the number of decimals.

sc_url_exit

This macro modifies the application exit URL.

sc_url_library

This macro returns the path of a file, inside a library, to be used on the applications.

sc_warning

This macro dynamically activates or deactivates warning messages control.

sc_webservice

This macro is used to communicate with a web service.

sc_zip_file

This macro its used to generate ZIP files from a file list and/or directories.

Filter

sc_where_filter

This macro its used to save the where clause content generated through the filter form.

Security

sc_apl_status

This macro Activate/Deactivate the applications at user level.

sc_ldap_login

This macro establish the connection with the user credentials.

sc_ldap_logout

Macro used to release the connection after using the macro sc_ldap_login

sc_ldap_search

Macro to perform searches in the LDAP.

sc_reset_apl_conf

This macro deletes all the modifications effected by “sc_apl_conf” macro.

sc_reset_apl_status

This macro deletes all the application security status variables.

sc_reset_menu_delete

This macro restores a menu item structure. (removed by the macro “sc_menu_delete”).

sc_reset_menu_disable

This macro its used to enable a menu item structure. (disabled by the macro “sc_menu_disable”).

sc_user_logout

Macro used to log the user out to the system.

Shows

sc_ajax_message

This macro allows the application to display customized messages.

sc_ajax_refresh

Macro to refresh a Grid

sc_block_display

This macro dynamically show/hide the fields of a specific block.

sc_field_color

This macro changes the color of a determined field text.

sc_field_disabled

This macro its used to block a field to get any data that would be typed on it.

sc_field_disabled_record

This macro has the objective to block the typing on determined fields in the Forms.

sc_field_display

This macro dynamically display or not a specific field.

sc_field_init_off

This macro is intended to inhibit the query fields on the initial load.

sc_field_readonly

This macro dynamically set a form field attribute to ‘“Read-Only”

sc_field_style

This macro allolws to modify dinamically the grid field style.

sc_format_num

This macro its used to format numerical values.

sc_format_num_region

This macro has the objective to format numbers, using the regional settings

sc_form_show

This macro dynamically show or not the form.

sc_get_groupby_rule

This macro provides the name of the groupby rule running at the time.

sc_hide_groupby_rule

Macro used to disable Group By rules.

sc_set_focus

This macro its used to set the focus to a form field.

Buttons

sc_btn_copy

This macro returns “true” when the “copy” button is selected in a form.

sc_btn_delete

This macro returns “true” when the “Delete” button is selected in a form.

sc_btn_display

This macro shows and hides buttons on the toolbar in execution time.

sc_btn_insert

This macro returns “true” when the “Add” button is selected in a form.

sc_btn_new

This macro returns “true” when the “Add New” button is selected in a form.