ResourceTemplatePropertySingle class: Difference between revisions
From Catglobe Wiki
More actions
Nguyenduyan (talk | contribs) No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{CGscriptClass_Template | {{CGscriptClass_Template | ||
|Name=ResourceTemplatePropertySingle | |Name=<nowiki>ResourceTemplatePropertySingle</nowiki> | ||
|Description=A Single property on a resource template | |Description=<nowiki>A Single property on a resource template</nowiki> | ||
|Constructors= | |Constructors= | ||
{{CGscriptConstructors_Template|Parameters= | {{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}} | {{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=Create new Single property}} | |Description=<nowiki>Create new Single property</nowiki>}} | ||
|Methods= | |Methods= | ||
{{CGscriptMethods_Template|ReturnType=Empty|Name=DefaultLanguage|Parameters= | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>DefaultLanguage</nowiki>|Parameters= | ||
{{CGscriptParameters_Template|Type=string|Name=isocode|Description=Iso code to set as default}} | {{CGscriptParameters_Template|Type=string|Name=<nowiki>isocode</nowiki>|Description=<nowiki>Iso code to set as default</nowiki>}} | ||
|Description=Which Localized Name is the default}} | |Description=<nowiki>Which Localized Name is the default</nowiki>}} | ||
{{CGscriptMethods_Template|ReturnType=Empty|Name=Delete|Description=Delete the property}} | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Delete</nowiki>|Description=<nowiki>Delete the property</nowiki>}} | ||
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=GetLocalizedNames|Parameters= | {{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>GetLocalizedNames</nowiki>|Parameters= | ||
{{CGscriptParameters_Template|Type=int|Name=index|Description=Index}} | {{CGscriptParameters_Template|Type=int|Name=<nowiki>index</nowiki>|Description=<nowiki>Index</nowiki>}} | ||
|Description=Localized Name of the option with the given index}} | |Description=<nowiki>Localized Name of the option with the given index</nowiki>}} | ||
{{CGscriptMethods_Template|ReturnType=Empty|Name=RemoveOption|Parameters= | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RemoveOption</nowiki>|Parameters= | ||
{{CGscriptParameters_Template|Type=int|Name=index|Description=Index}} | {{CGscriptParameters_Template|Type=int|Name=<nowiki>index</nowiki>|Description=<nowiki>Index</nowiki>}} | ||
|Description=Remove option with the given index}} | |Description=<nowiki>Remove option with the given index</nowiki>}} | ||
{{CGscriptMethods_Template|ReturnType=Empty|Name=SetLocalizedNames|Parameters= | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetLocalizedNames</nowiki>|Parameters= | ||
{{CGscriptParameters_Template|Type=int|Name=index|Description=Index|Comma=,}}{{CGscriptParameters_Template|Type=Dictionary|Name=localizedNames|Description=Dictionary of iso and translation}} | {{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=Localized Name of the option with the given index}} | |Description=<nowiki>Localized Name of the option with the given index</nowiki>}} | ||
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}} | {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}} | ||
|Properties= | |Properties= | ||
{{CGscriptProperties_Template|ReturnType=string|Name=Description|HasGetter=1|HasSetter=1|Description=Get/set Description}} | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Description</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Description</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=string|Name=Label|HasGetter=1|HasSetter=1|Description=Get/set Label}} | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Label</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Label</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=int|Name=NumberOfOptions|HasGetter=1|Description=Number of options}} | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfOptions</nowiki>|HasGetter=1|Description=<nowiki>Number of options</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}} | {{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=Required|HasGetter=1|HasSetter=1|Description=Get/set Required}} | {{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Required</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Required</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}} | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}} | ||
}} | }} | ||
=== <span style="color:#DF8621">'''Examples'''</span> === | === <span style="color:#DF8621">'''Examples'''</span> === | ||
Revision as of 02:27, 28 February 2019
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 @