Difference between revisions of "ResourceTemplatePropertyResource class"
| Line 2: | Line 2: | ||
|Name=<nowiki>ResourceTemplatePropertyResource</nowiki> | |Name=<nowiki>ResourceTemplatePropertyResource</nowiki> | ||
|Description=<nowiki>A Resource property on a resource template</nowiki> | |Description=<nowiki>A Resource property on a resource template</nowiki> | ||
| − | |Constructors= | + | |InheritsFrom=ResourceTemplateProperty|Constructors= |
{{CGscriptConstructors_Template|Parameters= | {{CGscriptConstructors_Template|Parameters= | ||
{{CGscriptParameters_Template|Type=string|Name=<nowiki>label</nowiki>|Description=<nowiki>Set label</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>required</nowiki>|Description=<nowiki>Set required</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>description</nowiki>|Description=<nowiki>Set description</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=ResourceTemplate|Name=<nowiki>resourceTemplate</nowiki>|Description=<nowiki>ResourceTemplate property gets added to</nowiki>}} | {{CGscriptParameters_Template|Type=string|Name=<nowiki>label</nowiki>|Description=<nowiki>Set label</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>required</nowiki>|Description=<nowiki>Set required</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>description</nowiki>|Description=<nowiki>Set description</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=ResourceTemplate|Name=<nowiki>resourceTemplate</nowiki>|Description=<nowiki>ResourceTemplate property gets added to</nowiki>}} | ||
| Line 13: | Line 13: | ||
{{CGscriptParameters_Template|Type=int|Name=<nowiki>resourceType</nowiki>|Description=<nowiki>ResourceType</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>specificResourceTemplates</nowiki>|Description=<nowiki>Array of resource template resource ids</nowiki>}} | {{CGscriptParameters_Template|Type=int|Name=<nowiki>resourceType</nowiki>|Description=<nowiki>ResourceType</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>specificResourceTemplates</nowiki>|Description=<nowiki>Array of resource template resource ids</nowiki>}} | ||
|Description=<nowiki>Set specific templates of given resource type allowed</nowiki>}} | |Description=<nowiki>Set specific templates of given resource type allowed</nowiki>}} | ||
| − | {{CGscriptMethods_Template|ReturnType=Array of | + | {{CGscriptMethods_Template|ReturnType=Array of ints|Name=<nowiki>AllowsResourceType</nowiki>|Parameters= |
{{CGscriptParameters_Template|Type=int|Name=<nowiki>resourceType</nowiki>|Description=<nowiki>ResourceType</nowiki>}} | {{CGscriptParameters_Template|Type=int|Name=<nowiki>resourceType</nowiki>|Description=<nowiki>ResourceType</nowiki>}} | ||
|Description=<nowiki>Get allowed resource templates resource ids for a given resource type. Empty means none, array with no entries means all.</nowiki>}} | |Description=<nowiki>Get allowed resource templates resource ids for a given resource type. Empty means none, array with no entries means all.</nowiki>}} | ||
| − | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Delete</nowiki>|Description=<nowiki>Delete the property</nowiki>}} | + | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Delete</nowiki>|Inherited=ResourceTemplateProperty|Description=<nowiki>Delete the property</nowiki>}} |
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RemoveAllowedResourceType</nowiki>|Parameters= | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RemoveAllowedResourceType</nowiki>|Parameters= | ||
{{CGscriptParameters_Template|Type=int|Name=<nowiki>resourceType</nowiki>|Description=<nowiki>ResourceType</nowiki>}} | {{CGscriptParameters_Template|Type=int|Name=<nowiki>resourceType</nowiki>|Description=<nowiki>ResourceType</nowiki>}} | ||
|Description=<nowiki>Set all templates of given resource type disallowed</nowiki>}} | |Description=<nowiki>Set all templates of given resource type disallowed</nowiki>}} | ||
| − | {{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=string|Name=<nowiki>Description</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Description</nowiki>}} | + | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Description</nowiki>|HasGetter=1|HasSetter=1|Inherited=ResourceTemplateProperty|Description=<nowiki>Get/set Description</nowiki>}} |
| − | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Label</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Label</nowiki>}} | + | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Label</nowiki>|HasGetter=1|HasSetter=1|Inherited=ResourceTemplateProperty|Description=<nowiki>Get/set Label</nowiki>}} |
{{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>Get/set Required</nowiki>}} | + | {{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Required</nowiki>|HasGetter=1|HasSetter=1|Inherited=ResourceTemplateProperty|Description=<nowiki>Get/set Required</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>}} |
}} | }} | ||
Latest revision as of 09:56, 2 July 2020
ResourceTemplatePropertyResource
A Resource property on a resource template
Parent class
Inherits from ResourceTemplateProperty
Constructors
- (string label "Set label", bool required "Set required", string description "Set description", ResourceTemplate resourceTemplate "ResourceTemplate property gets added to") - Create new Resource property
Methods
- Empty AddAllowedResourceType(int resourceType "ResourceType") - Set all templates of given resource type allowed
- Empty AddAllowedResourceType(int resourceType "ResourceType", array specificResourceTemplates "Array of resource template resource ids") - Set specific templates of given resource type allowed
- Array of int AllowsResourceType(int resourceType "ResourceType") - Get allowed resource templates resource ids for a given resource type. Empty means none, array with no entries means all.
- (From ResourceTemplateProperty) Empty Delete() - Delete the property
- Empty RemoveAllowedResourceType(int resourceType "ResourceType") - Set all templates of given resource type disallowed
- (From object) string ToString() - The string representation of the object.
Properties
- (From ResourceTemplateProperty) string Description { get; set; } - Get/set Description
- (From ResourceTemplateProperty) string Label { get; set; } - Get/set Label
- string ObjectTypeName { get; } - The name of the type of object.
- (From ResourceTemplateProperty) bool Required { get; set; } - Get/set Required
- (From object) TypeInformation TypeInformation { get; } - Get information about this class.
Examples
//Example for creating new properties
number folderResourceTemplateRId = 15547989;
ResourceTemplateHelper rth = new ResourceTemplateHelper ();
FolderResourceTemplate folderRT = rth.GetTemplate(folderResourceTemplateRId);
ResourceTemplatePropertyResource propertyResource = new ResourceTemplatePropertyResource ("propertyNameTypeResource", false, "", folderRT);
propertyResource.AddAllowedResourceType(Resource_Type_Folder,{2071,15504791});
folderRT.SaveProperties();
//Example for working with existing properies
number folderResourceTemplateRId = 15547989;
ResourceTemplateHelper rth = new ResourceTemplateHelper ();
FolderResourceTemplate folderRT = rth.GetTemplate(folderResourceTemplateRId);
ResourceTemplatePropertyResource propertyResource = folderRT.Properties.First(function (object p){return p.Label=="propertyNameTypeResource";});
propertyResource.RemoveAllowedResourceType(Resource_Type_Report);
propertyResource.AddAllowedResourceType(Resource_Type_Folder);
propertyResource.AddAllowedResourceType(Resource_Type_Project,{4624,2070});
folderRT.SaveProperties();
print(propertyResource.AllowsResourceType(Resource_Type_Project));//return array of ResourceId of project template {2070,4624}
//Example for deleting property
number folderResourceTemplateRId = 15547989;
ResourceTemplateHelper rth = new ResourceTemplateHelper ();
FolderResourceTemplate folderRT = rth.GetTemplate(folderResourceTemplateRId);
ResourceTemplatePropertyResource propertyResource = folderRT.Properties.First(function (object p){return p.Label=="propertyNameTypeResource";});
propertyResource.Delete();//if the property is in use, you can not delete and will get error message: Property in use @
