Difference between revisions of "RoleExtensionParameterDocumentation class"
(Created page with "{{CGscriptClass_Template |Name=<nowiki>RoleExtensionParameterDocumentation</nowiki> |Description=<nowiki>Documents how a given role extension can be called</nowiki> |Construct...") |
(Tag: visualeditor) |
||
| Line 14: | Line 14: | ||
{{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|Description=<nowiki>Get information about this class.</nowiki>}} | ||
}} | }} | ||
| + | [[Category:Roles]] | ||
Revision as of 08:28, 19 December 2019
RoleExtensionParameterDocumentation
Documents how a given role extension can be called
Constructors
- () - Make new documentation
Methods
- 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.
- TypeInformation TypeInformation { get; } - Get information about this class.
