|
|
| Line 1: |
Line 1: |
| {{CGscriptClass_Template
| | [[Category:Archive]] |
| |Name=ResourceTemplatePropertyString
| |
| |Description=A string 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 string 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=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);
| |
|
| |
| new ResourceTemplatePropertyString ("propertyNameTypeString",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);
| |
|
| |
| ResourceTemplatePropertyString propertyString = folderRT.Properties.First(function (object p){return p.Label=="propertyNameTypeString";});
| |
| propertyString.Required =true;
| |
| folderRT.SaveProperties();
| |
| </source>
| |
| | |
| <br/><source lang="javascript">
| |
| //Example for deleting properies
| |
| number folderResourceTemplateRId = 15547989;
| |
| ResourceTemplateHelper rth = new ResourceTemplateHelper ();
| |
| FolderResourceTemplate folderRT = rth.GetTemplate(folderResourceTemplateRId);
| |
|
| |
| ResourceTemplatePropertyString propertyString = folderRT.Properties.First(function (object p){return p.Label=="propertyNameTypeString";});
| |
| propertyString.Delete();
| |
| </source>
| |
