Difference between revisions of "ResourceTemplatePropertyResource"

From Catglobe Wiki
Jump to: navigation, search
(Replaced content with "Category:Archive")
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{CGscriptClass_Template
+
[[Category:Archive]]
|Name=ResourceTemplatePropertyResource
 
|Description=A Resource property on a resource template
 
|Constructors=
 
{{CGscriptConstructors_Template|Parameters=
 
{{CGscriptParameters_Template|Type=string|Name=label|Description=Set label|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=required|Description=Set required|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=description|Description=Set description|Comma=,}}{{CGscriptParameters_Template|Type=ResourceTemplate|Name=resourceTemplate|Description=ResourceTemplate property gets added to}}
 
|Description=Create new Resource property}}
 
|Methods=
 
{{CGscriptMethods_Template|ReturnType=Empty|Name=AddAllowedResourceType|Parameters=
 
{{CGscriptParameters_Template|Type=int|Name=resourceType|Description=ResourceType}}
 
|Description=Set all templates of given resource type allowed}}
 
{{CGscriptMethods_Template|ReturnType=Empty|Name=AddAllowedResourceType|Parameters=
 
{{CGscriptParameters_Template|Type=int|Name=resourceType|Description=ResourceType|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=specificResourceTemplates|Description=Array of resource template resource ids}}
 
|Description=Set specific templates of given resource type allowed}}
 
{{CGscriptMethods_Template|ReturnType=Array of numbers|Name=AllowsResourceType|Parameters=
 
{{CGscriptParameters_Template|Type=int|Name=resourceType|Description=ResourceType}}
 
|Description=Get allowed resource templates resource ids for a given resource type. Empty means none, array with no entries means all.}}
 
{{CGscriptMethods_Template|ReturnType=Empty|Name=Delete|Description=Delete the property}}
 
{{CGscriptMethods_Template|ReturnType=Empty|Name=RemoveAllowedResourceType|Parameters=
 
{{CGscriptParameters_Template|Type=int|Name=resourceType|Description=ResourceType}}
 
|Description=Set all templates of given resource type disallowed}}
 
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
 
|Properties=
 
{{CGscriptProperties_Template|ReturnType=string|Name=Description|HasGetter=1|HasSetter=1|Description=Get/set Description}}
 
{{CGscriptProperties_Template|ReturnType=string|Name=Label|HasGetter=1|HasSetter=1|Description=Get/set Label}}
 
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}}
 
{{CGscriptProperties_Template|ReturnType=bool|Name=Required|HasGetter=1|HasSetter=1|Description=Get/set Required}}
 
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
 
}}
 
 
 
 
 
 
 
=== <span style="color:#DF8621">'''Examples'''</span> ===
 
 
 
<source lang="javascript">
 
//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();
 
</source><br/><source lang="javascript">
 
//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_Folder);
 
propertyResource.AddAllowedResourceType(Resource_Type_Report);
 
 
folderRT.SaveProperties();
 
</source>
 

Latest revision as of 08:48, 24 November 2016