Toggle menu
875
3.8K
30.2K
279.1K
Catglobe Wiki
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

ResourceTemplatePropertyString class: Difference between revisions

From Catglobe Wiki
Nguyenduyan (talk | contribs)
No edit summary
No edit summary
Line 1: Line 1:
{{CGscriptClass_Template
{{CGscriptClass_Template
|Name=ResourceTemplatePropertyString
|Name=<nowiki>ResourceTemplatePropertyString</nowiki>
|Description=A string property on a resource template
|Description=<nowiki>A string 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 string property}}
|Description=<nowiki>Create new string property</nowiki>}}
|Methods=
|Methods=
{{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=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=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:29, 28 February 2019

ResourceTemplatePropertyString



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

Methods

  • Empty Delete() - Delete the property
  • string ToString() - The string representation of the object.

Properties

  • string Description { get; set; } - Get/set Description
  • string Label { get; set; } - Get/set Label
  • 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 ResourceTemplatePropertyString ("propertyNameTypeString",false,"description",folderRT);
 
folderRT.SaveProperties();


//Example for working with existing properies 
number folderResourceTemplateRId = 15547989;
ResourceTemplateHelper rth = new ResourceTemplateHelper ();
FolderResourceTemplate folderRT = rth.GetTemplate(folderResourceTemplateRId);  
ResourceTemplatePropertyString propertyString = folderRT.Properties.First(function (object p){return p.Label=="propertyNameTypeString";});
propertyString.Required =true; 
folderRT.SaveProperties();


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