Revision as of 08:58, 19 December 2011

FunctionInformation

The FunctionInformation Object

Constructors

(string functionname "Method to get information on") - Get Information about a specific CGScript function

Methods

string ToString() - The string representation of the object.

Properties

string ObjectTypeName { get; } - The name of the type of object.
TypeInformation TypeInformation { get; } - Get information about this class.
string WikiDocumentation { get; } - Information about this function in wiki format.

Examples

FunctionInformation info = new FunctionInformation("QAS_new");

print(info.ToString());  
// result:  FunctionInformation

print(info.ObjectTypeName);
// result:  FunctionInformation

print(info.TypeInformation);
// result:  TypeInformation

print(info.WikiDocumentation);      
/* result:  
{{Function_Template|Name=QAS_new|ReturnType=Array
|Parameters=
|Name=<nowiki>Project Questionnaire unique id</nowiki>|ConstantType=Number,
|Name=<nowiki>User unique id</nowiki>|IsOptional=1|ConstantType=Number
}}
*/

@@ Line 13: / Line 13: @@
 {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>WikiDocumentation</nowiki>|HasGetter=1|Description=<nowiki>Information about this function in wiki format.</nowiki>}}
 }}
-=Examples=
-==Examples==
+==== <span style="color:#a52a2a;">'''Examples'''</span>  ====
-===Examples===
-====Examples====
-=====Examples=====
-======Examples======
 <source lang="javascript">
 FunctionInformation info = new FunctionInformation("QAS_new");