AjaxHelper 0.4 Reference

You can read the articles below to get more intruductions about AjaxHelper:

.Net环境下基于Ajax的MVC方案
AjaxHelper使用范例
发布AjaxHelper0.3和AjaxHelperExample2
支持SPS的AjaxHelper 0.4，无刷新WebPart开发从此变得简单

****************************************************************************************************
AjaxHelper 0.4 Reference
Copyright 2005 by Teddy <shijie.ma(at)gmail.com> (http://blog.teddy.cn)
Last Modified: 2005/06/20
****************************************************************************************************

Main Functions
--------------------------

1. function Updater(ajaxTemplate, output, params, onComplete)

   Description:
     Callback the specified UserControl, if needed replace the innerHTML of the element specified by output and call onComplete function. this function cannot be used in webpart.

   Params:
     ajaxTemplate[needed]: the UserControl's Name with relative path.
     output[optional]: the specified return element, this element must have innerHTML property, you can pass this param either the element id as string or the direct object ref.
     params[optional]: the params to be send to ajaxTemplate.
     onComplete[optional]: custom function ref for dealing with the return content of this callback, in format like function(content){}.

---

2. function Appender(ajaxTemplate, output, direction, params, onComplete)

   Description:
     Callback the specified UserControl, if needed append the element specified by output and call onComplete function. this function cannot be used in webpart.

   Params:
     ajaxTemplate[needed]: the UserControl's name with relative path.
     output[needed]: the specified return element, this element must have innerHTML property, you can pass this param either the element id as string or the direct object ref.
     direction[needed]: the position to append the content, the value can be one of "beforeBegin", "afterBegin", "beforeEnd" or"afterEnd".
     params[optional]: the params to be send to ajaxTemplate.
     onComplete[optional]: custom function ref for dealing with the return content of this callback, in format like function(content){}.

---

3. function SerializeForm(form)

   Description:
     seralize a form to the format like "param1=v1&param2=v2&param3=v3...".

   Params:
     form[needed]: the specified form name or form's object ref

---

4. function Inserter(element, direction, content)

   Description:
     append the element with the specified content at position specified by direction.

   Params:
     element[needed]: the specified base element to append to.property, you can pass this param either the element id as string or the direct object ref.
     direction[needed]: the position to append the content, the value can be one of "beforeBegin", "afterBegin", "beforeEnd" or"afterEnd".
     content[needed]: the content to be appended.

---

5. function WebPartUpdater(ajaxTemplate, output, params, onComplete);

   Description:
     Callback the specified UserControl, if needed replace the innerHTML of the element specified by output and call onComplete function. this function can be used in webpart only.

   Params:
     ajaxTemplate[needed]: the UserControl's Name with relative path.
     output[optional]: the specified return element, this element must have innerHTML property, you can pass this param either the element id as string or the direct object ref.
     params[optional]: the params to be send to ajaxTemplate.
     onComplete[optional]: custom function ref for dealing with the return content of this callback, in format like function(content){}.

---

6. function WebPartAppender(ajaxTemplate, output, direction, params, onComplete)

   Description:
     Callback the specified UserControl, if needed append the element specified by output and call onComplete function. this function can be used in webpart only.

   Params:
     ajaxTemplate[needed]: the UserControl's Name with relative path.
     output[needed]: the specified return element, this element must have innerHTML property, you can pass this param either the element id as string or the direct object ref.
     direction[needed]: the position to append the content, the value can be one of "beforeBegin", "afterBegin", "beforeEnd" or"afterEnd".
     params[optional]: the params to be send to ajaxTemplate.
     onComplete[optional]: custom function ref for dealing with the return content of this callback, in format like function(content){}.

---

Utility Functions
------------------------

1. function PeriodicalExecuter(callback, frequency)

   Description:
     Periodically Execut the specified callback function in the specified frequency.

   Params:
     callback[needed]: the specified callback function.
     frequency[needed]: the specified frequency.

2. function $()

   Description:
     return the element list specified by the id names of these elements

   Params:
     the params' count can be one or more, must be the id names of your needed elements.

3. String.lTrim
   String.rTrim
   String.trim
   String.endsWith
   String.startsWith
   String.format
   String.removeSpaces
   String.removeExtraSpaces
   String.isEmpty
   String.isEmail
   String.isAlphaNumeric
   String.encodeURI
   String.decodeURI
   Array.indexOf
   Array.exists
   Array.queue
   Array.dequeue
   Array.removeAt
   Array.remove
   Array.clear
   Array.addArray

   Description:
     these functions is like theirs in c# and vb.