Difference between revisions of "TypeInformation class"

From Catglobe Wiki
Jump to: navigation, search
Line 18: Line 18:
 
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>WikiDocumentation</nowiki>|HasGetter=1|Description=<nowiki>Information about this class in wiki format.</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>WikiDocumentation</nowiki>|HasGetter=1|Description=<nowiki>Information about this class in wiki format.</nowiki>}}
 
}}
 
}}
 +
 +
==== <span style="color:#a52a2a;">'''Examples'''</span>  ====
 +
Type below script into your workflow to get the results:
 +
<source lang="javascript">
 +
TypeInformation t = new TypeInformation("Dictionary");
 +
print(t.ClassDocumentation);
 +
print("================\n");
 +
 +
print(t.FullDocumentation);
 +
print("================\n");
 +
 +
print(t.ConstructorDocumentation);
 +
print("================\n");
 +
 +
print(t.MethodDocumentation);
 +
print("================\n");
 +
 +
print(t.PropertyDocumentation);
 +
print("================\n");
 +
 +
print(t.ObjectTypeName);
 +
print("================\n");
 +
 +
print(t.WikiDocumentation);
 +
</source>

Revision as of 10:21, 19 December 2011

TypeInformation



The TypeInformation object

Constructors

  • (string typename "Type to get information on") - Get Information about a specific class (object)

Methods

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

Properties

  • string ClassDocumentation { get; } - Brief information about this class (just class name and the short description about this class ).
  • string ConstructorDocumentation { get; } - Information about the constructors of this class.
  • string FullDocumentation { get; } - Full Information about this class.
  • string MethodDocumentation { get; } - Information about the methods of this class.
  • string ObjectTypeName { get; } - The name of the type of object.
  • string PropertyDocumentation { get; } - Information about the properties of this class.
  • TypeInformation TypeInformation { get; } - Get information about this class.
  • string WikiDocumentation { get; } - Information about this class in wiki format.


Examples

Type below script into your workflow to get the results:

TypeInformation t = new TypeInformation("Dictionary"); 
print(t.ClassDocumentation);
print("================\n");

print(t.FullDocumentation);
print("================\n");

print(t.ConstructorDocumentation);
print("================\n");

print(t.MethodDocumentation);
print("================\n");

print(t.PropertyDocumentation);
print("================\n");

print(t.ObjectTypeName);
print("================\n");

print(t.WikiDocumentation);