Difference between revisions of "RoleExtensionRoleDocumentation class"
(Created page with "{{CGscriptClass_Template |Name=<nowiki>RoleExtensionRoleDocumentation</nowiki> |Description=<nowiki>Documents how a given role extension can be called on a role</nowiki> |Cons...") (Tag: visualeditor-switched) |
(Tag: visualeditor) |
||
| Line 21: | Line 21: | ||
{{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 07:22, 19 December 2019
RoleExtensionRoleDocumentation
Documents how a given role extension can be called on a role
Constructors
- () - Make new documentation
Methods
- string ToString() - The string representation of the object.
Properties
- LocalizedString Description { get; } - A short description of the functionality for an admin user to better understand what it actually does.
- bool IncludeChildrenInPath { get; set; } - If true and LimitToPath is set, then LimitToPath applies to any role with the path as prefix. Default is false.
- string LimitToPath { get; set; } - If set, only roles in a given path are applicable for this role extensions. Default is Empty.
- LocalizedString Name { get; } - The name of the functionality for an admin user to see.
- string ObjectTypeName { get; } - The name of the type of object.
- bool OnParent { get; set; } - If true, applicable to the parent folder of the role. Default is false.
- Array of RoleExtensionParameterDocumentation Parameters { get; set; } - Documentation for possible parameters.
- bool PathIsRelative { get; set; } - If true, the path is a postfix on the Top level parent that the role extension is defined on. Default is true.
- int PermissionRequired { get; set; } - Minimum access required on a user/role to be able to do it's function: 2 = needs read access, 4 = write access, 6 = full access. Default is 4.
- Array of RoleExtensionQueryValueDocumentation Result { get; set; } - Documentation for return value of calling the script.
- bool RoleRequired { get; set; } - If true, the parameter applicable to the parent folder of the role. Default is false.
- bool ShowResultInGrid { get; set; } - If true, values returned by this script in query mode is suitable to be shown in the user/role grid, no parameters are allowed if true. Default is true.
- TypeInformation TypeInformation { get; } - Get information about this class.
