Difference between revisions of "ResourceTemplatePropertyNumber class"
Nguyenduyan (talk | contribs) |
|||
| Line 1: | Line 1: | ||
{{CGscriptClass_Template | {{CGscriptClass_Template | ||
| − | |Name=ResourceTemplatePropertyNumber | + | |Name=<nowiki>ResourceTemplatePropertyNumber</nowiki> |
| − | |Description=A numeric property on a resource template | + | |Description=<nowiki>A numeric property on a resource template</nowiki> |
|Constructors= | |Constructors= | ||
{{CGscriptConstructors_Template|Parameters= | {{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}} | + | {{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>}} |
| − | |Description=Create new numeric property}} | + | |Description=<nowiki>Create new numeric property</nowiki>}} |
|Methods= | |Methods= | ||
| − | {{CGscriptMethods_Template|ReturnType=Empty|Name=Delete|Description=Delete the property}} | + | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Delete</nowiki>|Description=<nowiki>Delete the property</nowiki>}} |
| − | {{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}} | + | {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}} |
|Properties= | |Properties= | ||
| − | {{CGscriptProperties_Template|ReturnType=string|Name=Description|HasGetter=1|HasSetter=1|Description=Get/set Description}} | + | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Description</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Description</nowiki>}} |
| − | {{CGscriptProperties_Template|ReturnType=bool|Name=IsDecimal|HasGetter=1|HasSetter=1|Description=Get/set IsDecimal}} | + | {{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsDecimal</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set IsDecimal</nowiki>}} |
| − | {{CGscriptProperties_Template|ReturnType=string|Name=Label|HasGetter=1|HasSetter=1|Description=Get/set Label}} | + | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Label</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Label</nowiki>}} |
| − | {{CGscriptProperties_Template|ReturnType=number|Name=MaxValue|HasGetter=1|HasSetter=1|Description=Get/set MaxValue, -1 if unset}} | + | {{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>MaxValue</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set MaxValue, -1 if unset</nowiki>}} |
| − | {{CGscriptProperties_Template|ReturnType=number|Name=MinValue|HasGetter=1|HasSetter=1|Description=Get/set MinValue, -1 if unset}} | + | {{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>MinValue</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set MinValue, -1 if unset</nowiki>}} |
| − | {{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}} | + | {{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=Required|HasGetter=1|HasSetter=1|Description=Get/set Required}} | + | {{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Required</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Required</nowiki>}} |
| − | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}} | + | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}} |
}} | }} | ||
| − | |||
=== <span style="color:#DF8621">'''Examples'''</span> === | === <span style="color:#DF8621">'''Examples'''</span> === | ||
Revision as of 04:25, 28 February 2019
ResourceTemplatePropertyNumber
A numeric property on a resource template
Constructors
- (string label "Set label", bool required "Set required", string description "Set description", ResourceTemplate resourceTemplate "ResourceTemplate property gets added to") - Create new numeric property
Methods
Properties
- string Description { get; set; } - Get/set Description
- bool IsDecimal { get; set; } - Get/set IsDecimal
- string Label { get; set; } - Get/set Label
- number MaxValue { get; set; } - Get/set MaxValue, -1 if unset
- number MinValue { get; set; } - Get/set MinValue, -1 if unset
- string ObjectTypeName { get; } - The name of the type of object.
- bool Required { get; set; } - Get/set Required
- 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);
new ResourceTemplatePropertyNumber ("propertyNameTypeNumber",false,"description",folderRT);
folderRT.SaveProperties();
//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();
//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();//if the property is in use, you can not delete and will get error message: Property in use @
