RoleExtensionParameterDocumentation class: Difference between revisions
From Catglobe Wiki
More actions
No edit summary |
No edit summary |
||
| Line 2: | Line 2: | ||
|Name=<nowiki>RoleExtensionParameterDocumentation</nowiki> | |Name=<nowiki>RoleExtensionParameterDocumentation</nowiki> | ||
|Description=<nowiki>Documents how a given role extension can be called</nowiki> | |Description=<nowiki>Documents how a given role extension can be called</nowiki> | ||
|Constructors= | |InheritsFrom=object|Constructors= | ||
{{CGscriptConstructors_Template|Description=<nowiki>Make new documentation</nowiki>}} | {{CGscriptConstructors_Template|Description=<nowiki>Make new documentation</nowiki>}} | ||
|Methods= | |Methods= | ||
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}} | {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}} | ||
|Properties= | |Properties= | ||
{{CGscriptProperties_Template|ReturnType=LocalizedString|Name=<nowiki>Description</nowiki>|HasGetter=1|Description=<nowiki>A short description of the parameter for an admin user to better understand what it actually does.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=LocalizedString|Name=<nowiki>Description</nowiki>|HasGetter=1|Description=<nowiki>A short description of the parameter for an admin user to better understand what it actually does.</nowiki>}} | ||
| Line 12: | Line 12: | ||
{{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>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Required</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>True if value must be provided. Default is false.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Required</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>True if value must be provided. Default is false.</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}} | ||
}} | }} | ||
[[Category:Roles]] | [[Category:Roles]] | ||
Latest revision as of 07:21, 2 July 2020
RoleExtensionParameterDocumentation
Documents how a given role extension can be called
Parent class
Inherits from object
Constructors
- () - Make new documentation
Methods
- (From object) string ToString() - The string representation of the object.
Properties
- LocalizedString Description { get; } - A short description of the parameter for an admin user to better understand what it actually does.
- int InputType { get; set; } - Type of value it must contains, 1 = bool, 2 = int, 3 = single line string, 4 = date.
- LocalizedString Name { get; } - The name of the parameter for an admin user to see.
- string ObjectTypeName { get; } - The name of the type of object.
- bool Required { get; set; } - True if value must be provided. Default is false.
- (From object) TypeInformation TypeInformation { get; } - Get information about this class.