Difference between revisions of "ResourceTemplatePropertyNumber"

From Catglobe Wiki
Jump to: navigation, search
(Replaced content with "Category:Archive")
 
Line 1: Line 1:
{{CGscriptClass_Template
+
[[Category:Archive]]
|Name=ResourceTemplatePropertyNumber
 
|Description=A numeric 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 numeric property}}
 
|Methods=
 
{{CGscriptMethods_Template|ReturnType=Empty|Name=Delete|Description=Delete the property}}
 
{{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=bool|Name=IsDecimal|HasGetter=1|HasSetter=1|Description=Get/set IsDecimal}}
 
{{CGscriptProperties_Template|ReturnType=string|Name=Label|HasGetter=1|HasSetter=1|Description=Get/set Label}}
 
{{CGscriptProperties_Template|ReturnType=number|Name=MaxValue|HasGetter=1|HasSetter=1|Description=Get/set MaxValue, -1 if unset}}
 
{{CGscriptProperties_Template|ReturnType=number|Name=MinValue|HasGetter=1|HasSetter=1|Description=Get/set MinValue, -1 if unset}}
 
{{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);
 
 
new ResourceTemplatePropertyNumber ("propertyNameTypeNumber",false,"description",folderRT);
 
 
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);
 
 
array arrayProperty = folderRT.Properties;
 
ResourceTemplatePropertyNumber propertyNumber = arrayProperty[0];
 
propertyNumber.IsDecimal=true;
 
propertyNumber.MaxValue=5;
 
propertyNumber.MaxValue=1;
 
folderRT.SaveProperties();
 
 
 
</source><br/><source lang="javascript">
 
//Example for deleting a property
 
number folderResourceTemplateRId = 15547989;
 
ResourceTemplateHelper rth = new ResourceTemplateHelper ();
 
FolderResourceTemplate folderRT = rth.GetTemplate(folderResourceTemplateRId);
 
 
 
ResourceTemplatePropertyNumber propertyNumber = folderRT.Properties.First(function (object p){return p.Label=="propertyNameTypeNumber";});
 
propertyNumber.Delete();
 
</source>
 

Latest revision as of 09:47, 24 November 2016