Catglobe Wiki - User contributions [en]

Int class

2018-07-11T03:00:07Z

Dennis: Redirected page to Number class

#REDIRECT [[Number_class]]

Color class

2018-07-11T02:59:10Z

Dennis:

{{CGscriptClass_Template
|Name=<nowiki>Color</nowiki>
|Description=<nowiki>Represents a color.</nowiki>
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>value</nowiki>|Description=<nowiki>Value of color</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>ishtmlHex</nowiki>|Description=<nowiki>If true, parse as html style hex, otherwise parse as system named color</nowiki>}}
|Description=<nowiki>Create color from name</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=Color|Name=<nowiki>color</nowiki>|Description=<nowiki>Base color</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>alpha</nowiki>|Description=<nowiki>Alpha part</nowiki>}}
|Description=<nowiki>Create alpha color from existing color</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>red</nowiki>|Description=<nowiki>Red part</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>green</nowiki>|Description=<nowiki>Green part</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>blue</nowiki>|Description=<nowiki>Blue part</nowiki>}}
|Description=<nowiki>Create color from rgb</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>red</nowiki>|Description=<nowiki>Red part</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>green</nowiki>|Description=<nowiki>Green part</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>blue</nowiki>|Description=<nowiki>Blue part</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>alpha</nowiki>|Description=<nowiki>Alpha part</nowiki>}}
|Description=<nowiki>Create color from rgb</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=object|Name=<nowiki>this[] { get; }</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>index</nowiki>|Description=<nowiki>Index</nowiki>}}
|Description=<nowiki>Backward-compatible indexer</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>this[] { set; }</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>index</nowiki>|Description=<nowiki>Index</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=object|Name=<nowiki>value</nowiki>|Description=<nowiki>Value to set</nowiki>}}
|Description=<nowiki>Backward-compatible indexer</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Alpha</nowiki>|HasGetter=1|Description=<nowiki>Get alpha part of color</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Blue</nowiki>|HasGetter=1|Description=<nowiki>Get blue part of color</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Green</nowiki>|HasGetter=1|Description=<nowiki>Get green part of color</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>HtmlRgbaHex</nowiki>|HasGetter=1|Description=<nowiki>Get the #xxxxxxxx html encoding of colors</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>HtmlRgbHex</nowiki>|HasGetter=1|Description=<nowiki>Get the #xxxxxx html encoding of colors</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Red</nowiki>|HasGetter=1|Description=<nowiki>Get red part of color</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
|StaticMethods=
{{CGscriptMethods_Template|ReturnType=Color|Name=<nowiki>Color_getByName</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>System color name</nowiki>}}
|Description=<nowiki>Create new color object</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Color|Name=<nowiki>Color_getByRGB</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>htmlhex</nowiki>|Description=<nowiki>html encoded color</nowiki>}}
|Description=<nowiki>Create new color object</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Color|Name=<nowiki>Color_getByRGB</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>red</nowiki>|Description=<nowiki>Red part</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>green</nowiki>|Description=<nowiki>Green part</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>blue</nowiki>|Description=<nowiki>Blue part</nowiki>}}
|Description=<nowiki>Create new color object</nowiki>}}
}}

Template:CGscriptClass Template

2018-07-11T02:58:06Z

Dennis: Added static methods

<noinclude>''' THIS IS A TEMPLATE - IT'S BACKUP VERSION IN PAGE: [[{{FULLPAGENAME}}/backup]] '''</noinclude>
={{{Name|PLEASE INSERT CLASS NAME HERE}}} =
<includeonly>[[Category:Classes]]</includeonly>
__NOTOC__
__NOEDITSECTION__

{{{Description|}}}
{{#if: {{{Constructors|}}} | ==='''Constructors'''=== }}
{{{Constructors|}}}
{{#if: {{{Methods|}}} | ==='''Methods'''=== }}
{{{Methods|}}}
{{#if: {{{Properties|}}} | ==='''Properties'''=== }}
{{{Properties|}}}
{{#if: {{{StaticMethods|}}} | ==='''Static Methods'''=== }}
{{{StaticMethods|}}}

SendBulkMail

2017-05-30T08:13:32Z

Dennis: /* sendBulkMail */

[[Category:Email_and_SMS_Functions]]
{{HelpFiles}}

==== sendBulkMail ====

Send a bulk mail specified by its id.

'''Syntax'''

sendBulkMail(''bulkMailId''[,''MaxToSend''[, schedule]])

'''Arguments'''

''bulkMailId:'' Is a numeric (non-decimal) expression. It is the id of the bulk mail.

''maxToSend:'' Is a numeric (non-decimal) expression. It is the max email which send. -1 to send to all.

''schedule:'' Use the given schedule to send the mails see [[CatTaskInstantSchedule class]], defaults to instant.

'''Return type'''

empty

'''Example'''

sendBulkMail(1);

sendBulkMail(1,20); // 20 is max number email

sendBulkMail(1,20, new CatTaskSpecificTimeSchedule(new DateTime({...}));

'''Availability'''

Version 6.0. maxSend from Nov. 2016, schedule from June 2017.

__NOTOC__

SendBulkMail

2017-05-30T08:02:22Z

Dennis: Add 3rd param

[[Category:Email_and_SMS_Functions]]
{{HelpFiles}}

==== sendBulkMail ====

Send a bulk mail specified by its id.

'''Syntax'''

sendBulkMail(''bulkMailId''[,''MaxToSend''[, schedule]])

'''Arguments'''

''bulkMailId:'' Is a numeric (non-decimal) expression. It is the id of the bulk mail.

''maxToSend:'' Is a numeric (non-decimal) expression. It is the max email which send. -1 to send to all.

''schedule:'' Use the given schedule to send the mails see [[CatTaskInstantSchedule class]], defaults to instant.

'''Return type'''

empty

'''Example'''

sendBulkMail(1);

sendBulkMail(1,20); // 20 is max number email

'''Availability'''

Version 6.0.

__NOTOC__

File:API.png

2015-11-12T07:53:58Z

Dennis: MsUpload

MsUpload

DataCacheSpecificationWeightColumn class

2014-03-28T08:32:18Z

Dennis:

{{CGscriptClass_Template
|Name=<nowiki>DataCacheSpecificationWeightColumn</nowiki>
|Description=<nowiki>Represents a DataCache specifications weight column.</nowiki>
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>Attach weight to this dcs.</nowiki>}}
|Description=<nowiki>Instanciate a new weight column.</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>Attach weight to this dcs.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of the existing weight column.</nowiki>}}
|Description=<nowiki>Get existing new weight column.</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Delete</nowiki>|Description=<nowiki>Removes the weight from the DCS.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>GetCategories</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>variable</nowiki>|Description=<nowiki>Variable name.</nowiki>}}
|Description=<nowiki>Get the ids and names of the possible categories.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>GetCurrentNumber</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>variable</nowiki>|Description=<nowiki>Variable name.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=<nowiki>category</nowiki>|Description=<nowiki>Category id.</nowiki>}}
|Description=<nowiki>Get the calculated weight number for a variable's category.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>GetTarget</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>variable</nowiki>|Description=<nowiki>Variable name.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=<nowiki>category</nowiki>|Description=<nowiki>Category id.</nowiki>}}
|Description=<nowiki>Get the target for a variable's category.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>MoveTargetsToDifferentVariable</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>from</nowiki>|Description=<nowiki>Variable name.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>to</nowiki>|Description=<nowiki>Variable name.</nowiki>}}
|Description=<nowiki>Move the current numbers and targets to another variable.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RemoveVariable</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>variable</nowiki>|Description=<nowiki>Variable name.</nowiki>}}
|Description=<nowiki>Remove a variable from the calculation.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save the weight after validation into the dcs and recalculate weight. Return value is a dictionary of all the variable values, weight values, modified sum (all arrays of numbers) and the log (string).</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetTarget</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>variable</nowiki>|Description=<nowiki>Variable name.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=<nowiki>category</nowiki>|Description=<nowiki>Category id.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=<nowiki>target</nowiki>|Description=<nowiki>Target to set for the weight.</nowiki>}}
|Description=<nowiki>Set the target for a variable's category.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>UpdateCurrents</nowiki>|Description=<nowiki>Fetch the count of rows matching the categories of the current selected variables.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>Validate</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=bool|Name=<nowiki>includeWarnings</nowiki>|Description=<nowiki>Should validation also return warnings or not.</nowiki>}}
|Description=<nowiki>Validate the current configuration. Returns first error message, or Empty if no error.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>MaxIteration</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set MaxIteration before stopping calculation.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>MaxWeight</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set how large the largest weight can become.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>MinDeviation</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the minimum deviation before weight is considered stable.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>MinWeight</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set how small the smallest weight can become.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set Name.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=List of strings|Name=<nowiki>PossibleVariables</nowiki>|HasGetter=1|Description=<nowiki>List the variables available in the DCS.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=List of strings|Name=<nowiki>SelectedVariables</nowiki>|HasGetter=1|Description=<nowiki>List the current variables used to calculate this weight.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>TotalNumber</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the sum that the weight should add up to.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

DataCacheSpecificationWeightColumn class

2014-03-28T08:28:32Z

Dennis: Created page with "{{CGscriptClass_Template |Name=<nowiki>DataCacheSpecificationWeightColumn</nowiki> |Description=<nowiki>Represents a DataCache specifications weight column.</nowiki> |Construc..."

{{CGscriptClass_Template
|Name=<nowiki>DataCacheSpecificationWeightColumn</nowiki>
|Description=<nowiki>Represents a DataCache specifications weight column.</nowiki>
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>Attach weight to this dcs.</nowiki>}}
|Description=<nowiki>Instanciate a new weight column.</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>Attach weight to this dcs.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of the existing weight column.</nowiki>}}
|Description=<nowiki>Get existing new weight column.</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Delete</nowiki>|Description=<nowiki>Removes the weight from the DCS.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Unknown|Name=<nowiki>GetCategories</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>variable</nowiki>|Description=<nowiki>Variable name.</nowiki>}}
|Description=<nowiki>Get the ids and names of the possible categories.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>GetCurrentNumber</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>variable</nowiki>|Description=<nowiki>Variable name.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=<nowiki>category</nowiki>|Description=<nowiki>Category id.</nowiki>}}
|Description=<nowiki>Get the calculated weight number for a variable's category.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>GetTarget</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>variable</nowiki>|Description=<nowiki>Variable name.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=<nowiki>category</nowiki>|Description=<nowiki>Category id.</nowiki>}}
|Description=<nowiki>Get the target for a variable's category.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>MoveTargetsToDifferentVariable</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>from</nowiki>|Description=<nowiki>Variable name.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>to</nowiki>|Description=<nowiki>Variable name.</nowiki>}}
|Description=<nowiki>Move the current numbers and targets to another variable.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RemoveVariable</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>variable</nowiki>|Description=<nowiki>Variable name.</nowiki>}}
|Description=<nowiki>Remove a variable from the calculation.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save the weight after validation into the dcs and recalculate weight. Return value is a dictionary of all the variable values, weight values, modified sum (all arrays of numbers) and the log (string).</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetTarget</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>variable</nowiki>|Description=<nowiki>Variable name.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=<nowiki>category</nowiki>|Description=<nowiki>Category id.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=<nowiki>target</nowiki>|Description=<nowiki>Target to set for the weight.</nowiki>}}
|Description=<nowiki>Set the target for a variable's category.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>Validate</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=bool|Name=<nowiki>includeWarnings</nowiki>|Description=<nowiki>Should validation also return warnings or not.</nowiki>}}
|Description=<nowiki>Validate the current configuration. Returns first error message, or Empty if no error.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>MaxIteration</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set MaxIteration before stopping calculation.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>MaxWeight</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set how large the largest weight can become.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>MinDeviation</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the minimum deviation before weight is considered stable.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>MinWeight</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set how small the smallest weight can become.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set Name.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=Unknown|Name=<nowiki>PossibleVariables</nowiki>|HasGetter=1|Description=<nowiki>List the variables available in the DCS.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=Unknown|Name=<nowiki>SelectedVariables</nowiki>|HasGetter=1|Description=<nowiki>List the current variables used to calculate this weight.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>TotalNumber</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the sum that the weight should add up to.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

QAS new

2012-02-13T10:38:12Z

Dennis: /* QAS_new */

{{HelpFiles}}

==== QAS_new ====

Create a questionnaire answer sheet object

'''Syntax'''

QAS_new(''questionnaireResourceId, userResourceId'')

or

QAS_new(''questionnaireResourceId'')

'''Arguments'''

*''questionnaireResourceId'': is a ''number ''expression. It is the questionnaire's resource id
*''userResourecId'': is a ''number ''expression. It is the user's resource id

'''Return value'''

An array, it is a questionnaire answer sheet object, which contains the following items:

{| cellspacing="0" cellpadding="2" border="1" width="875" style="border-collapse:collapse; border:1px solid #010101" class="tableintopic"
|- align="left" valign="top"
| bgcolor="#C0C0C0" width="292" style="border:1px solid #010101;" |
'''Index'''

| bgcolor="#C0C0C0" width="116" style="border:1px solid #010101;" |
'''Data type'''

| bgcolor="#C0C0C0" width="467" style="border:1px solid #010101;" |
'''Value'''

|- align="left" valign="top"
| width="292" style="border:1px solid #010101;" |
QAS_ID

| width="116" style="border:1px solid #010101;" |
number

| width="467" style="border:1px solid #010101;" |
Primary key

|- align="left" valign="top"
| width="292" style="border:1px solid #010101;" |
QAS_QUESTIONNAIRE_RESOURCE_ID

| width="116" style="border:1px solid #010101;" |
number

| width="467" style="border:1px solid #010101;" |
Questionnaire's resource id

|- align="left" valign="top"
| width="292" style="border:1px solid #010101;" |
QAS_USER_RESOURCE_ID

| width="116" style="border:1px solid #010101;" |
number

| width="467" style="border:1px solid #010101;" |
User's resource id

|- align="left" valign="top"
| width="292" style="border:1px solid #010101;" |
QAS_TEST

| width="116" style="border:1px solid #010101;" |
bool

| width="467" style="border:1px solid #010101;" |
If it is a test answer sheet

|- align="left" valign="top"
| width="292" style="border:1px solid #010101;" |
QAS_STATUS

| width="116" style="border:1px solid #010101;" |
number

| width="467" style="border:1px solid #010101;" |
Questionnaire answer sheet's status, it should be compared to/assigned with defined constants 

(see getRPQStatus function for more information)

|- align="left" valign="top"
| width="292" style="border:1px solid #010101;" |
QAS_COMPLETED

| width="116" style="border:1px solid #010101;" |
bool

| width="467" style="border:1px solid #010101;" |
If the answer sheet is completed

|- align="left" valign="top"
| width="292" style="border:1px solid #010101;" |
QAS_STARTDATE

| width="116" style="border:1px solid #010101;" |
array

| width="467" style="border:1px solid #010101;" |
Start date

|- align="left" valign="top"
| width="292" style="border:1px solid #010101;" |
QAS_ENDDATE

| width="116" style="border:1px solid #010101;" |
array

| width="467" style="border:1px solid #010101;" |
End date

|- align="left" valign="top"
| width="292" style="border:1px solid #010101;" |
QAS_CATI_APPOINTMENT

| width="116" style="border:1px solid #010101;" |
array

| width="467" style="border:1px solid #010101;" |
Next contact datetime

|- align="left" valign="top"
| width="292" style="border:1px solid #010101;" |
QAS_CATI_LIST_TYPE

| width="116" style="border:1px solid #010101;" |
number

| width="467" style="border:1px solid #010101;" |
1: CATI_MAIN, 2: CATI_ONGOING, 3: CATI_APPOINMENT, 4: CATI_FINISHED, 5: CATI_RETRY
NOTE! If the QAS is actually part of a CATI run, then this item should only be updated when the value is CATI_FINISHED, or when the CATI is not running, otherwise the CATI system may get confused.
|- align="left" valign="top"
| width="292" style="border:1px solid #010101;" |
QAS_CATI_TIMES_CALLED

| width="116" style="border:1px solid #010101;" |
number

| width="467" style="border:1px solid #010101;" |
times called

|}

'''Example'''

array qas1 = QAS_new(33702597);

qas1[QAS_TEST] = true;

QAS_save(qas1);

array qas2 = QAS_new(33702597, 53468);

QAS_save(qas2);

'''Availability'''

Version 5.6 __NOTOC__ 

[[Category:Questionnaire_Functions]]

The String Concatenation

2012-02-10T13:31:22Z

Dennis:

[[Category:Operators]]
{{HelpFiles}}

===The String Concatenation===

CGS uses operator ‘+’ for concatenating string expressions. When the operator ‘+’ is used between a string and a number expression, the number expression will be converted to a string and then concatenated to the string expression.

For example, if we have an expression: “1” + 6, its value is a string: “16”.

===Invariant strings===

Strings are invariant, meaning that an existing string cannot be changed.
Therefore when making a string concatenation, a new string must be allocated.

If this is done excessively, e.g. in a loop, this may result in severe performance degradation of the script and possible the whole server.

Use the [[StringBuilder_class|StringBuilder]] when it is necessary to do this kind of processing.

__NOTOC__

MyPortal

2011-12-28T04:48:42Z

Dennis: moved MyPortal to MyPortal Development guide

#REDIRECT [[MyPortal Development guide]]

MyPortal Development guide

2011-12-28T04:48:42Z

Dennis: moved MyPortal to MyPortal Development guide

[[Category:Personalization]]
<accesscontrol>Administrators,,Cem,,Maysunshine</accesscontrol>

== Introduction ==

The My Portal page is your own personalized view of what goes on in the Catglobe system that is interesting to you.

More information about My Portal is available [[My_portal|here]].

== How to make user defined elements ==

A user defined element as its name is the one you can put anything you want.

[[Image:MyPortal - User-defined.jpg]]  

An element contains 2 features:

*HTML content: input inside Detailed decsription tab's HTML editor. It is required to show the element in MyPortal page (empty content will end up in not displaying anything)
*Javascript: input inside Detailed description tab's script mode. It is used to manipulate the way the element will act, it can connect to registered web services or change the HTML content dynamically. jQuery is also supported, which makes it even more powerful.

== Script - Supported features ==

=== Events ===

*''onload'': called after loading the element
*''onadd'': called once after adding the element to MyPortal page (Insert)
*''onminimize'': called when minimizing the element
*''onmaximize'': called when maximizing the element
*''onremove'': called when the element is removed from MyPortal page
*''onmouseover'': called when mouse is over the element
*''onmouseout'': called when mouse is out of the element

=== Functions ===

*''set_title(titleText)'': change the title of element
*''get_contentDiv()'': get the element's "div" content, used for manipulating the HTML content
*''getManager().updateElementOrdination()'': automatically re-arrange MyPortal page (used when the HTML content is updated dynamically)

=== Sample code ===

<source lang="javascript">
this.onload = function()
{
// use "this" keyword to access the element itself.
}
</source>

== Potential problems ==

It can sometimes be quite problematic when displaying portal elements.Be careful when adding the HTML content, no validation is supported inside the editors.

=== Tips ===

*Flash objects might be placed on top of others. To fix that problem, these parameters should be added into the flash: ''IE: "<param name='wmode' value='transparent' />" FF: 'wmode="transparent" ''' 

== Examples ==

[[Display a questionnaire's answers in real time]]

[[Movie player element]]

MyPortal Development guide

2011-12-28T04:48:06Z

Dennis:

Exception Handling

2011-12-20T06:22:37Z

Dennis: /* Exception Handling (Error Runtime Handling) */

=Exception Handling (Error Runtime Handling)=
[[category:Program Control Statements]]
__NOTOC__

An exception is an error occurs in the runtime (the excution) of program. The CGScript language uses the '''try/catch statement''' and the '''throw''' expression to implement exception handling.

=== '''Syntax''' ===
=== try-catch statement ===
<pre>
exception declaration
// you must declare your exception variable before using it the try catch statement
// And the data type of this exception variable should be an object type (E.g. object e;) so that it can catch any kind of objects thrown by system or users
try {
// codes that could throw an exception
}
catch (exception) {
// codes that execute when exception is thrown in the try block
}
</pre>

* In the try clause, when a line of code causes the exception/error, the exception will be thrown to the catch clause and the codes in catch clause will process that exception. All codes below the code which cause the exception/error will be ignored.
* The '''exception''' can be any type (E.g. exception object, number, string...)
* CGScript language does not support multi catch clauses.
* Both try and catch clauses can contain nested try/catch statements.

=== throw expression ===
throw [expression]

* The '''expression''' can be any type (E.g. exception object, number, string...)
* Used in try-catch statement only.
* If throw is used in catch clause, it will be re-throw. See below examples for information about re-throw.

=== '''See also''' ===

* [[Exception class]] for more information about the error object of non-users (system) thrown errors.

=== '''Examples''' ===

<source lang="javascript">
Example 1:

object e;
string Name = "ManTu";
try {
Age = 20; // The Age variable is not declared, so this line will cause exception/error. An exception will be thrown to the catch clause
// And all codes below this line (Age = 20;) will not be ignored.
print("Hello " + Name + "! Your Age is: " + Age);
}
catch(e) {
print("====There 's an error with your script :)======");
print(e.ToString());
}

======================================================
Example 2:

string e;
string Name = "ManTu";
number Age = 0;
try {
if(Age == 0)
throw "Age can not be zero!"; // use throw expression in try clause to throw a specific exception to catch clause
else
print("Hello " + Name + "! Your Age is: " + Age);
}
catch(e) {
print(e); // print out: Age can not be zero!
}

======================================================
Example 3: Re-throw

object e;
try
{
try {
s = 10;
}
catch(e) {
throw; // throw in this case will be re-throw. It will re-throw the exception to the try-catch statement which contain it.
}
}
catch(e) // this catch clause will receive the exception that re-thrown by above catch clause
{
print("s is not declared yet.");
}
</source>

Template:Category tree all

2011-12-06T04:11:56Z

Dennis: Created page with "{| class="toc" {{#ifeq:{{{alignright|}}}|yes|align="right"}} ! {{{header|To display all {{#ifeq: {{{mode|categories}}} | categories | subcategories | }}{{#ifeq: {{{mode|}}} | pag..."

{| class="toc" {{#ifeq:{{{alignright|}}}|yes|align="right"}}
! {{{header|To display all {{#ifeq: {{{mode|categories}}} | categories | subcategories | }}{{#ifeq: {{{mode|}}} | pages | pages | }}{{#ifeq: {{{mode|}}} | all | pages, subcategories and images | }}{{#ifeq: {{{mode|}}} | parents | parents | }} click on the "+":}}}
|-
| {{#tag: categorytree| {{{1|{{PAGENAME}}}}} |mode={{{mode|}}} |depth={{{depth|0}}} |hideroot={{{hideroot|off}}} |showcount={{{showcount|on}}} }}
|}<noinclude>{{Documentation}}</noinclude>

Array class

2011-09-22T09:57:35Z

Dennis: Reverted edits by Tungocman (talk) to last revision by Dennis

{{CGscriptClass_Template
|Name=<nowiki>Array</nowiki>
|Description=<nowiki>The array object</nowiki>
|Constructors=
{{CGscriptConstructors_Template|Description=<nowiki>Creates an empty array</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>count</nowiki>|Description=<nowiki>Number of items to put in the array</nowiki>}}
|Description=<nowiki>Creates an array with a predefined size, where all elements are Empty</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Add</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=AnyType|Name=<nowiki>element</nowiki>|Description=<nowiki>element to add</nowiki>}}
|Description=<nowiki>Add a new element to the Array</nowiki>}}
{{CGscriptMethods_Template|ReturnType=AnyType|Name=<nowiki>First</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=Function|Name=<nowiki>selector</nowiki>|Description=<nowiki>A function to test each element for a condition.</nowiki>}}
|Description=<nowiki>Returns the first element in a sequence that satisfies a specified condition.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=AnyType|Name=<nowiki>FirstOrDefault</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=Function|Name=<nowiki>selector</nowiki>|Description=<nowiki>A function to test each element for a condition.</nowiki>}}
|Description=<nowiki>Returns the first element in a sequence that satisfies a specified condition or empty if not found.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>Frequency</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>number</nowiki>|Description=<nowiki>The number to search for</nowiki>}}
|Description=<nowiki>Counts the number of times a given Number object exists in the Array. Can only use if all the elements are of type Number</nowiki>}}
{{CGscriptMethods_Template|ReturnType=AnyType|Name=<nowiki>this[] { get; }</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>index</nowiki>|Description=<nowiki>Index</nowiki>}}
|Description=<nowiki>Get element at index</nowiki>}}
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>IsCharacterArray</nowiki>|Description=<nowiki>check if array is an array of characters</nowiki>}}
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>IsNumericArray</nowiki>|Description=<nowiki>check if array is an array of numbers</nowiki>}}
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>IsNumericArray</nowiki>|Description=<nowiki>check if array is an array of integer numbers</nowiki>}}
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>IsStringArray</nowiki>|Description=<nowiki>check if array is an array of string</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>OrderBy</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=Function|Name=<nowiki>comparer</nowiki>|Description=<nowiki>Function that compares two objects of the same type. Must return a signed integer that indicates the relative values of first param A and second param B. Value Less than 0 : A is less than B.Value 0 : A equals B.Value Greater than 0 : A is greater than B.</nowiki>}}
|Description=<nowiki>Sorts the elements of a sequence in ascending order by using a specified comparer.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RemoveItemAt</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>index</nowiki>|Description=<nowiki>The index to remove the object from</nowiki>}}
|Description=<nowiki>Remove an element from the Array</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>Select</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=Function|Name=<nowiki>selector</nowiki>|Description=<nowiki>A transform function to apply to each element.</nowiki>}}
|Description=<nowiki>Projects each element of a sequence into a new form.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>this[] { set; }</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>index</nowiki>|Description=<nowiki>Index</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=AnyType|Name=<nowiki>value</nowiki>|Description=<nowiki>Value to set</nowiki>}}
|Description=<nowiki>Set element value at index</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>Where</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=Function|Name=<nowiki>predicate</nowiki>|Description=<nowiki>A function that takes 1 parameter of the types in the array and return true/false</nowiki>}}
|Description=<nowiki>Filters a sequence of values based on a predicate.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Average</nowiki>|HasGetter=1|Description=<nowiki>Average of the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Count</nowiki>|HasGetter=1|Description=<nowiki>Number of elements in Array</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Max</nowiki>|HasGetter=1|Description=<nowiki>Largest of all the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Min</nowiki>|HasGetter=1|Description=<nowiki>Smallest of all the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Sum</nowiki>|HasGetter=1|Description=<nowiki>Sum of all the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

==== '''Examples''' ====

<source lang="javascript">array x = new Array();
print(x); // {}</source> <source lang="javascript">array x = new Array(10);
print(x); // {Empty,Empty,Empty,Empty,Empty,Empty,Empty,Empty,Empty,Empty}</source> <source lang="javascript">array x = {10,20,30,40,50,60,70,80,90,100};
array y = x
.Select(function (number a) { a;})
// .Select(function (string a) { a;}) -> will not work: Cannot assign a value of type 'Number' to a variable of type 'String'
// .Select(function (array a) { a;}) -> will not work: Cannot assign a value of type 'Number' to a variable of type 'Array'
// .Select(function (bool a) { a;}) -> will not work: Cannot assign a value of type 'Number' to a variable of type 'Boolean'
// .Select(function () { a;}) -> will not work: Function called with too many parameters @
.Where(function (number a) {number i = getRandomNumber(0,10)*10; i > 40;});
print(y);</source> <source lang="javascript">array x = {10,20,30,40,50,60,70,80,90,100};
array y = x
.Select(function (number a) { 88888;})
.Where(function (number a) {number i = getRandomNumber(0,10)*10; i > 40;});
print(y);</source> <source lang="javascript">array x = {10,20,30,40,50,60,70,80,90,100};
array y = x
.Select(function (number a) { a;})
.Where(function (number a) {number i = getRandomNumber(0,10)*10; i > 40;})
.OrderBy(function(number a, number b) {if (a>b) 1; else if (a<b) -1; else 0;});
// .OrderBy(function(number a, number b){if (a>b) -1; else if (a<b) 1; else 0;});
print(y);</source> <source lang="javascript">array x = {{1,2,3},{4,false,6,7,8},{10,"ab",{"aaa",11,true},13,14},{"aa","bb",17},{},{true,88}};
array y = x
.Select(function (array a) {; a;})
.Where(function (array a) {arrayCount(a) > 3;});
print(y); // {{4,False,6,7,8},{10,ab,{aaa,11,True},13,14}}</source> <source lang="javascript">array y = {20,30,40,50,70,80,90,100};
print(y.FirstOrDefault(function (number a) { true; })); // 20
print(y.FirstOrDefault(function (number a) { a > 70; })); // 80
print(y.First(function(number a) { true; })); // 20
print(y.First(function(number a) { a > 40; })); // 50</source>

[[Category:Data_Types_Literals_and_Variables]]

String class

2011-09-22T09:22:57Z

Dennis: Created page with "{{CGscriptClass_Template |Name=<nowiki>String</nowiki> |Description=<nowiki>The string object</nowiki> |Constructors= {{CGscriptConstructors_Template|Parameters= {{CGscriptParame..."

{{CGscriptClass_Template
|Name=<nowiki>String</nowiki>
|Description=<nowiki>The string object</nowiki>
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>value</nowiki>|Description=<nowiki>Value to give object</nowiki>}}
|Description=<nowiki>New object with the given value</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

Number class

2011-09-22T09:22:17Z

Dennis: Created page with "{{CGscriptClass_Template |Name=<nowiki>Number</nowiki> |Description=<nowiki>The number object</nowiki> |Constructors= {{CGscriptConstructors_Template|Parameters= {{CGscriptParame..."

{{CGscriptClass_Template
|Name=<nowiki>Number</nowiki>
|Description=<nowiki>The number object</nowiki>
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>value</nowiki>|Description=<nowiki>Value to give object</nowiki>}}
|Description=<nowiki>New object with the given value</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>value</nowiki>|Description=<nowiki>Value to give object</nowiki>}}
|Description=<nowiki>New object with the given value</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

Empty class

2011-09-22T09:21:41Z

Dennis: Created page with "{{CGscriptClass_Template |Name=<nowiki>Empty</nowiki> |Description=<nowiki>The Empty object</nowiki> |Methods= {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString<..."

{{CGscriptClass_Template
|Name=<nowiki>Empty</nowiki>
|Description=<nowiki>The Empty object</nowiki>
|Methods=
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

Bool class

2011-09-22T09:20:56Z

Dennis: Created page with "{{CGscriptClass_Template |Name=<nowiki>Bool</nowiki> |Description=<nowiki>The bool object</nowiki> |Constructors= {{CGscriptConstructors_Template|Parameters= {{CGscriptParameters..."

{{CGscriptClass_Template
|Name=<nowiki>Bool</nowiki>
|Description=<nowiki>The bool object</nowiki>
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=bool|Name=<nowiki>value</nowiki>|Description=<nowiki>Value to give object</nowiki>}}
|Description=<nowiki>New object with the given value</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

StringBuilder class

2011-09-22T09:19:57Z

Dennis: Created page with "{{CGscriptClass_Template |Name=<nowiki>StringBuilder</nowiki> |Description=<nowiki>An equivalent to the stringbuilder class in dotnet, in that it is not invariant, and thus manip..."

{{CGscriptClass_Template
|Name=<nowiki>StringBuilder</nowiki>
|Description=<nowiki>An equivalent to the stringbuilder class in dotnet, in that it is not invariant, and thus manipulations are fast.</nowiki>
|Constructors=
{{CGscriptConstructors_Template|Description=<nowiki>Create a new empty string</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=StringBuilder|Name=<nowiki>Append</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>str</nowiki>|Description=<nowiki>String to append</nowiki>}}
|Description=<nowiki>Append to current string</nowiki>}}
{{CGscriptMethods_Template|ReturnType=StringBuilder|Name=<nowiki>AppendFormat</nowiki>|Parameters={{CGscriptParameters_Template|Type=params AnyType|Name=params AnyType|Description=}}
|Description=<nowiki>Format the first param with the other parameters given and append to current string</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>this[] { get; }</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>index</nowiki>|Description=<nowiki>The key used to lookup the value.</nowiki>}}
|Description=<nowiki>Get the char at the given index.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=StringBuilder|Name=<nowiki>Remove</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>startIndex</nowiki>|Description=<nowiki>The zero-based position in this instance where removal begins.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=<nowiki>length</nowiki>|Description=<nowiki>The number of characters to remove</nowiki>}}
|Description=<nowiki>Removes the specified range of characters from this instance.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=StringBuilder|Name=<nowiki>Replace</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>oldValue</nowiki>|Description=<nowiki>The string to replace.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>newValue</nowiki>|Description=<nowiki>The string that replaces oldValue or Empty.</nowiki>}}
|Description=<nowiki>Replaces all occurrences of a specified string in this instance with another specified string.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=StringBuilder|Name=<nowiki>Replace</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>oldValue</nowiki>|Description=<nowiki>The string to replace.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>newValue</nowiki>|Description=<nowiki>The string that replaces oldValue or Empty.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=<nowiki>startIndex</nowiki>|Description=<nowiki>The position in this instance where the substring begins.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=<nowiki>count</nowiki>|Description=<nowiki>The length of the substring.</nowiki>}}
|Description=<nowiki>Replaces, within a substring of this instance, all occurrences of a specified string with another specified string.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>this[] { set; }</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>index</nowiki>|Description=<nowiki>The key used to lookup the value.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>value</nowiki>|Description=<nowiki>The value to set.</nowiki>}}
|Description=<nowiki>Set the char at the given index to the value given.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>Substring</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>startIndex</nowiki>|Description=<nowiki>The position in this instance where the substring begins.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=<nowiki>length</nowiki>|Description=<nowiki>The length of the substring.</nowiki>}}
|Description=<nowiki>Returns a substring in the string.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

ResourceJournalEntry class

2011-09-22T09:19:23Z

Dennis: Created page with "{{CGscriptClass_Template |Name=<nowiki>ResourceJournalEntry</nowiki> |Description=<nowiki>A resource journal entry</nowiki> |Constructors= {{CGscriptConstructors_Template|Paramet..."

{{CGscriptClass_Template
|Name=<nowiki>ResourceJournalEntry</nowiki>
|Description=<nowiki>A resource journal entry</nowiki>
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>Resource Id</nowiki>|Description=<nowiki>Comment to what resource</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>journalType</nowiki>|Description=<nowiki>What kind of journal type is it</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>content</nowiki>|Description=<nowiki>What does the comment say</nowiki>}}
|Description=<nowiki>Create a new comment object. Use Resource_addJournal or .Save() to save. Creating user is current user. Use addJournal() if dealing with tasks.</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save the current comment</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>CommentType</nowiki>|HasGetter=1|Description=<nowiki>Get the comment type as string</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Content</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the comment content</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>CreatedByUserResourceId</nowiki>|HasGetter=1|Description=<nowiki>Get CreatedByUserResourceId</nowiki>}}
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>CreatedDate</nowiki>|HasGetter=1|Description=<nowiki>Get CreatedDate</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>ModifiedByUserResourceId</nowiki>|HasGetter=1|Description=<nowiki>Get ModifiedByUserResourceId</nowiki>}}
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>ModifiedDate</nowiki>|HasGetter=1|Description=<nowiki>Get ModifiedDate</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

ResourceBudget class

2011-09-22T09:19:02Z

Dennis: Created page with "{{CGscriptClass_Template |Name=<nowiki>ResourceBudget</nowiki> |Description=<nowiki>Represents the budget for a resource.</nowiki> |Methods= {{CGscriptMethods_Template|ReturnType..."

{{CGscriptClass_Template
|Name=<nowiki>ResourceBudget</nowiki>
|Description=<nowiki>Represents the budget for a resource.</nowiki>
|Methods=
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=Dictionary|Name=<nowiki>LedgerEntries</nowiki>|HasGetter=1|Description=<nowiki>Gets the budget's ledger entries.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>ResourceId</nowiki>|HasGetter=1|Description=<nowiki>Gets the resource id of the resource which the budget belongs to.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

Range class

2011-09-22T09:12:36Z

Dennis: Created page with "{{CGscriptClass_Template |Name=<nowiki>Range</nowiki> |Description=<nowiki>The Range object.</nowiki> |Constructors= {{CGscriptConstructors_Template|Parameters= {{CGscriptParamet..."

{{CGscriptClass_Template
|Name=<nowiki>Range</nowiki>
|Description=<nowiki>The Range object.</nowiki>
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>value</nowiki>|Description=<nowiki>Value to give object</nowiki>}}
|Description=<nowiki>New object with the given value</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>Contains</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>val</nowiki>|Description=<nowiki>Value to check for</nowiki>}}
|Description=<nowiki>Does the range contain this value</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

QuestionnaireStatistics class

2011-09-22T09:12:02Z

Dennis: Created page with "{{CGscriptClass_Template |Name=<nowiki>QuestionnaireStatistics</nowiki> |Description=<nowiki>The questionnaire statistics collection. To view information like how big a sample is..."

{{CGscriptClass_Template
|Name=<nowiki>QuestionnaireStatistics</nowiki>
|Description=<nowiki>The questionnaire statistics collection. To view information like how big a sample is used, how large is the active samples etc.</nowiki>
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=array|Name=<nowiki>qids</nowiki>|Description=<nowiki>An array of questionnaire resource ids. Invalid ids are ignored. Deleted ids are ok. Must have Read permission.</nowiki>}}
|Description=<nowiki>Constructor to take many questionnaires</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>AverageInterviewSucceededTime</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
|Description=<nowiki>Get count of AverageInterviewSucceededTime</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>EstimatedTime</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
|Description=<nowiki>Get count of EstimatedTime</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>EstimatedTotalTime</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
|Description=<nowiki>Get count of EstimatedTotalTime</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NonSampleRules</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
|Description=<nowiki>Get count of NonSampleRules</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NonSampleRulesWithData</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
|Description=<nowiki>Get count of NonSampleRulesWithData</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NonSampleRulesWithoutData</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
|Description=<nowiki>Get count of NonSampleRulesWithoutData</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NumberOfActiveNotContactedRpq</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
|Description=<nowiki>Get count of NumberOfActiveNotContactedRpq</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NumberOfActiveSample</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
|Description=<nowiki>Get count of NumberOfActiveSample</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NumberOfAvailable</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
|Description=<nowiki>Get count of NumberOfAvailable</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NumberOfAvailableActive</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
|Description=<nowiki>Get count of NumberOfAvailableActive</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NumberOfCompleted</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
|Description=<nowiki>Get count of NumberOfCompleted</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NumberOfCompletedToday</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
|Description=<nowiki>Get count of NumberOfCompletedToday</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NumberOfCompletedYesterday</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
|Description=<nowiki>Get count of NumberOfCompletedYesterday</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NumberOfInterviewSucceeded</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
|Description=<nowiki>Get count of NumberOfInterviewSucceeded</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NumberOfInterviewSucceededToday</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
|Description=<nowiki>Get count of NumberOfInterviewSucceededToday</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NumberOfInterviewSucceededYesterday</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
|Description=<nowiki>Get count of NumberOfInterviewSucceededYesterday</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NumberOfNotContactedRpq</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
|Description=<nowiki>Get count of NumberOfNotContactedRpq</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NumberOfPartly</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
|Description=<nowiki>Get count of NumberOfPartly</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NumberOfSample</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
|Description=<nowiki>Get count of NumberOfSample</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NumberOfTestLink</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
|Description=<nowiki>Get count of NumberOfTestLink</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>TargetReachedCount</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
|Description=<nowiki>Get count of TargetReachedCount</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

QuestionnaireCost class

2011-09-22T09:11:30Z

Dennis: Created page with "{{CGscriptClass_Template |Name=<nowiki>QuestionnaireCost</nowiki> |Description=<nowiki>The questionnaire cost object</nowiki> |Methods= {{CGscriptMethods_Template|ReturnType=stri..."

{{CGscriptClass_Template
|Name=<nowiki>QuestionnaireCost</nowiki>
|Description=<nowiki>The questionnaire cost object</nowiki>
|Methods=
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>CollectedCost</nowiki>|HasGetter=1|Description=<nowiki>Get collected answers cost for the questionnaire in the specified period</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>ImportedCost</nowiki>|HasGetter=1|Description=<nowiki>Get imported answers cost for the questionnaire in the specified period</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>QuestionnaireName</nowiki>|HasGetter=1|Description=<nowiki>Get name of the questionnaire</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|HasGetter=1|Description=<nowiki>Get questionnaire resource id</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>ScriptedCost</nowiki>|HasGetter=1|Description=<nowiki>Get scripted answers cost for the questionnaire in the specified period</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

PaymentNamespace class

2011-09-22T09:11:07Z

Dennis: Created page with "{{CGscriptClass_Template |Name=<nowiki>PaymentNamespace</nowiki> |Description=<nowiki>The payment namespace</nowiki> |Methods= {{CGscriptMethods_Template|ReturnType=array|Name=<n..."

{{CGscriptClass_Template
|Name=<nowiki>PaymentNamespace</nowiki>
|Description=<nowiki>The payment namespace</nowiki>
|Methods=
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>GetDetailedQuestionnaireUsageCost</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=array|Name=<nowiki>startDate</nowiki>|Description=<nowiki>Period start date</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>endDate</nowiki>|Description=<nowiki>Period end date</nowiki>}}
|Description=<nowiki>Get detailed information about cost for questionnaires in the specified period</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

LedgerEntry class

2011-09-22T09:10:36Z

Dennis: Created page with "{{CGscriptClass_Template |Name=<nowiki>LedgerEntry</nowiki> |Description=<nowiki>Represents a ledger entry in the budget for a resource.</nowiki> |Methods= {{CGscriptMethods_Temp..."

{{CGscriptClass_Template
|Name=<nowiki>LedgerEntry</nowiki>
|Description=<nowiki>Represents a ledger entry in the budget for a resource.</nowiki>
|Methods=
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>AccountName</nowiki>|HasGetter=1|Description=<nowiki>Gets the account name for the ledger entry.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>AccountNumber</nowiki>|HasGetter=1|Description=<nowiki>Gets the account number for the ledger entry.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Actual</nowiki>|HasGetter=1|Description=<nowiki>Gets the actual amount for the ledger entry.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Budget</nowiki>|HasGetter=1|Description=<nowiki>Gets the budgetted amount for the ledger entry.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

JsonNamespace class

2011-09-22T09:09:18Z

Dennis: Created page with "{{CGscriptClass_Template |Name=<nowiki>JsonNamespace</nowiki> |Description=<nowiki>The json namespace</nowiki> |Methods= {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki..."

{{CGscriptClass_Template
|Name=<nowiki>JsonNamespace</nowiki>
|Description=<nowiki>The json namespace</nowiki>
|Methods=
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>Encode</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=AnyType|Name=<nowiki>obj</nowiki>|Description=<nowiki>Object to encode</nowiki>}}
|Description=<nowiki>Encode an object to a json string</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>EncodeWcf</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=AnyType|Name=<nowiki>obj</nowiki>|Description=<nowiki>Object to encode</nowiki>}}
|Description=<nowiki>Encode an object to a json string using Wcf json (where __type is added)</nowiki>}}
{{CGscriptMethods_Template|ReturnType=AnyType|Name=<nowiki>Parse</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>json</nowiki>|Description=<nowiki>String to parse</nowiki>}}
|Description=<nowiki>Parse a json string to an object structure</nowiki>}}
{{CGscriptMethods_Template|ReturnType=AnyType|Name=<nowiki>ParseWcf</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>json</nowiki>|Description=<nowiki>String to parse</nowiki>}}
|Description=<nowiki>Parse a json string to an object structure using Wcf json (where __type is respected)</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

ImportManager class

2011-09-22T09:08:44Z

Dennis: Created page with "{{CGscriptClass_Template |Name=<nowiki>ImportManager</nowiki> |Description=<nowiki>Import data and users.</nowiki> |Constructors= {{CGscriptConstructors_Template|Parameters= {{CG..."

{{CGscriptClass_Template
|Name=<nowiki>ImportManager</nowiki>
|Description=<nowiki>Import data and users.</nowiki>
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=array|Name=<nowiki>Headers</nowiki>|Description=<nowiki>A list of string that are the header names</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>data</nowiki>|Description=<nowiki>Data to import. An array of arrays of equal length as the headers</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>advancedMode</nowiki>|Description=<nowiki>Enable setting advanced settings - Requires special navigation access</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=<nowiki>groupResourceId</nowiki>|Description=<nowiki>Group to add users to new users to and/or sample rule. Set to 0 to not add to group</nowiki>}}
|Description=<nowiki>Make a new import with the given data</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Import</nowiki>|Description=<nowiki>Run the Import. Note that this will commit any pending changes</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetDataImportOptions</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>projectQuestionnaireResourceId</nowiki>|Description=<nowiki>The resource Id of where the data should be added/updated</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=<nowiki>type</nowiki>|Description=<nowiki>How to treat when already have existing answer sheets. 1 for Zero or One AnswerSheet, 2 for delete existing and create new, 3 for mapping to rpqIdColumnName</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>rpqIdColumnName</nowiki>|Description=<nowiki>Mapping for column name in case type is 3</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>isCommaSeparatedFormat</nowiki>|Description=<nowiki>Import multi questions as comma separated format</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=Dictionary|Name=<nowiki>mapping</nowiki>|Description=<nowiki>Mapping between header names and import names. If empty, automapping is used</nowiki>}}
|Description=<nowiki>Set specific options for importing data or altering existing data</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetUserImportOptions</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>userIdColumnName</nowiki>|Description=<nowiki>The header name of the userId column</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>userNameMask</nowiki>|Description=<nowiki>The mask used to create new usernames - an advanced setting</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>generatePasswords</nowiki>|Description=<nowiki>Generate passwords during import</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>importUserInfo</nowiki>|Description=<nowiki>Import or Update users</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>importPhoneNumber</nowiki>|Description=<nowiki>Import or Update phonenumbers</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>importAddress</nowiki>|Description=<nowiki>Import or Update addresses</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>importPoints</nowiki>|Description=<nowiki>Import or Update points</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>importQualification</nowiki>|Description=<nowiki>Import or Update qualifications</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=<nowiki>parentResourceId</nowiki>|Description=<nowiki>Resource Id of the parent of the new users</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=Dictionary|Name=<nowiki>mapping</nowiki>|Description=<nowiki>Mapping between header names and import names. If empty, automapping is used</nowiki>}}
|Description=<nowiki>Set specific options for importing new users or altering existing users</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>Validate</nowiki>|Description=<nowiki>Same as Validate(true)</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>Validate</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=bool|Name=<nowiki>errorOnSemiOpenQuestion</nowiki>|Description=<nowiki>Set to false if you need to import to questions with open parts and know that it may partially delete existing data</nowiki>}}
|Description=<nowiki>Validate prior to actual importing. Throws if errors, otherwise returns warning.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

Exception class

2011-09-22T09:08:00Z

Dennis: Created page with "{{CGscriptClass_Template |Name=<nowiki>Exception</nowiki> |Description=<nowiki>Represents an error object.</nowiki> |Methods= {{CGscriptMethods_Template|ReturnType=string|Name=<n..."

{{CGscriptClass_Template
|Name=<nowiki>Exception</nowiki>
|Description=<nowiki>Represents an error object.</nowiki>
|Methods=
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=Exception|Name=<nowiki>InnerException</nowiki>|HasGetter=1|Description=<nowiki>Gets the Exception instance that caused the current exception.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Message</nowiki>|HasGetter=1|Description=<nowiki>Gets a message that describes the current exception.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>StackTrace</nowiki>|HasGetter=1|Description=<nowiki>Return the internal stack trace, useful when sending a bugreport to Catglobe.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

CsvReader class

2011-09-22T09:06:53Z

Dennis: Created page with "{{CGscriptClass_Template |Name=<nowiki>CsvReader</nowiki> |Description=<nowiki>Represents a reader that provides fast, non-cached, forward-only access to CSV data.</nowiki> |Cons..."

{{CGscriptClass_Template
|Name=<nowiki>CsvReader</nowiki>
|Description=<nowiki>Represents a reader that provides fast, non-cached, forward-only access to CSV data.</nowiki>
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>csvData</nowiki>|Description=<nowiki>The string containing the text to be parsed as csv data</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>hasHeaders</nowiki>|Description=<nowiki>true if field names are located on the first non commented line, otherwise, false.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>delimiter</nowiki>|Description=<nowiki>The delimiter character separating each field (default is ',').</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>quote</nowiki>|Description=<nowiki>The quotation character wrapping every field (default is ''').</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>escape</nowiki>|Description=<nowiki>The escape character letting insert quotation characters inside a quoted field (default is '\'). If no escape character, set to '\0' to gain some performance.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>comment</nowiki>|Description=<nowiki>The comment character indicating that a line is commented out (default is '#').</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>skipEmptyLines</nowiki>|Description=<nowiki>A value indicating if the reader will skip empty lines.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>supportsMultiline</nowiki>|Description=<nowiki>A value indicating if the reader supports multiline field.</nowiki>}}
|Description=<nowiki>Create a new reader. Example:
string empt = empty;
CsvReader csv = new CsvReader(csvData, true, ";", "\"", empt, empt, true, false);

number fieldCount = csv.FieldCount;
array headers = csv.Headers;
while(csv.ReadNextRecord()) {
for(number i = 0; i < fieldCount; i = i +1) {
string value = csv[i];
if (value == empty) value = "MISSING";
print(headers[i] + " = " + value);
}
print("---------");
}
</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>this[] { get; }</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>field</nowiki>|Description=<nowiki>The field with the specified name.</nowiki>}}
|Description=<nowiki>Gets the field with the specified name. Must have set hasHeaders to true when starting read.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>this[] { get; }</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>field</nowiki>|Description=<nowiki>The field at the specified index.</nowiki>}}
|Description=<nowiki>Gets the field at the specified index.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>ReadNextRecord</nowiki>|Description=<nowiki>Reads the next record. true if a record has been successfully reads; otherwise, false.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>FieldCount</nowiki>|HasGetter=1|Description=<nowiki>Gets the maximum number of fields to retrieve for each record.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>Headers</nowiki>|HasGetter=1|Description=<nowiki>Gets the field headers.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

XElement class

2011-09-22T09:05:55Z

Dennis:

{{CGscriptClass_Template
|Name=<nowiki>XElement</nowiki>
|Description=<nowiki>An element in an xml document</nowiki>
|Constructors=
{{CGscriptConstructors_Template|Parameters={{CGscriptParameters_Template|Type=params AnyType|Name=params AnyType|Description=}}
|Description=<nowiki>Create a new element with a number of child elements</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>xml</nowiki>|Description=<nowiki>A xml string</nowiki>}}
|Description=<nowiki>Create a new element from a string</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of the element</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=AnyType|Name=<nowiki>value</nowiki>|Description=<nowiki>Value of the element</nowiki>}}
|Description=<nowiki>Create a new element with a name and value</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Add</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=AnyType|Name=<nowiki>content</nowiki>|Description=<nowiki>Content to add</nowiki>}}
|Description=<nowiki>Adds the specified content as children of this element.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Add</nowiki>|Parameters={{CGscriptParameters_Template|Type=params AnyType|Name=params AnyType|Description=}}
|Description=<nowiki>Adds the specified content as children of this element.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AddAfterSelf</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=AnyType|Name=<nowiki>content</nowiki>|Description=<nowiki>Content to add</nowiki>}}
|Description=<nowiki>Adds the specified content immediately after this node.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AddBeforeSelf</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=AnyType|Name=<nowiki>content</nowiki>|Description=<nowiki>Content to add</nowiki>}}
|Description=<nowiki>Adds the specified content immediately before this node.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AddFirst</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=AnyType|Name=<nowiki>content</nowiki>|Description=<nowiki>Content to add</nowiki>}}
|Description=<nowiki>Adds the specified content as the first children of this document or element.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AddFirst</nowiki>|Parameters={{CGscriptParameters_Template|Type=params AnyType|Name=params AnyType|Description=}}
|Description=<nowiki>Adds the specified content as the first children of this document or element.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>Ancestors</nowiki>|Description=<nowiki>Returns a collection of the ancestor elements of this node.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>Ancestors</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of ancestor to look for</nowiki>}}
|Description=<nowiki>Returns a filtered collection of the ancestor elements of this node. Only elements that have a matching name are included in the collection.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>AncestorsAndSelf</nowiki>|Description=<nowiki>Returns a collection of elements that contain this element, and the ancestors of this element.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>AncestorsAndSelf</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of ancestor to look for</nowiki>}}
|Description=<nowiki>Returns a collection of elements that contain this element, and the ancestors of this element. Only elements that have a matching name are included in the collection.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>Descendants</nowiki>|Description=<nowiki>Returns a collection of the descendant elements for this document or element, in document order.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>Descendants</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of ancestor to look for</nowiki>}}
|Description=<nowiki>Returns a collection of the descendant elements for this document or element, in document order. Only elements that have a matching name are included in the collection.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>DescendantsAndSelf</nowiki>|Description=<nowiki>Returns a collection of elements that contain this element, and all descendant elements of this element, in document order.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>DescendantsAndSelf</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of ancestor to look for</nowiki>}}
|Description=<nowiki>Returns a filtered collection of elements that contain this element, and all descendant elements of this element, in document order. Only elements that have a matching name are included in the collection.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=XElement|Name=<nowiki>Element</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of ancestor to look for</nowiki>}}
|Description=<nowiki>Gets the first (in document order) child element with the specified name.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>Elements</nowiki>|Description=<nowiki>Returns a collection of the child elements of this element or document, in document order.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>Elements</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of ancestor to look for</nowiki>}}
|Description=<nowiki>Returns a collection of the child elements of this element or document, in document order. Only elements that have a matching name are included in the collection.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>ElementsAfterSelf</nowiki>|Description=<nowiki>Returns a collection of the sibling elements after this node, in document order.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>ElementsAfterSelf</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of ancestor to look for</nowiki>}}
|Description=<nowiki>Returns a filtered collection of the sibling elements after this node, in document order. Only elements that have a matching name are included in the collection.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>ElementsBeforeSelf</nowiki>|Description=<nowiki>Returns a collection of the sibling elements before this node, in document order.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>ElementsBeforeSelf</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of ancestor to look for</nowiki>}}
|Description=<nowiki>Returns a filtered collection of the sibling elements before this node, in document order. Only elements that have a matching name are included in the collection.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>this[] { get; }</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>attributename</nowiki>|Description=<nowiki>The attribute name.</nowiki>}}
|Description=<nowiki>Gets an attribute value.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Remove</nowiki>|Description=<nowiki>Removes this node from its parent.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RemoveAll</nowiki>|Description=<nowiki>Removes nodes and attributes from this element.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RemoveAttributes</nowiki>|Description=<nowiki>Removes attributes from this element.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RemoveNodes</nowiki>|Description=<nowiki>Removes the child nodes from this document or element.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>ReplaceWith</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=AnyType|Name=<nowiki>content</nowiki>|Description=<nowiki>Content to replace with</nowiki>}}
|Description=<nowiki>Replaces this node with the specified content.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>ReplaceWith</nowiki>|Parameters={{CGscriptParameters_Template|Type=params AnyType|Name=params AnyType|Description=}}
|Description=<nowiki>Replaces this node with the specified content.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>ReplaceWith</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=AnyType|Name=<nowiki>content</nowiki>|Description=<nowiki>Content to replace with</nowiki>}}
|Description=<nowiki>Replaces the children nodes of this document or element with the specified content.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>ReplaceWith</nowiki>|Parameters={{CGscriptParameters_Template|Type=params AnyType|Name=params AnyType|Description=}}
|Description=<nowiki>Replaces the children nodes of this document or element with the specified content.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>this[] { set; }</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>attributename</nowiki>|Description=<nowiki>The attribute name.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>value</nowiki>|Description=<nowiki>Value to set.</nowiki>}}
|Description=<nowiki>Sets an attribute value.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=Dictionary|Name=<nowiki>Attributes</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/sets the collection of attributes of this element. The get returns a copy, use the indexer instead.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>HasAttributes</nowiki>|HasGetter=1|Description=<nowiki>Gets a value indicating whether this element as at least one attribute.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>HasElements</nowiki>|HasGetter=1|Description=<nowiki>Gets a value indicating whether this element has at least one child element.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsEmpty</nowiki>|HasGetter=1|Description=<nowiki>Gets a value indicating whether this element contains no content.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Gets/sets the name of this element.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=XElement|Name=<nowiki>Parent</nowiki>|HasGetter=1|Description=<nowiki>Gets the parent XElement</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Value</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Gets/sets the concatenated text contents of this element.</nowiki>}}
}}

==== Examples ====

WebResponse class

2011-09-22T08:57:32Z

Dennis:

{{CGscriptClass_Template
|Name=<nowiki>WebResponse</nowiki>
|Description=<nowiki>The response object from a http request</nowiki>
|Methods=
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>Response</nowiki>|Description=<nowiki>The response from the request</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>Response</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>encoding</nowiki>|Description=<nowiki>Encoding to use to read the reply - See .NET Encoding.GetEncoding for further info</nowiki>}}
|Description=<nowiki>The response from the request with the encoding specified</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>CharacterSet</nowiki>|HasGetter=1|Description=<nowiki>Gets the character set of the response.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ContentEncoding</nowiki>|HasGetter=1|Description=<nowiki>Gets the method that is used to encode the body of the response.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>ContentLength</nowiki>|HasGetter=1|Description=<nowiki>Gets the number of bytes of the content returned by the request.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ContentType</nowiki>|HasGetter=1|Description=<nowiki>Gets the content type of the response.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=Dictionary|Name=<nowiki>Headers</nowiki>|HasGetter=1|Description=<nowiki>Gets the headers that are associated with this response from the server.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>LastModified</nowiki>|HasGetter=1|Description=<nowiki>Gets the last date and time that the contents of the response were modified.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Method</nowiki>|HasGetter=1|Description=<nowiki>Gets the method that is used to return the response.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>StatusCode</nowiki>|HasGetter=1|Description=<nowiki>Gets the status of the response.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>StatusDescription</nowiki>|HasGetter=1|Description=<nowiki>Gets the status description returned with the response.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

'''More information about an HTTP Message:''' [http://www.jmarshall.com/easy/http/ http://www.jmarshall.com/easy/http/] 

==== Examples ====

<source lang="javascript">string uri = "http://google.com";
string responseString;
HttpRequest hr = new HttpRequest(uri);
WebResponse wr = hr.GetResponse();
responseString = wr.Response();
print(responseString);</source> 

[[Category:Data_Types_Literals_and_Variables]]

HttpRequest class

2011-09-22T08:56:08Z

Dennis:

{{CGscriptClass_Template
|Name=<nowiki>HttpRequest</nowiki>
|Description=<nowiki>Object to make requests to sites</nowiki>
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>uri</nowiki>|Description=<nowiki>The uri to visit.</nowiki>}}
|Description=<nowiki>Visit a uri</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>uri</nowiki>|Description=<nowiki>The uri to visit.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=WebResponse|Name=<nowiki>takeCookiesFrom</nowiki>|Description=<nowiki>If you made a previous request and want to transfer the cookies from that response, give the response object here.</nowiki>}}
|Description=<nowiki>Visit a uri with cookies</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=WebResponse|Name=<nowiki>GetResponse</nowiki>|Description=<nowiki>Actually do the request, and get the response back</nowiki>}}
{{CGscriptMethods_Template|ReturnType=WebResponse|Name=<nowiki>GetResponse</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>body</nowiki>|Description=<nowiki>A body to include in the request - Always UTF-8 encoded</nowiki>}}
|Description=<nowiki>Actually do the request, and get the response back</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ContentType</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the ContentType</nowiki>}}
{{CGscriptProperties_Template|ReturnType=Dictionary|Name=<nowiki>Headers</nowiki>|HasSetter=1|Description=<nowiki>Apply headers to the request</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Method</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Choose which HTTP method to request with</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Timeout</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the timeout (in millisec)</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

'''More information about an HTTP Message:''' [http://www.jmarshall.com/easy/http/ http://www.jmarshall.com/easy/http/] 

==== Examples ====

<source lang="javascript">string uri = "http://google.com";
string responseString;
HttpRequest hr = new HttpRequest(uri);
WebResponse wr = hr.GetResponse();
responseString = wr.Response();
print(responseString);</source>

[[Category:Data_Types_Literals_and_Variables]]

DateTime class

2011-09-22T08:43:41Z

Dennis: Created page with "{{CGscriptClass_Template |Name=<nowiki>DateTime</nowiki> |Description=<nowiki>The DateTime object</nowiki> |Constructors= {{CGscriptConstructors_Template|Parameters= {{CGscriptPa..."

{{CGscriptClass_Template
|Name=<nowiki>DateTime</nowiki>
|Description=<nowiki>The DateTime object</nowiki>
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>value</nowiki>|Description=<nowiki>Value to parse as a date, syntax is same as for constant values</nowiki>}}
|Description=<nowiki>New based on a string representation of a date</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}

DataCacheSpecification class

2011-09-22T08:42:52Z

Dennis:

{{CGscriptClass_Template
|Name=<nowiki>DataCacheSpecification</nowiki>
|Description=<nowiki>Represents a DataCache specification.</nowiki>
|Constructors=
{{CGscriptConstructors_Template|Description=<nowiki>Instanciate a new instance using the current context datacache</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>ResourceId</nowiki>|Description=<nowiki>Resource Id of the DataCache</nowiki>}}
|Description=<nowiki>Instanciate a new instance using the resource id of a datacache</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>ResourceId</nowiki>|Description=<nowiki>Resource name of the new DataCache</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>Questionnaire Ids</nowiki>|Description=<nowiki>List of Questionnaires to use in the creation. Must all belong to same template</nowiki>}}
|Description=<nowiki>Create a new datacache using quick setup</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AddFilter</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>filterQuestionLabel</nowiki>|Description=<nowiki>Question to apply filter to. If empty, then clear current filters</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>filterValue</nowiki>|Description=<nowiki>Value of the filter</nowiki>}}
|Description=<nowiki>Add a filter to the DataCache</nowiki>}}
{{CGscriptMethods_Template|ReturnType=AnyType|Name=<nowiki>EvalWhere</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>whereExpression</nowiki>|Description=<nowiki>The expression to execute. It must contain 'where' and NOT start with a equal sign, and have 1 and only one semicolon in it</nowiki>}}
|Description=<nowiki>Evaluate a single where expression up against the current DataCache</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>EvalWhere</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=Dictionary|Name=<nowiki>whereExpressions</nowiki>|Description=<nowiki>The expressions to execute. They must contain 'where' and MAY start with a equal sign, and have 1 and only one semicolon in it</nowiki>}}
|Description=<nowiki>Evaluate a number of where expressions up against the current DataCache. If there are 2 or more expressions, the result is cached. Context weight and filters are ignored.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>EvalWhere</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=Dictionary|Name=<nowiki>whereExpressions</nowiki>|Description=<nowiki>The expressions to execute. They must contain 'where' and MAY start with a equal sign, and have 1 and only one semicolon in it</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>weight</nowiki>|Description=<nowiki>Column name of the weight to use in filter</nowiki>}}
|Description=<nowiki>Evaluate a number of where expressions up against the current DataCache using a weight. If there are 2 or more expressions, the result is cached. Context weight and filters are ignored.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>MakeContext</nowiki>|Description=<nowiki>Make the current DataCache the context DataCache</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save the DataCache</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>AutoUpdate</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set Auto Update</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>BuildWithWeight</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set if the DataCache should be built using weights</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>CachedRecords</nowiki>|HasGetter=1|Description=<nowiki>How many records does the DataCache currently hold</nowiki>}}
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>ColumnNames</nowiki>|HasGetter=1|Description=<nowiki>List of Column names</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Completed</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set include completed</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Deleted</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set include deleted</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Description</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set description of the DataCache</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Disabled</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set include disabled</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>InterviewFailed</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set include marked as interview failed</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>InterviewSucceeded</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set include marked as interview succeeded</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsOutOfDate</nowiki>|HasGetter=1|Description=<nowiki>Does the DataCache need to be rebuilt to have the correct content</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Language</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the iso code used in building the items that depend on a specific language</nowiki>}}
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>LastUpdated</nowiki>|HasGetter=1|Description=<nowiki>Time of the last rebuild</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Name of the DataCache resource</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Normal</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set include normal</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>NotStarted</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set include those not yet started</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>OutsideTarget</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set include those marked outside target</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Partly</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set include partly completed</nowiki>}}
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>QuestionnaireIds</nowiki>|HasGetter=1|Description=<nowiki>List of the questionnaires used in the DataCache</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>QuestionnaireTemplateId</nowiki>|HasGetter=1|Description=<nowiki>The resource id of the questionnaire template used in the DataCache</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>QuotaFull</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set include those with full quota</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>ResourceId</nowiki>|HasGetter=1|Description=<nowiki>The Id of the DataCache</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Test</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set include those marked as test</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>UpdateFrequence</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set Update Frequence in minutes</nowiki>}}
}}

==== '''Examples''' ====

'''Ex1:'''
<source lang="javascript">DCS_use(37244952); // set DCS context
string e1 = "count() where S_Age == [1] && M_Travel == [1,2];";
Dictionary d =
{
"exp1": "count() where S_Age == [1] && M_Travel == [1,2];",
"exp2": "count() where S_Age == [2] && M_Travel == [1];"
};
print(DCS_evaluateWhereExpression(e1)); // 68
DataCacheSpecification dcs = new DataCacheSpecification(); // Represent a DCS which is used as current DCS context
print(dcs.EvalWhere(e1)); // 68
print(dcs.EvalWhere(d)); // {"exp1": 68, "exp2": 46}</source>
'''Ex2:'''
<source lang="javascript">string e1 = "count() where S_Age == [1] && M_Travel == [1,2];";
Dictionary d =
{
"exp1": "count() where S_Age == [1] && M_Travel == [1,2];",
"exp2": "count() where S_Age == [2] && M_Travel == [1];"
};
DataCacheSpecification dcs = new DataCacheSpecification(37244952); // Represents a DCS which has Resource Id: 37244952
print(dcs.EvalWhere(e1)); // 68
print(dcs.EvalWhere(d)); // {"exp1": 68, "exp2": 46}
dcs.MakeContext(); // or you can use DCS_use(RID) instead
print(DCS_evaluateWhereExpression(e1)); // without the previous statement (dcs.MakeContext();), you will get error at this line because there is no DCS context is set, so you can not use DCS_evaluateWhereExpression(e1)
dcs.Partly = false; // Not include the partly completed QASs
dcs.NotStarted = false; // Not include the not started QASs
dcs.Save(); // Must save to make the above statements applied on DCS, but this statement does not REBUILD the DCS</source> 
 

[[Category:Data_Types_Literals_and_Variables]]

Dictionary class

2011-09-22T08:41:17Z

Dennis:

{{CGscriptClass_Template
|Name=<nowiki>Dictionary</nowiki>
|Description=<nowiki>The dictionary object</nowiki>
|Constructors=
{{CGscriptConstructors_Template|Description=<nowiki>Create a new dictionary with non-argument.</nowiki>}}
{{CGscriptConstructors_Template|Parameters={{CGscriptParameters_Template|Type=params AnyType|Name=params AnyType|Description=}}
|Description=<nowiki>Create new dictionary with the specified key-value pairs.</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=array|Name=<nowiki>keys</nowiki>|Description=<nowiki>keys arrayConstant</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>values</nowiki>|Description=<nowiki>values arrayConstant</nowiki>}}
|Description=<nowiki>Create new dictionary with the specified keys and values.</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>Add</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>key</nowiki>|Description=<nowiki>Add with specific key</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=AnyType|Name=<nowiki>value</nowiki>|Description=<nowiki>Add with specific value</nowiki>}}
|Description=<nowiki>Adds the specified key and value to the dictionary.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>Add</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>key</nowiki>|Description=<nowiki>Add with specific key</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=AnyType|Name=<nowiki>value</nowiki>|Description=<nowiki>Add with specific value</nowiki>}}
|Description=<nowiki>Adds the specified key and value to the dictionary.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Clear</nowiki>|Description=<nowiki>Remove all keys and values from the dictionary.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>ContainsKey</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>key</nowiki>|Description=<nowiki>Check with specific key</nowiki>}}
|Description=<nowiki>Determines whether the dictionary contains the specified key.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>ContainsKey</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>key</nowiki>|Description=<nowiki>Check with specific key</nowiki>}}
|Description=<nowiki>Determines whether the dictionary contains the specified key.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>ContainsValue</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=AnyType|Name=<nowiki>value</nowiki>|Description=<nowiki>Add with specific value</nowiki>}}
|Description=<nowiki>Determines whether the dictionary contains the specified value.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=AnyType|Name=<nowiki>this[] { get; }</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>key</nowiki>|Description=<nowiki>The key used to lookup the value.</nowiki>}}
|Description=<nowiki>Get an item based on a key.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=AnyType|Name=<nowiki>this[] { get; }</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>key</nowiki>|Description=<nowiki>The key used to lookup the value.</nowiki>}}
|Description=<nowiki>Get an item based on a key.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=AnyType|Name=<nowiki>Remove</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>key</nowiki>|Description=<nowiki>Check with specific key</nowiki>}}
|Description=<nowiki>Remove the value with the specified key from the dictionary.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=AnyType|Name=<nowiki>Remove</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>key</nowiki>|Description=<nowiki>Remove with specific key</nowiki>}}
|Description=<nowiki>Remove the value with the specified key from the dictionary.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>this[] { set; }</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>key</nowiki>|Description=<nowiki>The key used to lookup the value.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=AnyType|Name=<nowiki>value</nowiki>|Description=<nowiki>The value to set.</nowiki>}}
|Description=<nowiki>Set an item based on a key and a value.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>this[] { set; }</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>key</nowiki>|Description=<nowiki>The key used to lookup the value.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=AnyType|Name=<nowiki>value</nowiki>|Description=<nowiki>The value to set.</nowiki>}}
|Description=<nowiki>Set an item based on a key and a value.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=AnyType|Name=<nowiki>TryGetValue</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>key</nowiki>|Description=<nowiki>Remove with specific key</nowiki>}}
|Description=<nowiki>Gets the value associated with the specified key.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=AnyType|Name=<nowiki>TryGetValue</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>key</nowiki>|Description=<nowiki>Remove with specific key</nowiki>}}
|Description=<nowiki>Gets the value associated with the specified key.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Count</nowiki>|HasGetter=1|Description=<nowiki>Gets the number of key/value pairs contained in the dictionary.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>Keys</nowiki>|HasGetter=1|Description=<nowiki>Gets a list of keys.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>SortedKeys</nowiki>|HasGetter=1|Description=<nowiki>Gets a list of keys sorted by current collation.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>Values</nowiki>|HasGetter=1|Description=<nowiki>Gets a list of values.</nowiki>}}
}}

==== '''Examples''' ====

<source lang="javascript">Dictionary d;
print(d); // {}</source> 

<source lang="javascript">Dictionary d = new Dictionary();
print(d); // {}</source> 

<source lang="javascript">Dictionary d = {"key1": 1, "key2": 2};
print(d); // {"key1": 1, "key2": 2}</source> 

<source lang="javascript">Dictionary d = {}; // Not work, will cause error.</source> 

<source lang="javascript">Dictionary d1 = new Dictionary("key_01","value01");
print(d1); // {"key_01": sdasd}
print(d1.Add("key_02",2222));
print(d1.Add(3,"hello3333"));
print(d1.Add("key_03",{"happy",48,{"funny","sad",88}}));
print(d1); // {"3": hello3333, "key_01": value01, "key_02": 2222, "key_03": {happy,48,{funny,sad,88}}}
print(d1.ContainsKey("key_01")); // true
print(d1.ContainsKey(3)); // true
print(d1.ContainsKey("noexist")); // false
print(d1.ContainsValue("value01")); // true
print(d1.ContainsValue(2222)); // true
print(d1.ContainsValue({"happy",48,{"funny","sad",88}})); // true
print(d1.get_Item("key_01")); // value01
print(d1.get_Item(3)); // hello3333
print(d1.set_Item("key01",1111));
print(d1.set_Item(3,{3333,"string333"}));
print(d1.TryGetValue("key_01")); // value01
print(d1.TryGetValue(3)); // {3333,"string333"}
print(d1); // {"3": {3333,string333}, "key_01": value01, "key_02": 2222, "key_03": {happy,48,{funny,sad,88}}, "key01": 1111}
print(d1.Count); // 5
print(d1.Keys); // {key_01,key_02,3,key_03,key01}
print(d1.Values); // {value01,2222,{3333,string333},{happy,48,{funny,sad,88}},1111}
print(d1.Remove("key_01")); // value01
print(d1.Remove(3)); // {3333,string333}
print(d1); // {"key_02": 2222, "key_03": {happy,48,{funny,sad,88}}, "key01": 1111}</source> 

<source lang="javascript">Dictionary d =
{
"key01": "value01",
5: "value05"
};
print(d["key01"]); // another way to get the values of keys
print(d[5]); // another way to get the values of keys</source>

[[Category:Data_Types_Literals_and_Variables]]

Function class

2011-09-22T08:40:20Z

Dennis:

{{CGscriptClass_Template
|Name=<nowiki>Function</nowiki>
|Description=<nowiki>The function object</nowiki>
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>functionName</nowiki>|Description=<nowiki>Name of the variable defined as a function</nowiki>}}
|Description=<nowiki>Create a new function that will reuse an existing function</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=AnyType|Name=<nowiki>Call</nowiki>|Parameters={{CGscriptParameters_Template|Type=params AnyType|Name=params AnyType|Description=}}
|Description=<nowiki>Evaluate a function with positional parameters.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=AnyType|Name=<nowiki>Invoke</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=array|Name=<nowiki>param</nowiki>|Description=<nowiki>The parameters given to the function mapped to the position used in the definition</nowiki>}}
|Description=<nowiki>Evaluate a function with positional parameters.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=AnyType|Name=<nowiki>Invoke</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=Dictionary|Name=<nowiki>param</nowiki>|Description=<nowiki>The parameters given to the function mapped to the names used in the definition</nowiki>}}
|Description=<nowiki>Evaluate a function with named parameters.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

==== '''Scoping of variables''' ====

'''Ex1:'''

<source lang="javascript">function a = function ()
{
number b = 1;
return true;
};
print(b); // Not work, get error: Undefined variable name: 'b'. @</source>

'''Ex2:'''

<source lang="javascript">number i = 10;
function a = function () {
print(i);
print(b);
};
number b = 20;
a.Call(); // 10 20</source>

'''Ex3:'''

<source lang="javascript">number i = 10;
function a = function () {
print(i);
print(b);
};
a.Call(); // Not work, get error: Undefined variable name: 'b'. @
number b = 20;</source>

'''Ex4:'''

<source lang="javascript">number i = 10;
function a = function (number i) {
print(i);
};
a.Call(100); // 100
print(i); // 10</source>

'''Ex5:'''

<source lang="javascript">number i = 10;
function a = function () {
number i = 100;
print(i);
};
a.Call(); // Not work, get error: Illegal variable re-declaration @</source>  

 

==== '''Recursion''' ====

'''Ex1:'''

<source lang="javascript">function a = function (number i)
{
if (i == 0) return;
a.Call(i - 1);
return i;
};
a.Call(49); // Return 49</source>

'''Ex2:'''

<source lang="javascript">function a = function (number i){
if (i == 0) return;
a.Call(i - 1);
return i;
};
a.Call(50); // get error because the maximum limit of recursion is: 49</source>

 

==== '''Send function to Called Workflow''' ====

'''Ex1:'''

<source lang="javascript">// IN FIRST WORKFLOW
function x = function (number a, number b) {
return a + b;
};
Workflow_call(37248984, {x});

// IN SECOND (CALLED) WORKFLOW (Resource Id: 37248984)
array Workflow_parameters = Workflow_getParameters();
return Workflow_parameters[0].Call(1,2);
// ------get result: 3---------</source> '''Ex2:'''

<source lang="javascript">// IN FIRST WORKFLOW
number i = 10;
function x = function (number a, number b) {
return a + b + i;
};
Workflow_call(37248984, {x});

// IN SECOND (CALLED) WORKFLOW (Resource Id: 37248984)
array Workflow_parameters = Workflow_getParameters();
return Workflow_parameters[0].Call(1,2);
// ------get result: 13---------</source>

 

==== '''Examples''' ====

<source lang="javascript">function x = function (number a, number b, number c = 10)
{
number d = 1;
return a + b + c + d + p;
};
number p = 10;

print(x.Call(1,2));
print(x.Call(1,2,3));

function y = x;
print(y.Call(1,2));
print(y.Call(1,2,3));

function z = new Function("x"); // remmember that new Function("x") NOT new function("x")
print(z.Call(1,2));
print(z.Call(1,2,3));

function f; // will be empty
Function ff; // get error because there is no default constructor

array paraArray_a = {1,2};
array paraArray_b = {1,2,3};
print(x.Invoke(paraArray_a));
print(x.Invoke(paraArray_b));</source>

 <source lang="javascript">Dictionary dic1 = {"a": 1,"b": 2};
print(x.Invoke(dic1)); // 24

Dictionary dic2 = {"a": 1,"b": 2,"c": 3};
print(x.Invoke(dic2)); // 17

Dictionary dic3 = {"c": 3,"a": 1,"b": 2};
print(x.Invoke(dic3)); // 17

Dictionary dic = {"para_1": 1,"para_2": 2,"para_3": 3};
print(x.Invoke(dic)); // will cause error because the keys in dictionary not the same as name of parameters which is defined in function x</source> 

[[Category:Data_Types_Literals_and_Variables]]

Array class

2011-09-22T08:39:27Z

Dennis:

Template:CGscriptClass Template

2011-09-22T08:38:46Z

Dennis:

=== {{{Name|PLEASE INSERT CLASS NAME HERE}}} ===

{{{Description|}}}

{{#if: {{{Constructors|}}} | ===='''Constructors'''==== }}
{{{Constructors|}}}

{{#if: {{{Methods|}}} | ===='''Methods'''==== }}
{{{Methods|}}}

{{#if: {{{Properties|}}} | ===='''Properties'''==== }}
{{{Properties|}}}

[[Category:Data_Types_Literals_and_Variables]]

Template:CGscriptClass Template

2011-09-22T08:38:03Z

Dennis:

=== {{{Name|PLEASE INSERT CLASS NAME HERE}}} ===

{{{Description|}}}

{{#if: {{{Constructors|}}} | '''Constructors''' }}
{{{Constructors|}}}

{{#if: {{{Methods|}}} | '''Methods''' }}
{{{Methods|}}}

{{#if: {{{Properties|}}} | '''Properties''' }}
{{{Properties|}}}

[[Category:Data_Types_Literals_and_Variables]]

TypeInformation class

2011-09-22T08:33:48Z

Dennis: Created page with "{{CGscriptClass_Template |Name=<nowiki>TypeInformation</nowiki> |Description=<nowiki>Get information about this class</nowiki> |Constructors= {{CGscriptConstructors_Template|Para..."

{{CGscriptClass_Template
|Name=<nowiki>TypeInformation</nowiki>
|Description=<nowiki>Get information about this class</nowiki>
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>typename</nowiki>|Description=<nowiki>Type to get information on</nowiki>}}
|Description=<nowiki>Get Information about a specific type</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ClassDocumentation</nowiki>|HasGetter=1|Description=<nowiki>Information about this class.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ConstructorDocumentation</nowiki>|HasGetter=1|Description=<nowiki>Information about the constructors on this class.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>FullDocumentation</nowiki>|HasGetter=1|Description=<nowiki>Information about this class.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>MethodDocumentation</nowiki>|HasGetter=1|Description=<nowiki>Information about the methods on this class.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>PropertyDocumentation</nowiki>|HasGetter=1|Description=<nowiki>Information about the properties on this class.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>WikiDocumentation</nowiki>|HasGetter=1|Description=<nowiki>Information about this class in wiki format.</nowiki>}}
}}

Template:CGscriptMethods Template

2011-09-22T07:59:18Z

Dennis:

*'''{{#ifeq: {{{ReturnType|}}} | Empty | | {{CGscriptTypeColors_Template|Type={{{ReturnType|}}} }} }} {{{Name|}}}({{{Parameters|}}})''' - {{{Description|}}}

Template:CGscriptMethods Template

2011-09-22T07:59:05Z

Dennis:

*'''{{#ifeq {{{ReturnType|}}} | Empty | | {{CGscriptTypeColors_Template|Type={{{ReturnType|}}} }} }} {{{Name|}}}({{{Parameters|}}})''' - {{{Description|}}}

Template:CGscriptTypeColors Template

2011-09-22T07:56:13Z

Dennis:

{{#switch: {{{Type}}}


|array = [[Array_class|array]]
|function = [[Function_class|Function]]
|Dictionary = [[Dictionary_class|Dictionary]]
|number = [[Data_Types|number]]
|string = [[Data_Types|string]]
|bool = [[Data_Types|bool]]
|params AnyType = params AnyType
|AnyType = AnyType
|Empty = Empty


| #default = [[{{{Type}}}_class|{{{Type}}}]]
}}

Template:CGscriptTypeColors Template

2011-09-22T07:54:38Z

Dennis:

{{#switch: {{{Type}}}


|array = [[Array_class|array]]
|function = [[Function_class|Function]]
|Dictionary = [[DictionaryClass|Dictionary]]
|number = [[Number_Class|number]]
|string = [[String_Class|string]]
|bool = [[Boolean_Class|bool]]
|params AnyType = params AnyType
|AnyType = AnyType
|Empty = Empty


| #default = [[{{{Type}}}_class|{{{Type}}}]]
}}

Template:CGscriptTypeColors Template

2011-09-22T07:54:18Z

Dennis:

{{#switch: {{{Type}}}


|array = [[Array_Class|array]]
|function = [[Function_class|Function]]
|Dictionary = [[DictionaryClass|Dictionary]]
|number = [[Number_Class|number]]
|string = [[String_Class|string]]
|bool = [[Boolean_Class|bool]]
|params AnyType = params AnyType
|AnyType = AnyType
|Empty = Empty


| #default = [[{{{Type}}}_class|{{{Type}}}]]
}}

Template:CGscriptConstructors Template

2011-09-22T07:37:34Z

Dennis:

*'''({{{Parameters|}}})''' - {{{Description|}}}

Template:CGscriptClass Template

2011-09-22T07:31:03Z

Dennis: