Difference between revisions of "ResourceTemplatePropertyMulti"

From Catglobe Wiki
Jump to: navigation, search
(Replaced content with "Category:Archive")
 
Line 1: Line 1:
{{CGscriptClass_Template
+
[[Category:Archive]]
|Name=ResourceTemplatePropertyMulti
 
|Description=A Multi 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 Multi property}}
 
|Methods=
 
{{CGscriptMethods_Template|ReturnType=Empty|Name=DefaultLanguage|Parameters=
 
{{CGscriptParameters_Template|Type=string|Name=isocode|Description=Iso code to set as default}}
 
|Description=Which Localized Name is the default}}
 
{{CGscriptMethods_Template|ReturnType=Empty|Name=Delete|Description=Delete the property}}
 
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=GetLocalizedNames|Parameters=
 
{{CGscriptParameters_Template|Type=int|Name=index|Description=Index}}
 
|Description=Localized Name of the option with the given index}}
 
{{CGscriptMethods_Template|ReturnType=Empty|Name=RemoveOption|Parameters=
 
{{CGscriptParameters_Template|Type=int|Name=index|Description=Index}}
 
|Description=Remove option with the given index}}
 
{{CGscriptMethods_Template|ReturnType=Empty|Name=SetLocalizedNames|Parameters=
 
{{CGscriptParameters_Template|Type=int|Name=index|Description=Index|Comma=,}}{{CGscriptParameters_Template|Type=Dictionary|Name=localizedNames|Description=Dictionary of iso and translation}}
 
|Description=Localized Name of the option with the given index}}
 
{{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=int|Name=NumberOfOptions|HasGetter=1|Description=Number of options}}
 
{{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 ResourceTemplatePropertyMulti ("propertyNameTypeMulti",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);
 
 
ResourceTemplatePropertyMulti propertyMulti = folderRT.Properties.First(function (object p){return p.Label=="propertyNameTypeMulti";});
 
propertyMulti.Required=true;
 
print(propertyMulti.NumberOfOptions);//1
 
print(propertyMulti.Label);//propertyNameTypeMulti
 
propertyMulti.Description="You can choose more than 1 option";
 
print(propertyMulti.GetLocalizedNames(0));//{"da-DK": name of option 0 in DK}
 
 
 
folderRT.SaveProperties();
 
</source><br/><source lang="javascript">
 
//Example for deleting property
 
 
 
number folderResourceTemplateRId = 15547989;
 
ResourceTemplateHelper rth = new ResourceTemplateHelper ();
 
FolderResourceTemplate folderRT = rth.GetTemplate(folderResourceTemplateRId);
 
 
ResourceTemplatePropertyMulti propertyMulti = folderRT.Properties.First(function (object p){return p.Label=="propertyNameTypeMulti";});
 
propertyMulti.Delete();
 
</source>
 
 
 
<br/><source lang="javascript">
 
//Example for Remove option on a multi property
 
 
 
number folderResourceTemplateRId = 15547989;
 
ResourceTemplateHelper rth = new ResourceTemplateHelper ();
 
FolderResourceTemplate folderRT = rth.GetTemplate(folderResourceTemplateRId);
 
 
ResourceTemplatePropertyMulti propertyMulti = folderRT.Properties.First(function (object p){return p.Label=="propertyNameTypeMulti";});
 
propertyMulti.RemoveOption(0);
 
 
 
</source>
 

Latest revision as of 09:46, 24 November 2016