Difference between revisions of "ResourceTemplatePropertyMulti class"

From Catglobe Wiki
Jump to: navigation, search
(Created page with "{{CGscriptClass_Template |Name=ResourceTemplatePropertyMulti |Description=A Multi property on a resource template |Constructors= {{CGscriptConstructors_Template|Parameters= {{...")
 
Line 38: Line 38:
 
number folderResourceTemplateRId = 15547989;
 
number folderResourceTemplateRId = 15547989;
 
ResourceTemplateHelper rth = new ResourceTemplateHelper ();
 
ResourceTemplateHelper rth = new ResourceTemplateHelper ();
FolderResourceTemplate folderRT = rth.GetTemplate(folderResourceTemplateRId);
+
FolderResourceTemplate folderRT = rth.GetTemplate(folderResourceTemplateRId);  
 
 
new ResourceTemplatePropertyMulti ("propertyNameTypeMulti",false,"description",folderRT);
 
new ResourceTemplatePropertyMulti ("propertyNameTypeMulti",false,"description",folderRT);
 
 
folderRT.SaveProperties();
 
folderRT.SaveProperties();
</source><br/><source lang="javascript">
+
</source>
 +
<br/><source lang="javascript">
 
//Example for working with existing properies  
 
//Example for working with existing properies  
 
number folderResourceTemplateRId = 15547989;
 
number folderResourceTemplateRId = 15547989;
 
ResourceTemplateHelper rth = new ResourceTemplateHelper ();
 
ResourceTemplateHelper rth = new ResourceTemplateHelper ();
FolderResourceTemplate folderRT = rth.GetTemplate(folderResourceTemplateRId);  
+
FolderResourceTemplate folderRT = rth.GetTemplate(folderResourceTemplateRId);   
   
 
 
ResourceTemplatePropertyMulti propertyMulti = folderRT.Properties.First(function (object p){return p.Label=="propertyNameTypeMulti";});
 
ResourceTemplatePropertyMulti propertyMulti = folderRT.Properties.First(function (object p){return p.Label=="propertyNameTypeMulti";});
 
propertyMulti.Required=true;
 
propertyMulti.Required=true;
Line 55: Line 53:
 
propertyMulti.Description="You can choose more than 1 option";
 
propertyMulti.Description="You can choose more than 1 option";
 
print(propertyMulti.GetLocalizedNames(0));//{"da-DK": name of option 0 in DK}
 
print(propertyMulti.GetLocalizedNames(0));//{"da-DK": name of option 0 in DK}
 
+
propertyMulti.RemoveOption(0);
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>
 
</source>
 
 
<br/><source lang="javascript">
 
<br/><source lang="javascript">
//Example for Remove option on a multi property
+
//Example for deleting property
 
 
 
number folderResourceTemplateRId = 15547989;
 
number folderResourceTemplateRId = 15547989;
 
ResourceTemplateHelper rth = new ResourceTemplateHelper ();
 
ResourceTemplateHelper rth = new ResourceTemplateHelper ();
FolderResourceTemplate folderRT = rth.GetTemplate(folderResourceTemplateRId);  
+
FolderResourceTemplate folderRT = rth.GetTemplate(folderResourceTemplateRId);   
   
 
 
ResourceTemplatePropertyMulti propertyMulti = folderRT.Properties.First(function (object p){return p.Label=="propertyNameTypeMulti";});
 
ResourceTemplatePropertyMulti propertyMulti = folderRT.Properties.First(function (object p){return p.Label=="propertyNameTypeMulti";});
propertyMulti.RemoveOption(0);
+
propertyMulti.Delete();//if the property is in use, you can not delete and will get error message: Property in use @
 
 
 
</source>
 
</source>

Revision as of 08:17, 5 December 2016

ResourceTemplatePropertyMulti



A Multi 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 Multi property

Methods

  • Empty DefaultLanguage(string isocode "Iso code to set as default") - Which Localized Name is the default
  • Empty Delete() - Delete the property
  • Dictionary GetLocalizedNames(int index "Index") - Localized Name of the option with the given index
  • Empty RemoveOption(int index "Index") - Remove option with the given index
  • Empty SetLocalizedNames(int index "Index", Dictionary localizedNames "Dictionary of iso and translation") - Localized Name of the option with the given index
  • string ToString() - The string representation of the object.

Properties

  • string Description { get; set; } - Get/set Description
  • string Label { get; set; } - Get/set Label
  • int NumberOfOptions { get; } - Number of options
  • 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 ResourceTemplatePropertyMulti ("propertyNameTypeMulti",false,"description",folderRT);
folderRT.SaveProperties();


//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}
propertyMulti.RemoveOption(0);


//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();//if the property is in use, you can not delete and will get error message: Property in use @