Introduction To Javascript Functions.
VConsole relies heavily on javascript to perform a lot of the client side functions like right clicking, menu drop downs, moving and resizing columns, and of course, the AJAX operations. If you are interested in executing your own javascript, then this is the place to start. In this section, we will list all the javascript functions that you can call in your own javascript functions. Remember that VConsole is heavily reliant on javascript so if you call any of these functions incorrectly, you risk messing up the VConsole interface. We also recommend looking at the javascript files that are located in the vconsole/javascript/ folder. They are available for you to review in plain text. We provide these javascript files in plain text because we want VConsole developers to have a better understanding of how the application and interface works.

IMPORTANT: If you modify any of the javascript files in the vconsole/javascript/ folder, they may end up getting overwritten by an automatic update. Always backup your changes and check to see if they are still there after an update. If you can, we recommend that you avoid modifying the .js files in the vconsole/javascript/ folder. The 2 exceptions are the wysiwyg.js which is meant to be modified so that the WYSIWYG fields in the wizardmanager and propertiesmanager meet your needs and the customscripts.js file which is meant for you to put your own custom javascript functions which are available anytime after VConsole loads. So, if you need to add your own custom javascript functions, you should put them in the customscripts.js file.

Adding Your Own Javascript Functions.
We recommend NOT modifying the default javascript (.js) files in the vconsole/javascript/ folder. The reason is that any of the files in that folder may be overwritten by an update. If this happens, then your custom changes will be overwritten and lost. Of course, if you absolutely need to modify one of these files, we can't stop you, we just want to make you aware of the consequences. If you do modify one of these files, make sure that you have a backup of your changes. If your changes get overwritten by an update, you will have to apply your changes to the newly updated file. Do not just copy the old file back because there is a reason that it was updated. You MUST re-apply your changes to the new file. The exceptions are the wysiwyg.js file and the customscripts.js file. Both files will never be overwritten by an update. The wysiwyg.js file is meant for you to customize your WYSIWYG fields and the customscripts.js file is meant for you to put your own custom javascript functions that are available to the interface at any time.

If you want to add your own javascript, you can do so by adding it to the customscripts.js file located in the vconsole/javascript/ folder.

Built In Javascript Functions.
All the functions listed below show the function name along with a brief description of what the function does. Then, on the next bullet, you see how to call the function. And then we give you a list of arguments and what the function returns.

• function addColumn() - This function is used by the datamanager and is responsible for adding a column to the view either before or after the selected column.
  • addColumn(data);
    • data - String. Should be 'A:<field>' or 'B:<field>' where <field> is the name of the field to add as defined in the dms.php. The A and B stands for After and Before.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function addExtraCol() - This function is used by the datamanager. It is responsible for initiating the "Add Extra Column" wizard that allows a user to create an extra column.
  • addExtraCol();
    • This function takes no arguments.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function addNewForm() - This function is used by the datamanager. It is responsible for initiating the "Add New Form" wizard that allows a user to create new forms.
  • addNewForm();
    • This function takes no arguments.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function addoption() - This function is used by the wizardmanager and propertiesmanager. It is used on choicebuilder fields and is responsible for adding a new choice to the end of the choice list. Invoked when a user clicks the "Add Option" button.
  • addoption();
    • This function takes no arguments.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function addTinyMCEControl() - This function is used by the wizardmanager and propertiesmanager. It is used to turn a <textarea> object into a rich text editor instance.
  • addTinyMCEControl(id);
    • id - String. The id attribute of the <textarea> object to transform into a rich text editor instance.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
    • WARNING: You MUST call the removeTinyMCEControls() function before deleting or replacing the <textarea> object. If you don't unexpected results could occur.
       
• function addtofav() - This function is responsible for adding the current screen to your favorites. It is called when a user clicks on the "Add this screen to your favorites" drop down menu item.
  • addtofav();
    • This function takes no arguments.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function AddSearch() - This function is used by the datamanager and is responsible for adding search conditions. It is invoked from the "Search Builder" drop down menu.
  • AddSearch(type);
    • type - String. Set to either 'date', 'text', or 'num'. This determines what type of search condition to add.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function ajax() - This function sets a wait help message then if initiates an ajax operation to get further info. When the further info arrives, the help message is replaced by the further info.
  • ajax(context, updatecontext, width);
    • context - String. The message to show in the help box until the ajax data comes in to replace this message.
    • updatecontext - String. A url-encoded set of parameters to send back in to the application via AJAX. The application should be able to understand these parameters in order to output the message that you want to show.
    • width - Number. Optional. The maximum width in pixels that the help box can be. If not set, then it adapts according to the content.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function ApplySearch() - This function is used by the datamanager and is responsible for applying a saved search. It is invoked from the "Search Builder" drop down menu.
  • ApplySearch(id);
    • id - String. The id of the search to apply. The search must belong to the user.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function calendarClearCalendar() - This function is used in wizardmanager and propertiesmanager forms for the calendar and time type fields. This function closes the calendar interface without setting an actual date / time.
  • calendarClearCalendar();
    • This function takes no arguments.
    • This function returns nothing.
       
• function calendarClearTimes() - This function is used in wizardmanager and propertiesmanager forms for the calendar and time type fields. This function clears all the calendar time and date variables.
  • calendarClearTimes();
    • This function takes no arguments.
    • This function returns nothing.
       
• function calendarDisplayAP() - This function is used in wizardmanager and propertiesmanager forms for the calendar and time type fields. This function displays the "AM / PM" selector interface to the user.
  • calendarDisplayAP();
    • This function takes no arguments.
    • This function returns nothing.
       
• function calendarDisplayHour() - This function is used in wizardmanager and propertiesmanager forms for the calendar and time type fields. This function displays the "Hours" selector interface to the user.
  • calendarDisplayHour();
    • This function takes no arguments.
    • This function returns nothing.
       
• function calendarDisplayMinute() - This function is used in wizardmanager and propertiesmanager forms for the calendar and time type fields. This function displays the "Minutes" selector interface to the user.
  • calendarDisplayMinute(start);
    • start - Number. The numeric minute to start on from 0 to 59.
    • This function returns nothing.
       
• function calendarDisplayYears() - This function is used in wizardmanager and propertiesmanager forms for the calendar and time type fields. This function displays the "Years" selector interface to the user.
  • calendarDisplayYears();
    • This function takes no arguments.
    • This function returns nothing.
       
• function calendarFindPos() - This function will find the X, Y position of any object. It is used to find the position of the calendar input object for calendar fields but can be used to find the position of any object.
  • var pos = calendarFindPos(obj);
    • obj - Object. The object to find the position of.
    • Returns - Array. The [X, Y] position of the object specified by obj.
       
• function calendarFormatMinute() - This function formats any minute for input into MySQL. If the minute is less than 10, it zero pads it.
  • var formattedminute = calendarFormatMinute(minute);
    • minute - Number or String. Set to the minute that you want to format. Should be between 0 and 59.
    • Returns - String. The formatted 2 digit string for the minute that is suitable for insert into MySQL.
       
• function calendarGetDaysInMonth() - This function will return the number of days in any desired month.
  • var daysinmonth = calendarGetDaysInMonth(year, month);
    • year - Number. The year to get the number of days for.
    • month - Number. The numeric month to get the number of days for.
    • Returns - Number. The number of days in the specified month.
       
• function calendarGetDownYears() - This function is used in wizardmanager and propertiesmanager forms for the calendar and time type fields. This function gets a new set of years for the "Years" selector interface and is invoked when the user clicks on the down arrow in the "Years" selector interface.
  • calendarGetDownYears();
    • This function takes no arguments.
    • This function returns nothing.
       
• function calendarGetStartDay() - This function will get the start day index for the first day of any month. If the first day of the month is a Sunday, then 0 is returned. If Monday, then 1 is returned, etc..
  • var startdayindex = calendarGetStartDay(year, month);
    • year - Number. The year to get the start day index of.
    • month - Number. The numeric month to get the start day index of.
    • Returns - Number. The numeric index of the start weekday of the desired month. If the month starts on a Sunday, then 0 is returned. If Monday, then 1 is returned, etc..
       
• function calendarGetSuffix() - This function will get the day suffix for any day. For 1, it will return 'st', for 2, it will return 'nd', for 3, it will return 'rd', for 4, it will return 'th', and so on.
  • var suffix = calendarGetSuffix(day);
    • day - Number. The day to get the suffix of.
    • Returns - String. The suffix for the day that is requested. If day is set to 1, it returns 'st'. If 2, then 'nd', if 3, then 'rd', if 4, then 'th', and so on.
       
• function calendarGetUpYears() - This function is used in wizardmanager and propertiesmanager forms for the calendar and time type fields. This function gets a new set of years for the "Years" selector interface and is invoked when the user clicks on the up arrow in the "Years" selector interface.
  • calendarGetUpYears();
    • This function takes no arguments.
    • This function returns nothing.
       
• function calendarSetAP() - This function is used in wizardmanager and propertiesmanager forms for the calendar and time type fields. This function sets the AM/PM setting on a calendar interface.
  • calendarSetAP(ap);
    • ap - String. Set to AM or PM.
    • This function returns nothing.
       
• function calendarSetCalPos() - This function is used in wizardmanager and propertiesmanager forms for the calendar and time type fields. This function sets the calendar interface div position to just under the calendar input text field.
  • calendarSetCalPos(div, parent);
    • div - Object. Set to the calendar interface div object.
    • parent - Object. Set to the calendar input text object to place the calendar under.
    • This function returns nothing.
       
• function calendarSetDateTime() - This function is used in wizardmanager and propertiesmanager forms for the calendar and time type fields. This function sets the date / time of the calendar input field and closed the calendar interface.
  • calendarSetDateTime(day);
    • day - Number. Optional. Specifies the numeric day of the month to set. If not specified, then the day that is already set is used. Month, Year, Time is already set by the user interface.
    • This function returns nothing.
    • This function executes the javascript that was set in the callback argument when the calendarTimeSelect() function is called.
       
• function calendarSetHour() - This function is used in wizardmanager and propertiesmanager forms for the calendar and time type fields. This function sets the hour on a calendar interface.
  • calendarSetHour(hour);
    • hour - Number. The numeric hour to set between 1 and 12.
    • This function returns nothing.
       
• function calendarSetInitialTimes() - This function is used in wizardmanager and propertiesmanager forms for the calendar and time type fields. This function sets the initial date / time of the calendar interface.
  • calendarSetInitialTimes(val);
    • val - String. Optional. Should be set to a MySQL formatted date / time to set the initial calendar interface to. If not set, the calendar interface gets set to the current date / time of the client's computer clock.
    • This function returns nothing.
       
• function calendarSetMinute() - This function is used in wizardmanager and propertiesmanager forms for the calendar and time type fields. This function sets the minute on a calendar interface.
  • calendarSetMinute(minute);
    • minute - Number. The numeric minute to set between 0 and 59.
    • This function returns nothing.
       
• function calendarSetMonth() - This function is used in wizardmanager and propertiesmanager forms for the calendar and time type fields. This function sets the month on a calendar interface.
  • calendarSetMonth(month);
    • month - Number. The numeric month to set between 1 and 12.
    • This function returns nothing.
       
• function calendarSetTimeContent() - This function is used in wizardmanager and propertiesmanager forms for the calendar and time type fields. This function sets the selected time interface and is invoked when the user sets the minute, hour, or am/pm settings in the interface.
  • calendarSetTimeContent();
    • This function takes no arguments.
    • This function returns nothing.
       
• function calendarSetToday() - This function is used in wizardmanager and propertiesmanager forms for the calendar and time type fields. This function sets the calendar date and time variables to the current time / date of the client's computer clock.
  • calendarSetToday();
    • This function takes no arguments.
    • This function returns nothing.
       
• function calendarSetYear() - This function is used in wizardmanager and propertiesmanager forms for the calendar and time type fields. This function sets the year on a calendar interface.
  • calendarSetYear(year);
    • year - Number. The numeric year to set.
    • This function returns nothing.
       
• function calendarShowMonthSelector() - This function is used in wizardmanager and propertiesmanager forms for the calendar and time type fields. This function displays the "Month" selector interface to the user.
  • calendarShowMonthSelector();
    • This function takes no arguments.
    • This function returns nothing
       
• function calendarStartClose() - This function is used in wizardmanager and propertiesmanager forms for calendar and time type fields. This function sets a timeout for closing the calendar interface and is called when the user's mouse leaves the calendar div.
  • calendarStartClose();
    • This function takes no arguments.
    • This function returns nothing.
       
• function calendarStartOver() - This function is used in wizardmanager and propertiesmanager forms for calendar and time type fields. This function clears the timeout for when the user's mouse leaves the calendar div and is called when the user mouse's over the calendar interface div.
  • calendarStartOver();
    • This function takes no arguments.
    • This function returns nothing.
       
• function calendarTimeSelect() - This function is used in wizardmanager and propertiesmanager forms for calendar and time type fields. This function creates the calendar interface and is called when a calendar text field receives focus.
  • calendarTimeSelect(showOBJ, inputOBJ, showTime, callback, nclear);
    • showOBJ - Object. Set to the input text object that should receive the human readable form of the time or date.
    • inputOBJ - Object. Set to the hidden input text object that should receive the MySQL formatted form of the time or date.
    • showTime - Number. Determines the type of calendar / time field to show.
      • 0 - Shows a calendar interface - YYYY-MM-DD
      • 1 - Shows a calendar + time interface - YYYY-MM-DD HH:MM:SS
      • 2 - Shows a year / month interface - YYYY-MM
      • 3 - Shows a time only interface - HH:MM:SS
    • callback - String. Optional. Set to javascript to execute after the time / date has been set by the user.
    • nclear - Bool. Set to false to set the calendar to the current date / time set in inputOBJ. Set to true to leave the calendar to the current set date / time.
    • This function returns nothing.
       
• function calfield() - This function is used by the datamanager. In calendar display mode, it instructs the calendar to show records based on a date field.
  • calfield(field);
    • field - String. The name of the date or datetime field as specified in the dms.php file.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function calListDate() - This function is used by the datamanager. In calendar display mode, it instructs the interface to show all records for a certain date as a list.
  • calListDate(start, end, sstart, send, calfield);
    • start - String. A MySQL formatted date / time to start displaying records.
    • end - String. A MySQL formatted date / time to end displaying records.
    • sstart - String. A human readable version of the start argument. (Gets displayed in the date start field)
    • send - String. A human readable version of the end argument. (Gets displayed in the date end field)
    • calfield - String. The name of the date or datetime field to show records by as specified in the dms.php file.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function calShowDate() - This function is used by the datamanager and is used to show a list of all records on a certain date. It is invoked when the user clicks on a calendar day.
  • calShowDate(day);
    • day - Number. The day of the month to show records from.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function calviewLast() - This function is used by the datamanager. In calendar display mode, it instructs the calendar to go to the previous month.
  • calviewLast();
    • This function takes no arguments.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function calviewMonth() - This function is used by the datamanager. In calendar display mode, it instructs the calendar to to to a certain month.
  • calviewMonth(month);
    • month - Number. Set to the numeric month that you want to go to.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function calviewNext() - This function is used by the datamanager. In calendar display mode, it instructs the calendar to go to the next month.
  • calviewNext();
    • This function takes no arguments.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function calviewYear() - This function is used by the datamanager. In calendar display mode, it instructs the calendar to to to a certain year.
  • calviewYear(year);
    • year - Number. Set to the numeric year that you want to go to.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function cancelImport() - This function is used by the wizardmanager to cancel a CSV import while it is in progress. It is invoked when the user clicks the "Cancel" button while a CSV import is in progress.
  • cancelImport();
    • This function takes no arguments.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function changesigndocres() - This function is used by the document management module and is responsible for setting the document signing resolution when someone is signing a document.
  • changesigndocres();
    • This function takes no arguments.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function changesignink() - This function is used by the document management module and is responsible for setting the document signing ink color when someone is signing a document.
  • changesignink();
    • This function takes no arguments.
    • This function returns nothing.
       
• function chartcfilter() - This function is used by the datamanager and is responsible for setting the chart column comparison / stack filter while in chart display mode.
  • chartcfilter(filter);
    • filter - String. The name of a field as defined in the dms.php file.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function chartdateinterval() - This function is used by the datamanager and is responsible for setting the date interval while in chart display mode.
  • chartdateinterval(interval);
    • interval - String. Set to the date interval type that you want to set.
      • 'minute' => 'Minutes'
      • 'hour' => 'Hours'
      • 'day' => 'Days'
      • 'week' => 'Weeks'
      • 'month' => 'Months'
      • 'quarter' => 'Quarters'
      • 'semiannual' => 'Half Years'
      • 'annual' => 'Years'
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function chartdatestart() - This function is used by the datamanager and is responsible for setting a chart start date while in chart display mode.
  • chartdatestart(showdate, image);
    • showdate - String. A human readable version of the date that you want to set the chart start date to.
    • image - String. The HTML code for an icon image to display next to the showdate argument.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function chartfilter() - This function is used by the datamanager and is responsible for setting a chart filter while in chart display mode.
  • chartfilter(filter);
    • filter - String. The name of a field as defined in the dms.php file.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function chartfliptype() - This function is used by the datamanager and is responsible for setting the chart flip type while in chart display mode.
  • chartfliptype(type);
    • type - String. Set to the chart flip type that you want to set.
      • 'noflip' => 'Normal View'
      • 'flip' => 'Flip View'
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function charthorizontal() - This function is used by the datamanager and is responsible for setting the chart horizontal field while in chart display mode.
  • charthorizontal(field);
    • field - String. The name of a field as defined in the dms.php file.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function chartnumcols() - This function is used by the datamanager and is responsible for setting the number of date columns to show while in chart display mode.
  • chartnumcols(value);
    • value - Number. The number of date columns to show.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function charttype() - This function is used by the datamanager and is responsible for setting the chart type while in chart display mode.
  • charttype(type);
    • type - String. Set to the type of chart to set. 'pie', 'doughnut', 'column', 'line', 'area'
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function chartvaltype() - This function is used by the datamanager and is responsible for setting the chart column filter value type while in chart display mode.
  • chartvaltype(type);
    • type - String. Set to the type of column filter that you want to set.
      • 'nostack' => 'Compare Values'
      • 'stack' => 'Stack Values'
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function chartvertical() - This function is used by the datamanager and is responsible for setting the chart vertical field while in chart display mode.
  • chartvertical(field);
    • field - String. The name of a field as defined in the dms.php file.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function check() - This function is used in the datamanager. It is responsible for checking or unchecking all records and is called whenever the main "Checkall" checkbox is clicked.
  • check(form, box);
    • form - Object. The form object that contains all the checkboxes to check or uncheck.
    • box - Object. The checkbox object to treat as the master or "Checkall" checkbox.
       
• function checkall() - This function is used in the datamanager. When called, all datamanager records are checked along with the master "Checkall" checkbox.
  • checkall();
    • This function takes no arguments.
    • This function returns nothing.
       
• function checkallMenu() - This function is used in the datamanager and is responsible for showing the record selection menu. It is invoked when someone right clicks on the master "Check All" checkbox.
  • checkallMenu(event);
    • event - Event. The oncontextmenu event
    • This function returns nothing.
       
• function checkColDrag() - This function is used by the datamanager. During a column drag / drop operation this function checks to see whether or not the mouse is over a drop target.
  • checkColDrag(ev);
    • ev - Event. window.event
    • This function returns nothing
       
• function checknone() - This function is used in the datamanager. When called, all datamanager records are unchecked along with the master "Checkall" checkbox.
  • checknone();
    • This function takes no arguments.
    • This function returns nothing.
       
• function checkone() - This function is used in the datamanager. When called, it will uncheck all records and check a single record that is specified in the id argument.
  • checkone(id);
    • id - Number. The record id (tableindex value) of the record to check.
    • This function returns nothing.
       
• function collapse_tree() - This function is used by the wizardmanager and propertiesmanager to make tree fields collapse their branches just like a windows explorer interface.
  • collapse_tree(treeid, branchid);
    • treeid - String. The treeid of the tree as in the vc_trees table. (treeid field)
    • branchid - Number. The id of the branch to expand as in the vc_trees table. (id field)
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function columnMouseDown() - This function is used by the datamanager. It is responsible for starting a column resize operation and is called when the mouse is pressed on the edge of a column.
  • columnMouseDown(event, id);
    • event - Event. The onmousedown event.
    • id - String. The id attribute of the column to resize.
    • This function returns nothing.
       
• function columnMouseMove() - This function is called every time the mouse moves. This function is depreciated and may be removed in future versions.
  • columnMouseMove(event);
    • event - Event. The document.onmousemove event.
    • This function returns nothing.
       
• function columnMouseUp() - This function is called every time the mouse is released. It has several functions but was primarily designed to stop a column resize operation in the datamanager and get the new size so that it can be set.
  • columnMouseUp(event);
    • event - Event. The document.onmouseup event.
    • This function returns nothing.
       
• function createAjaxObject() - This function creates and returns an AJAX object. set_progress(0); is also called.
  • var xmlHttp = createAjaxObject();
    • This function takes no arguments.
    • Returns - Object. The AJAX xmlHttp object that is created.
       
• function customizeToolbar() - This function is used by the datamanager. It invokes the "Customize Toolbar" wizard operation and is invoked when the user clicks the "Customize Toolbar" button.
  • customizeToolbar();
    • This function takes no arguments.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function datamanagerGetSelected() - This function is used by the datamanager. When invoked, it returns an array of all the selected record ids.
  • var selected = datamanagerGetSelected();
    • This function takes no arguments.
    • Returns - Array. An array of all the currently selected row ids.
       
• function DelAllSavedSearch() - This function is used by the datamanager. It deletes all the user's saved searches and is invoked from the "Search Builder" drop down menu.
  • DelAllSavedSearch(conf);
    • conf - String. Set to a message to show to the user that asks them to confirm the operation. (They get a chance to cancel)
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function delColumn() - This function is used by the datamanager and is responsible for removing a column from the current view.
• delColumn();
  • This function takes no arguments.
  • This function returns nothing.
  • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
     
• function DeleteOption() - This function is used by the wizardmanager and propertiesmanager. It is responsible for removing a specific choice from the list of choices in a choicebuilder field.
  • DeleteOption(opt);
    • opt - Number. The choice number to delete (First choice is 1, Second is 2, etc..)
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function delForms() - This function is used by the datamanager. It is responsible for initiating the "Delete Form" wizard that allows a user to delete forms.
• delForms();
  • This function takes no arguments.
  • This function returns nothing.
  • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
     
• function DelSavedSearch() - This function is used by the datamanager. It deletes a user's saved search and is invoked when the user selects a search to delete from the "Search Builder" drop down menu.
  • DelSavedSearch(id, conf);
    • id - String. Set to the id of the search that you want to delete. The search must belong to the currently logged in user.
    • conf - String. Set to a message to show to the user that asks them to confirm the operation. (They get a chance to cancel)
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function delview() - This function is used by the datamanager and deletes the user's current view and column setup.
  • delview();
    • This function takes no arguments.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function dhtmlLoadScript() - This function will auto load and execute a javascript file. If the javascript file contains functions, those functions will be available from then on.
  • dhtmlLoadScript(url);
    • url - String. Set to the URL of the javascript file that you want to load.
    • This function returns nothing.
       
• function disableEnter() - This function will return false when the enter key is pressed and this function is called during an onkeypress event.
  • disableEnter(e);
    • e - Event. The document.onkeypress event.
    • This function returns true when enter was not pressed or false if enter was pressed.
      This function is useful for disabling form submition when the enter key is pressed within a form field.
       
• function disableselect() - This function is responsible for disabling any HTML selection while you are dragging objects.
  • disableselect(e);
    • e - Event. The document.onmousedown event.
    • This function returns nothing.
    • You can re-enable select by calling the reSelect() function.
       
• function dmsdetailsClose() - This function is responsible for closing the datamanager details floating div.
  • dmsdetailsClose();
    • This function takes no arguments.
    • This function returns nothing.
       
• function dofilter() - This function is used by the datamanager and is used to set a filter. It is invoked when the user selects a filter from a filter drop down menu.
  • dofilter(filter);
    • filter - Number. Optional. If set should be the id of a filter to set. (Filter ids are incrementally set for each column. The first filter in a column is id 1, the 2nd is id 2, etc..) If not set or set to 0, then all filters for the current column are cleared.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function doHighlight() - This function is used in the datamanager and is responsible for performing the check process that happens when you mouse over records while the mouse is down.
  • doHighlight(tr);
    • tr - Object. Set to the record row object to check.
    • This function returns nothing.
       
• function doPrompt() - This function is used to prompt the user for input. Since V4.5-6, this function has replaced the regular javascript prompt() function. It shows a floating div with a text box prompt and collects input from the user much like the javascript prompt() function does it. A callback function must be set so that when the user submits their input, the input can be passed back to the calling function.
  • doPrompt(msg, def, callback);
    • msg - String. This is the human readable message that is presented to the user and should ask the user to provide input in the text box provided.
    • def - String. This should contain the default value to put in the input text box.
    • callback - String. This should be the name of the javascript function that called the doPrompt() function and, when eval'd it should get the user back to this same doPrompt() function.
    • Initially, this function returns false. If this is the case, then the user has been prompted for input. Once the user inputs text and clicks the OK button, then callback is called and this function will return the value that the user input.
       
• function doSearch() - This function is used by the datamanager and is called every time the user types or changes the search criteria. It clears then sets a small timeout that invokes the data search.
  • doSearch();
    • This function takes no arguments.
    • This function returns nothing.
       
• function dosort() - This function is used by the datamanager and is used to sort by a data column. It is invoked when the user clicks on a column header.
  • dosort(st, rv);
    • st - String. Set to the id of the column id to sort by as in the vc_data-views table.
    • rv - Number. Set to 0 for Ascending Sort or for 1 for Descending sort. (This is reversed if in your dms.php file you have the defrev parameter set to a true value.)
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function editField() - This function is used by the datamanager and is used to invoke the inline edit wizard for a data field.
  • editField(field, id);
    • field - String. The name of the field to edit as defined in the dms.php file
    • id - Number. The record id for the record that you want to edit.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function endColDrag() - This function is used by the datamanager. During a column drag / drop operation, this function is called when a column is dropped and if dropped onto another column header the column order is updated.
  • endColDrag(ev);
    • ev - Event. window.event
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function endHighlight() - This function is used in the datamanager and is responsible for stopping the check process that happens when you mouse over records while the mouse is down.
  • endHighlight(tr);
    • tr - Object. Set to the record row object to stop the check process on.
    • This function returns nothing.
       
• function expand_tree() - This function is used by the wizardmanager and propertiesmanager to make tree fields expand their branches just like a windows explorer interface.
  • expand_tree(treeid, branchid);
    • treeid - String. The treeid of the tree as in the vc_trees table. (treeid field)
    • branchid - Number. The id of the branch to expand as in the vc_trees table. (id field)
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function expandColumn() - This function is used in the datamanager and is used to set the column behavior to expand.
  • expandColumn(col);
    • col - Number. The column id as in the vc_data-views table.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function FilterMenu() - This function is used in the datamanager and is responsible for showing a drop down filter menu. It is invoked when the user clicks on a filter icon in a column header.
  • FilterMenu(event, filter);
    • event - Event. The onclick event.
    • filter - Object. The filter image icon for the filter that you want to show.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function getAjaxUpdate() - When the ajax() function is called, it initiates this function which actually updates the help content
  • getAjaxUpdate(updatecontext, width);
    • updatecontext - String. url-encoded string of parameters that is sent in to VConsole.
    • width - Number. Optional. The maximum width in pixels that the help box can be. If not set, it adapts to the content within.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function getDocHeight() - This function will return the document height of a document object.
  • var docheight = getDocHeight(doc);
    • doc - Object. A document object to get the height of
    • Returns - Number. The height of the document in pixels.
       
• function getDragPosition() - This function is used by the datamanager. During a column drag / drop operation, this function is called to get the current position of a drop target.
  • var position = getDragPosition(obj);
    • obj - Object. The drop target object to get the position of.
    • Returns - Assoc Array. This returns the {x:curleft,y:curtop} position of the drop target.
       
• function getIndexByElement() - This function gets the form index number for any form element. If the element is the 3rd element of a form, then 2 will be returned. (Remember, form element indexes start at 0)
  • var index = getIndexByElement(elem);
    • elem - Object. Set to the object of the element that you want to get the form index of.
    • Returns - Number. The index number between 0 and the number of elements contained in the parent form of elem.
       
• function getInnerWindow() - This function returns the current browser window width and height in pixels.
  • var windowdimensions = getInnerWindow();
    • This function takes no arguments.
    • Returns - Array. The width and height of the current browser window [W, H]
       
• function GetModule() - This function is responsible for changing the interface from 1 module to another. It is called when the user clicks on a module button in the top navigation bar.
  • GetModule(module, action, extra);
    • module - String. Should be the name of the module to go to.
    • action - String. Optional. Should be the name of the module action to execute, if any.
    • extra - String. Optional. If set, this is passed in as $_REQUEST['extra'] to your module.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function getMouseXPos() - This function returns the current mouse X position on the screen in pixels.
  • var mouseX = getMouseXPos(e);
    • e - Event. The document.onmousemove event.
    • Returns - Number. The current mouse X position in pixels.
    • This function gets called every time the mouse moves.
       
• function getMouseYPos() - This function returns the current mouse Y position on the screen in pixels.
  • var mouseY = getMouseYPos(e);
    • e - Event. The document.onmousemove event.
    • Returns - Number. The current mouse Y position in pixels.
    • This function gets called every time the mouse moves.
       
• function getNewWidth() - This function is used by the datamanager. It returns the new column width after a column resize operation so that it can be set.
  • var width = getNewWidth();
    • This function takes no arguments.
    • Returns - Number. Returns the new column width in pixels.
       
• function getRandomNumber() - This function generates and returns a positive random whole number.
  • var number = getRandomNumber(range);
    • range - Number. Set to a positive whole number.
    • Returns - Number. Returns a positive whole number between 0 and range.
       
• function getRandomChar() - This function generates and returns a random character.
  • var character = getRandomChar();
    • This function takes no arguments
    • Returns - String. Returns a random alpha-numeric character. It may return a number, a lowercase letter, or an upper case letter.
       
• function groupop() - This function is used by the datamanager and is used to execute a datamanager action (Both single actions and group actions)
  • groupop(conf, action, extra, extraval, conftype, ofunction, submitform);
    • conf - String. Optional. Set to the confirmation message to show the user. Gives them a chance to cancel the operation.
    • action - String. The datamanager action to execute.
    • extra - String. Optional. The message to show to the user that prompts them for input. (User input is passed to your action as $_REQUEST['extra'])
    • extraval - String. Optional. The default input value for when the user is prompted for input. Ignored if extra is not set.
    • conftype - String. Optional. Set to a string that can be evaluated as a javascript regular expression. If set, the user must type something and that must match the regular expression that you set here in order for the operation to proceed.
    • ofunction - String. Optional. Set to the name of a javascript function to execute instead of executing the action. The function is called as follows:
      • ofunction(conf, action, extra, extraval, conftype);
    • submitform - Bool. Optional. If set to a true value, then AJAX is not used to execute the action. Instead, the HTML form that encloses the datamanager interface is submitted directly to the server.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background. (Only if submitform evaluates to false)
       
• function headerMenu() - This function is used by the datamanager and is responsible for showing the right click column header menu. It is invoked when a user right clicks on a column header.
  • headerMenu(event, menu);
    • event - Event. The oncontextmenu event
    • menu - Object. The <th> column header object
    • This function returns nothing.
       
• function HideRows() - This function will hide any HTML object that has an id attribute assigned to it. It is used in various places in the application.
  • HideRows(trID);
    • trID - String. Should be set to the id (value of the id attribute) of the object to hide.
    • This function returns nothing.
       
• function iconHeaderMenu() - This function is used by the datamanager and is responsible for showing the right click column header menu for icon type columns. It is invoked when a user right clicks on an icon type column header.
  • iconHeaderMenu(event, menu);
    • event - Event. The oncontextmenu event
    • menu - Object. The <th> column header object
    • This function returns nothing.
       
• function InsertCBRow() - This function is used by the wizardmanager and propertiesmanager. It is responsible for inserting a new choice when no more buffered choices exist. It is called by the addoption() function.
  • InsertCBRow(id);
    • id - String. The id attribute of the choice next choice object. If it doesn't exist, then 1 is created using AJAX. If it does, then it returns false.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function insertField() - This function is used by the "Add New Form" or the "Modify Existing Form" wizard operations. It is used insert a form field into the HTML form. (Used for HTML forms only.)
  • insertField(sel);
    • sel - Object. The select object that contains the form field drop down list.
    • This function returns nothing.
       
• function InsertOption() - This function is used by the wizardmanager and propertiesmanager. It is responsible for inserting a new choice above an existing choice.
  • InsertOption(opt);
    • opt - Number. The choice number to add a choice above. (First choice is 1, Second choice is 2, etc...)
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function invertselection() - This function is used in the datamanager. When called, all checkboxes that were unchecked will be checked and all checkboxes that were checked will be unchecked.
  • invertselection();
    • This function takes no arguments.
    • This function returns nothing.
       
• function itemMenu() - This function is used by the datamanager and is responsible for showing the single item or multiple item right click menu for data records. It is invoked when a user right clicks on a data record.
  • itemMenu(event, tr);
    • event - Event. The oncontextmenu event
    • tr - Object. The <tr> record row object.
       
• function labelItem() - This function is used by the datamanager and is used to color data records. It is invoked when the user right clicks and selects a color to label the selected record(s).
  • labelItem(color);
    • color - String. Set to the color to set the currently selected record(s) to. 'blue', 'green', 'grey', 'lblue', 'orange', 'pink', 'purple', 'red', 'yellow'
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function liveUpdateCheckProgress() - This function is used by the Live Update module and is used to check and update the progress of the current update. It is called every second while an update is in progress.
  • liveUpdateCheckProgress();
    • This function takes no arguments.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function loff() - This function is responsible for hiding the progress bars that are set by the set_progress() function. If the user interface was disabled, then this function re-enables it.
  • loff();
    • This function takes no arguments.
    • This function returns nothing.
       
• function lon() - This function is responsible for showing the progress bar that is set by the set_progress() function. It can also disable the user interface until the loff() function is called.
  • lon(target);
    • target - Object. Optional. Set to either the window object or to false. If set to false, the progress bar that follows the mouse is shown. If set to the window object ( lon(window); ), then the centralized progress bar is shown and the interface is locked from receiving any input. In order to hide the progress bar again, call the loff() function.
    • This function returns nothing.
       
• function manExtraCols() - This function is used by the datamanager and is responsible for initiating the "Manage Extra Columns" wizard.
  • manExtraCols();
    • This function takes no arguments.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function modForm() - This function is used by the datamanager. It is responsible for initiating the "Modify Existing Form" wizard that allows a user to edit forms.
  • modForm();
    • This function takes no arguments.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function mouse_move() - This function displays a help floating dialog next to the mouse after a short moment.
  • mouse_move(context, width, wait);
    • context - String. Optional. If set shows the message that this string contains (HTML OK). If not set, the help is closed.
    • width - Number. Optional. The maximum width in pixels that the help box can be. If not set, then it adapts to fit the context string.
    • wait - Number. Optional. The number of miliseconds to wait before showing the floating help. If not set or set to 0, then it defaults to 500 (or half a second)
    • This function returns nothing.
       
• function mouseCoords() - This function returns the current X / Y position of the mouse.
  • var position = mouseCoords();
    • This function takes no arguments.
    • Returns - Assoc Array. Returns the {x:posX, y:posY} of the mouse.
       
• function moveHelp() - This function is responsible for updating the position of several key VConsole components when the mouse moves.
  • moveHelp(x,y);
    • x - Number. Set this to the current X mouse position.
    • y - Number. Set this to the current Y mouse position.
    • This function returns nothing.
    • This function is called every time the mouse moves.
       
• function noSelect() - This function calls the disableselect() function and is responsible for disabling HTML selection while dragging objects.
  • noSelect();
    • This function takes no arguments.
    • This function returns nothing.
    • You can re-enable select by calling the reSelect() function.
       
• function objStartDrag() - This function enables an object drag by the mouse. This function should be called on the onmousedown event.
  • objStartDrag(objID);
    • objID - String. The id attribute of the object to start dragging.
    • This function returns nothing.
       
• function objStopDrag() - This function disables object drag by the mouse. This function should be called on the onmouseup event.
  • objStopDrag();
    • This function takes no arguments.
    • This function returns nothing.
       
• function populate_permissions() - This field is responsible for populating the list of permissions for a module and is only used in th group permissions wizard interface.
  • populate_permissions(field);
    • field - Object. Set to the select drop down list object that contains the module that is selected.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function printScreen() - This function will print the current browser screen.
  • printScreen();
    • This function takes no arguments.
    • This function returns nothing.
       
• function rand() - This function takes a minimum and maximum number and returns a random whole number between those 2 numbers.
  • var num = rand(min, max);
    • min - Number. The minimum number to return
    • max - Number. The maximum number to return
    • Returns - Number. A whole number between min and max.
       
• function randomID() - This function will generate and return a random alpha-numeric id.
  • var id = randomID(size);
    • size - Number. Set to the string length of the id that you want to generate. To generate an id that is 6 characters long, set to 6.
      
    • Returns - String. A random id that has a string length of size characters.
       
• function reEnable() - This function simply returns true. It is called to re-enable HTML selection after a drag / drop operation.
  • var en = reEnable();
    • This function takes no arguments.
    • Returns - true.
       
• function refreshIframe() - This function refreshes the contents of an iframe.
  • refreshIframe(iframeName);
    • iframeName - String. The name of an iframe to refresh.
    • This function returns nothing.
       
• function reindex() - This function is used by the datamanager. It is used to perform re-index operations for all data records and is invoked from the "Search Builder" drop down menu.
  • reindex(msg);
    • msg - String. Set to a message to show the user to confirm the operation. The user gets a chance to cancel the operation.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function reindexprogress() - This function is used by the datamanager and is used to get the current progress of a re-index operation. It is invoked once a second while a re-index operation is executing.
  • reindexprogress();
    • This function takes no arguments.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function removeTinyMCEControls() - This function is used by the wizardmanager and propertiesmanager. It removes all rich text editor instances from all <textarea> objects that have been transformed using the addTinyMCEControl() function.
  • removeTinyMCEControls();
    • This function takes no arguments.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
    • IMPORTANT: You must call this function before deleting or replacing any <textarea> objects that have been transformed using the addTinyMCEControl() function.
       
• function RemSearch() - This function is used by the datamanager and is used to remove search conditions. It is invoked when the user clicks on the small remove icon next to a search condition.
  • RemSearch(obj, searchid);
    • obj - Object. Set to the span object that encloses the small search delete button.
    • searchid - Number. Set to the search condition id to delete as found in the vc_searches table.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function reSelect() - This function re-enables HTML selection ability after a drag / drop operation. Or after noSelect() or disableselect() have been called.
  • reSelect();
    • This function takes no arguments.
    • This function returns nothing.
       
• function rowHighlight() - This function is used in the datamanager and is responsible for checking a record row.
  • rowHighlight(tr);
    • tr - Object. Set to the record row object to check.
    • This function returns nothing.
       
• function rowToggleHighlight() - This function is used in the datamanager and is responsible for either checking or unchecking a record row. If the row is checked, it will uncheck it, otherwise it will check it.
  • var ischecked = rowToggleHighlight(tr);
    • tr - Object. Set to the record row object to toggle check on.
    • Returns - Bool. Returns 0 if the record got unchecked or 1 if the record got checked.
       
• function rowUnhighlight() - This function is used in the datamanager and is responsible for unchecking a record row.
  • rowUnhighlight(tr);
    • tr - Object. Set to the record row object to uncheck.
    • This function returns nothing.
       
• function RP_confirm() - This function will show the user a confirmation message, then if the user clicks OK, either a form is submitted or the browser is directed to a URL.
  • RP_confirm(uRl, fOrm, mSg);
    • uRl - String. Optional. Should be set to the URL to go to if the user clicks OK. (Only uRl or fOrm should be set. Not both)
    • fOrm - Object. Optional. Should be set to the form object to submit if the user clicks OK.
    • mSg - String. Should be set to the message to show to the user.
    • This function returns nothing.
      
      
• function RP_getindwindow() - This function opens up a new popup window. Unlike the RP_getwindow() function, this function does not close any windows that were previously opened with this function.
  • RP_getindwindow(uRl, width, height);
    • uRl - String. Should be set to the url that will be opened up in the new window.
    • width - Number. The width of the window in pixels.
    • height - Number. The height of the window in pixels.
    • This function returns nothing.
       
• function RP_getScroll() - This function returns the current scroll position for the browser window.
  • var scroll = RP_getScroll();
    • This function takes no arguments.
    • Returns - Array. The current [X, Y] scroll positions in pixels.
        
• function RP_getwindow() - This function opens up a new popup window. If any windows are open that were opened using this function, they are first closed before the new window is opened.
  • RP_getwindow(uRl, width, height);
    • uRl - String. Should be set to the url that will be opened up in the new window.
    • width - Number. The width of the window in pixels.
    • height  - Number. The height of the window in pixels.
    • This function returns nothing.
       
• function SaveSearchAs() - This function is used by the datamanager and is responsible for saving the currently applied search. It is invoked from the "Search Builder" drop down menu.
  • SaveSearchAs(msg, nomsg);
    • msg - String. Set to the message to show the user that prompts them to name the new search.
    • nomsg - String. Set to the message to show the user if there are currently no search fields set so the search cannot be saved.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function saveview() - This function is used by the datamanager and is responsible for saving the user's current view and column setup as a new view. Invoked when the user selects "Save Current View As" from the "View" drop down menu.
  • saveview(msg);
    • msg - String. Set to a message to show the user that should instruct them to enter a name for the new view.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function scheck() - This function is used to set all checkboxes in a form to the same state of another checkbox.
  • scheck(form, box);
    • form - Object. Should be set to the form object that contains all the checkboxes to check or uncheck.
    • box - Object. Should be set to the master checkbox so set all the other checkbox states as.
    • This function returns nothing.
       
• function searchTips() - This function is used by the datamanager and is invoked when the user clicks on the "Search Tips" link next to a text search field. When invoked, search tips are shown to the user.
  • searchTips();
    • This function takes no arguments.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function selColor() - This function is used in wizardmanager and propertiesmanager forms for the color selector field. This function is called when a color selector field receives focus and is responsible for displaying the color selector interface to the user.
  • selColor(shfield, field, type, callback);
    • shfield - Object. Set to the text field object that should show the RGB color results, not the color code.
    • field - Object. Set to the hidden text field object that receives the selected color code.
    • type - String. Set to websafe or smooth. This determines what type of color selector interface to show to the user.
    • callback - String. Set to javascript to execute once the user has selected a color.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function selectorClose() - This function is used by the wizardmanager and propertiesmanager and, when invoked will close a Selector interface from a selector field without populating the field values. It's like canceling the selection.
  • selectorClose();
    • This function takes no arguments.
    • This function returns nothing.
       
• function selectorSHOW() - This function is used by the wizardmanager and propertiesmanager and is responsible for showing a datamanager selector interface for a selector field.
  • selectorSHOW(shfld, valfld, module, sh, val);
    • shfld - Object. The text field object that should get the Show Field text when the user has selected a record.
    • valfld - Object. The hidden text field object that should get the Value Field text when the user has selected a record.
    • module - String. The name of the module to select records from
    • sh - String. The name of the MySQL field that should contain the Show field.
    • val - String. The name of the MySQL field that should contain the Value field.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function selectview() - This function is used by the datamanager and is responsible for setting the user's current view. It is invoked from the "View" dropdown menu.
  • selectview(vid);
    • vid - Number. Set to the View id as in the vc_data-views table. The view must belong to the currently logged in user.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function selLabel() - This function is used by the datamanager and is used to select all data records of a certain color.
  • selLabel(color);
    • color - String. Optional. If set should be set to the color of records that you want to select. If not set or set to an empty string, all records that have no color are selected. 'blue', 'green', 'grey', 'lblue', 'orange', 'pink', 'purple', 'red', 'yellow'
    • This function returns nothing.
       
• function set_progress() - This function is used to set the percentage done of the hovering progress bar. This does not show the progress bar. It only sets the current progress.
  • set_progress(done);
    • done - Number. Should be set between 0 and 100 and should reflect the done percentage that the progress bar should show.
    • This function returns nothing.
       
• function setColor() - This function is used in wizardmanager and propertiesmanager forms for the color selector field. This function is called when the user selects a color from the color selector interface.
  • setColor(hval);
    • hval - String. Set to the 6 character color code to set for the color selector field.
    • This function returns nothing.
    • This function executes the javascript that was set in the callback argument when the selColor() function is called.
       
• function setColWidth() - This function is used by the datamanager. In a column resize operation, this function is responsible for setting the column to the new size
  • setColWidth(line, width);
    • line - String. Should be the contents of the line attribute for the <th> column that is being resized.
    • width - Number. The new width of the column in pixels.
    • This function returns nothing.
       
• function setDefaultViewLayout() - This function is used by the datamanager. It sets the user's view and column layout to the default layout.
  • setDefaultViewLayout();
    • This function takes no arguments.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function setDisplay() - This function is used by the datamanager and is used to set the current user's display type.
  • setDisplay(num);
    • num - Number. Set to the display type number to set.
      • 0 - Set to list display type
      • 1 - Set to icon display type
      • 2 - Set to calendar display type
      • 3 - Set to chart display type
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function setIframeHeight() - This function sets the height of an iframe to the height of the document object that is located within the iframe. It makes it so that your iframe is the correct height so that it does not have any vertical scrollbars.
  • setIframeHeight(iframeName);
    • iframeName - String. The name of an iframe to set the height of.
    • This function returns nothing.
       
• function setSelector() - This function is used by the wizardmanager or propertiesmanager. It sets the input values on a selector field when the user has selected a record from the datamanager selector interface.
  • setSelector();
    • This function takes no arguments.
    • This function returns nothing.
       
• function setsign() - This function is used in the document management module for document signing. It saves the current canvas data to a hidden field so that it can be submitted to the server. (It does not actually submit to the server)
  • setsign(page);
    • page - Number. The document page number that the canvas ink should be saved to.
    • This function returns nothing.
       
• function setViewLayout() - This function is used by the datamanager. It sets the user's view and column layout to the layout specified.
  • setViewLayout(layout);
    • layout - String. Set to the name of the layout that you want to set for the user's view and column layout.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function shift_check() - This function is used in the datamanager and is responsible for initiating the shift - checking (or unchecking) of a range of record checkboxes.
  • shift_check(tr);
    • tr - Object. Set to the object of the record row that contains the end record to check.
    • This function returns nothing.
       
• function shift_down() - This function is used to set a variable that determines whether or not the "Shift" key is pressed. This function is used in shift - check operations when checking or unchecking a range of record checkboxes.
  • shift_down(e);
    • e - Event. Set to the document.onkeydown event.
    • This function returns nothing.
    • This function is called automatically every time a key is pressed.
       
• function shift_up() - This function is used to unset a variable that determines whether or not the "Shift" key is pressed.
  • shift_up(e);
    • e - Event. Set to the document.onkeyup event.
    • This function returns nothing.
    • This function is called automatically every time a key is released.
       
• function showDetails() - This function is used by the datamanager. It shows the details of the currently selected record to the user. (Only a single record must be selected) It is invoked when the user right clicks on a record and selects "Show Details"
  • showDetails();
    • This function takes no arguments.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function ShowRows() - This function will unhide any HTML object that has an id attribute assigned to it. It is used in various places in the application.
  • ShowRows(trID);
    • trID - String. Should be set to the id (value of the id attribute) of the object to show.
    • This function returns nothing.
       
• function showTab() - This function is used in the propertiesmanager and is responsible for setting the current tab along with all the corresponding form fields.
  • showTab(o);
    • o - Object. The tab object to show
    • This function returns nothing
       
• function signdoc() - This function is used in the document management module for document signing. When called, the current signature on the canvas is saved.
  • signdoc(page);
    • page - Number. The document page number to save the canvas ink to.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function signmo() - This is used in the document management module for document signing. It enables the mouse to draw inside the canvas object which is placed above the document image.
  • signmo();
    • This function takes no arguments.
    • This function returns nothing.
       
• function startColDrag() - This function is used by the datamanager and is responsible for starting a column drag and drop operation.
  • startColDrag(col, e);
    • col - Object. The <th> column header object.
    • e - Event. The onmousedown event.
    • This function returns nothing.
       
• function startHighlight() - This function is used in the datamanager and checks rows as you mouse over them while the mouse button is down.
  • startHighlight(tr);
    • tr - Object. Set to the record row object for the row to start the check process on.
    • This function returns nothing.
       
• function suboption() - This function is used by the wizardmanager and propertiesmanager. It is used on choicebuilder fields and is responsible for removing a choice from the end of the choice list. Invoked when a user clicks the "Remove Option" button.
  • suboption();
    • This function takes no arguments.
    • This function returns nothing.
       
• function SwitchPass() - This function shows and hides sensitive data. Can be used to show and hide credit card numbers or other sensitive data.
  • SwitchPass(idnum);
    • idnum - String. The value of the id attribute for the locked data span or the span that shows ****.
      • The span object that has the real data should have a style display set to none and should have an id of 'r_'+idnum
    • This function returns nothing.
       
• function Toggle() - This function is used to show and hide any HTML object that has an id attribute assigned to it. It is used at various places in the application.
  • Toggle(sHow, trName);
    • sHow - Bool. Should be set to true or false. If set to true, then the object is shown. If set to false, the object is hidden.
    • trName - String. Should be set to the id (value of the id attribute) of the object to hide or show.
    • This function returns nothing.
       
• function toggle_modules() - This function is responsible for expanding and collapsing the top navigation bar. It is invoked when the user clicks on the expand / collapse button. If it is collapsed, it expands. If it is expanded, it collapses.
  • toggle_modules(i);
    • i - Object. Set to the modules div object.
    • This function returns nothing.
       
• function tree_select() - This function is used by the wizardmanager and propertiesmanager to select / unselect tree branches or nodes in a tree field.
  • tree_select(treeid, branchid);
    • treeid - String. The treeid of the tree as in the vc_trees table. (treeid field)
    • branchid - Number. The id of the branch to expand as in the vc_trees table. (id field)
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function treeMenu() - This function is used by the wizardmanager and propertiesmanager to show a developer defined right click menu when the user right clicks on a tree branch or node in a tree field. The menu is defined in the wizardmanager or propertiesmanager data structure php array.
  • treeMenu(event, treeid, branchid);
    • event - Event. The right click event (oncontextmenu event)
    • treeid - String. The treeid of the tree as in the vc_trees table. (treeid field)
    • branchid - Number. The id of the branch to expand as in the vc_trees table. (id field)
    • This function returns nothing.
       
• function update_permissions() - This function is only used in the group permissions wizard. It is used to update the permission list for a module.
  • update_permissions();
    • This function takes no arguments.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function updateColWidth() - This function is used by the datamanager. In a column resize operation, this function is responsible for notifying the database of the new column width.
  • updateColWidth(col, width);
    • col - Number. The id of the column as in the vc_data-views table.
    • width - Number. The new width of the column in pixels.
       
• function updateColumn() - This function is used by the datamanager and is responsible for updating the behavior or alignment of a column.
  • updateColumn(action);
    • action - String. Set this to the action that you want to perform on the column.
      • E - Expand column
      • W - Wrap column
      • T - Hide column overflow
      • left - Set left horizontal alignment
      • right - Set right horizontal alignment
      • center - Set center horizontal alignment
      • top - Set top vertical alignment
      • bottom - Set bottom vertical alignment
      • middle - Set middle vertical alignment
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function updateDataTable() - This function is used by the datamanager and is used to update the data records when the user changes something.
  • updateDataTable(updatemenus);
    • updatemenus - String. Set to an empty string or to '1'. If set to '1' then the menu system is updated. Used when a menu should change like when a search is saved and the new search needs to be added to the menu.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function updateEditField() - This function is used by the datamanager and is used to update the value of a field when performing an inline edit operation.
  • updateEditField();
    • This function takes no arguments.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function updateImportProgress() - This function is used by the wizardmanager and is used to update the import progress when the user is importing from CSV. It is called every second while the import is in progress.
  • updateImportProgress();
    • This function takes no arguments.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
      
• function updateToolTipPos() - This function updates the hover tooltip help whenever the mouse moves.
  • updateToolTipPos(X, Y);
    • X - Number. The current mouse X position.
    • Y - Number. The current mouse Y position.
    • This function returns nothing.
    • This function is called every time the mouse moves.
       
• function updateWizardFileProgress() - This function is used by the wizardmanager and propertiesmanager and is responsible for updating the file upload progress. It is called every second while files are uploading.
  • updateWizardFileProgress();
    • This function takes no arguments.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function uploadWizardFiles() - This function is used by the wizardmanager and propertiesmanager and is responsible for starting the file upload.
  • uploadWizardFiles();
    • This function takes no arguments.
    • This function returns nothing.
       
• function updateWizardManager() - This function is used by the wizardmanager and propertiesmanager and is responsible for submitting and building the wizardmanager and propertiesmanager interfaces.
  • updateWizardManager(nolon);
    • nolon - Bool. If true, then no progress bar is shown. If false (default) then the progress bar is shown.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function vsMenuActivate() - This function activates a menu item and is called when a user hovers over a menu item in a drop down menu.
  • vsMenuActivate(target);
    • target - Object. The target menu item to activate.
    • This function returns nothing.
       
• function vsMenuCancelTimeout() - This function cancels the timeout that is set by the vsMenuStartTimeout() function when a user's mouse leaves a menu. This is invoked when a user's mouse goes back over the menu after leaving it.
  • vsMenuCancelTimeout();
    • This function takes no arguments.
    • This function returns nothing.
       
• function vsMenuFindPos() - This function returns the current x and y position for a drop down menu (Actually can be any object)
  • var menupos = vsMenuFindPos(obj);
    • obj - Object. The menu object to find the position of.
    • Returns - Array. Returns the [X, Y] position of the object specified by obj
       
• function vsMenuHide() - This function is responsible for hiding a drop down menu.
  • vsMenuHide(menuid);
    • menuid - String. The id attribute of the menu to hide.
    • This function returns nothing.
       
• function vsMenuHideAll() - This function is responsible for hiding all drop down cascading menus and all sub menus.
  • vsMenuHideAll();
    • This function takes no arguments.
    • This function returns nothing.
       
• function vsMenuHideSubs() - This function hides all sub menus in a drop down cascading menu.
  • vsMenuHideSubs(menuid);
    • menuid - String. The id attribute of the menu to hide all sub menus of.
    • This function returns nothing.
       
• function vsMenuSetNotActive() - This function sets a drop down menu item to not active.
  • vsMenuSetNotActive(menuid);
    • menuid - String. The id attribute of the menu item to set to not active.
    • This function returns nothing.
       
• function vsMenuShow() - This function shows a drop down cascading menu. The menu has to already be built and has to exist in the current menu area.
  • vsMenuShow(menuid, target, where, activate);
    • menuid - String. The id attribute of the menu to show.
    • target - Object. Optional. Set to the object where you want to show the menu. If not set, then the menu is shown at the current mouse position
    • where - String. Optional. Determines where the menu is shown in relation to the target or mouse. Set to bottom or right
    • activate - Bool. Optional. Used only internally for cascading drop down menus. It activates the menu item specified by target if it is a menu item.
    • This function returns nothing.
       
• function vsMenuShowRightClickMenu() - This function is responsible for showing a right click menu at the current mouse position. The menu has to already be built and has to exist in the current menu area.
  • vsMenuShowRightClickMenu(menuid);
    • menuid - String. The id attribute of the menu to show.
    • This function returns nothing.
       
• function vsMenuStartTimeout() - This function is invoked when a user's mouse leaves a menu. It sets a timeout that hides the menu if the user doesn't move their mouse back over the menu within a short period of time.
  • vsMenuStartTimeout(menuid);
    • menuid - String. The id attribute of the menu to start the timeout on.
    • This function returns nothing.
       
• function vsUpdateMenu() - This function updates the menu items inside a drop down menu.
  • vsUpdateMenu(menu, code);
    • menu - String. The id attribute of the menu to update.
    • code - String. HTML code that will replace the current contents of the menu.
    • This function returns nothing.
       
• function wizardCancelFileUpload() - This function is used by the wizardmanager and propertiesmanager and is responsible for canceling a file upload operation. Invoked when the user clicks on "Cancel" during a file upload.
  • wizardCancelFileUpload();
    • This function takes no arguments.
    • This function returns nothing.
    • This function initiates AJAX. When this function returns, it does not mean that the task is complete as AJAX may still be working in the background.
       
• function wmdivClose() - This function is used in a datamanager action when that action is a wizardmanager or propertiesmanager formatted action. This function closes the floating div that contains the wizardmanager or propertiesmanager interface.
  • wmdivClose();
    • This function takes no arguments.
    • This function returns nothing.