ResourceTemplatePropertySingle class

From Catglobe Wiki
Revision as of 03:27, 28 February 2019 by Administrator (talk | contribs)
Jump to: navigation, search

ResourceTemplatePropertySingle



A Single 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 Single 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 ResourceTemplatePropertySingle ("propertyNameTypeSingle",true,"description",folderRT); 
folderRT.SaveProperties();


//Example for working with existing properies 
number folderResourceTemplateRId = 15547989;
ResourceTemplateHelper rth = new ResourceTemplateHelper ();
FolderResourceTemplate folderRT = rth.GetTemplate(folderResourceTemplateRId); 
ResourceTemplatePropertySingle propertySingle = folderRT.Properties.First(function (object p){return p.Label=="propertyNameTypeSingle";});
propertySingle.Description ;//description
propertySingle.Label ;//propertyNameTypeSingle
propertySingle.NumberOfOptions;//1
propertySingle.Required;//True
propertySingle.GetLocalizedNames(0);//{"da-DK": dd, "en-GB": dd}
propertySingle.RemoveOption(0);
//------------------
number folderResourceTemplateRId = 15547989;
ResourceTemplateHelper rth = new ResourceTemplateHelper ();
FolderResourceTemplate folderRT = rth.GetTemplate(folderResourceTemplateRId); 
ResourceTemplatePropertySingle propertySingle = folderRT.Properties.First(function (object p){return p.Label=="propertyNameTypeSingle";});
Dictionary localizedNames = {"da-DK":"name of option 0 in DK", "en-GB": "name of option 0 in UK", "en-US": "name of option 0 in US"};
propertySingle.SetLocalizedNames(0,localizedNames);
folderRT.SaveProperties();


//Example for deleting property
number folderResourceTemplateRId = 15547989;
ResourceTemplateHelper rth = new ResourceTemplateHelper ();
FolderResourceTemplate folderRT = rth.GetTemplate(folderResourceTemplateRId); 
ResourceTemplatePropertySingle propertySingle = folderRT.Properties.First(function (object p){return p.Label=="propertyNameTypeSingle";});
propertySingle.Delete();//if the property is in use, you can not delete and will get error message: Property in use @