Latest revision as of 07:25, 2 July 2020

ResourceTemplatePropertySingle

A Single property on a resource template

Parent class

Inherits from ResourceTemplatePropertySingleMulti

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

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

Properties

(From ResourceTemplateProperty) string Description { get; set; } - Get/set Description
(From ResourceTemplateProperty) string Label { get; set; } - Get/set Label
(From ResourceTemplatePropertySingleMulti) int NumberOfOptions { get; } - Number of options
string ObjectTypeName { get; } - The name of the type of object.
(From ResourceTemplateProperty) bool Required { get; set; } - Get/set Required
(From object) 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 @

@@ Line 2: / Line 2: @@
 |Name=<nowiki>ResourceTemplatePropertySingle</nowiki>
 |Description=<nowiki>A Single property on a resource template</nowiki>
-|Constructors=
+|InheritsFrom=ResourceTemplatePropertySingleMulti|Constructors=
 {{CGscriptConstructors_Template|Parameters=
 {{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=<nowiki>Create new Single property</nowiki>}}
 |Methods=
-{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>DefaultLanguage</nowiki>|Parameters=
+{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>DefaultLanguage</nowiki>|Inherited=ResourceTemplatePropertySingleMulti|Parameters=
 {{CGscriptParameters_Template|Type=string|Name=<nowiki>isocode</nowiki>|Description=<nowiki>Iso code to set as default</nowiki>}}
 |Description=<nowiki>Which Localized Name is the default</nowiki>}}
-{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Delete</nowiki>|Description=<nowiki>Delete the property</nowiki>}}
+{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Delete</nowiki>|Inherited=ResourceTemplateProperty|Description=<nowiki>Delete the property</nowiki>}}
-{{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>GetLocalizedNames</nowiki>|Parameters=
+{{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>GetLocalizedNames</nowiki>|Inherited=ResourceTemplatePropertySingleMulti|Parameters=
 {{CGscriptParameters_Template|Type=int|Name=<nowiki>index</nowiki>|Description=<nowiki>Index</nowiki>}}
 |Description=<nowiki>Localized Name of the option with the given index</nowiki>}}
-{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RemoveOption</nowiki>|Parameters=
+{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RemoveOption</nowiki>|Inherited=ResourceTemplatePropertySingleMulti|Parameters=
 {{CGscriptParameters_Template|Type=int|Name=<nowiki>index</nowiki>|Description=<nowiki>Index</nowiki>}}
 |Description=<nowiki>Remove option with the given index</nowiki>}}
-{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetLocalizedNames</nowiki>|Parameters=
+{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetLocalizedNames</nowiki>|Inherited=ResourceTemplatePropertySingleMulti|Parameters=
 {{CGscriptParameters_Template|Type=int|Name=<nowiki>index</nowiki>|Description=<nowiki>Index</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=Dictionary|Name=<nowiki>localizedNames</nowiki>|Description=<nowiki>Dictionary of iso and translation</nowiki>}}
 |Description=<nowiki>Localized Name of the option with the given index</nowiki>}}
-{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
+{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}}
 |Properties=
-{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Description</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Description</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Description</nowiki>|HasGetter=1|HasSetter=1|Inherited=ResourceTemplateProperty|Description=<nowiki>Get/set Description</nowiki>}}
-{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Label</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Label</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Label</nowiki>|HasGetter=1|HasSetter=1|Inherited=ResourceTemplateProperty|Description=<nowiki>Get/set Label</nowiki>}}
-{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfOptions</nowiki>|HasGetter=1|Description=<nowiki>Number of options</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfOptions</nowiki>|HasGetter=1|Inherited=ResourceTemplatePropertySingleMulti|Description=<nowiki>Number of options</nowiki>}}
 {{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=<nowiki>Required</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Required</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Required</nowiki>|HasGetter=1|HasSetter=1|Inherited=ResourceTemplateProperty|Description=<nowiki>Get/set Required</nowiki>}}
-{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}}
 }}