Difference between revisions of "FunctionInformation class"

From Catglobe Wiki
Jump to: navigation, search
Line 13: Line 13:
 
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>WikiDocumentation</nowiki>|HasGetter=1|Description=<nowiki>Information about this function in wiki format.</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>WikiDocumentation</nowiki>|HasGetter=1|Description=<nowiki>Information about this function in wiki format.</nowiki>}}
 
}}
 
}}
 +
 +
<source lang="javascript">
 +
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
 +
}}
 +
 +
</source>

Revision as of 10:53, 19 December 2011

FunctionInformation



Get information about a specific CGScript methods (CGScript functions)

Constructors

  • (string functionname "Method to get information on") - Get Information about a specific 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.


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
}}