RoleExtensionRoleDocumentation class

RoleExtensionRoleDocumentation

Documents how a given role extension can be called on a role

Parent class

Inherits from RoleExtensionDocumentation

Constructors

• () - Make new documentation
  

Methods

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

Properties

• (From RoleExtensionDocumentation) LocalizedString Description { get; } - A short description of the functionality for an admin user to better understand what it actually does.
  
• (From RoleExtensionDocumentation) bool IncludeChildrenInPath { get; set; } - If true and LimitToPath is set, then LimitToPath applies to any role with the path as prefix. Default is false.
  
• (From RoleExtensionDocumentation) string LimitToPath { get; set; } - If set, only roles in a given path are applicable for this role extensions. Default is Empty.
  
• (From RoleExtensionDocumentation) 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.
  
• (From RoleExtensionDocumentation) Array of RoleExtensionParameterDocumentation Parameters { get; set; } - Documentation for possible parameters.
  
• (From RoleExtensionDocumentation) 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.
  
• (From RoleExtensionDocumentation) 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.
  
• (From RoleExtensionDocumentation) 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.
  
• (From RoleExtensionDocumentation) 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.
  
• (From object) TypeInformation TypeInformation { get; } - Get information about this class.