Difference between revisions of "ResourceTemplatePropertyString class"

From Catglobe Wiki
Jump to: navigation, search
(Created page with "{{CGscriptClass_Template |Name=ResourceTemplatePropertyString |Description=A string property on a resource template |Constructors= {{CGscriptConstructors_Template|Parameters= ...")
 
Line 28: Line 28:
 
   
 
   
 
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);   
   
 
 
ResourceTemplatePropertyString propertyString = folderRT.Properties.First(function (object p){return p.Label=="propertyNameTypeString";});
 
ResourceTemplatePropertyString propertyString = folderRT.Properties.First(function (object p){return p.Label=="propertyNameTypeString";});
 
propertyString.Required =true;  
 
propertyString.Required =true;  
Line 43: Line 43:
 
number folderResourceTemplateRId = 15547989;
 
number folderResourceTemplateRId = 15547989;
 
ResourceTemplateHelper rth = new ResourceTemplateHelper ();
 
ResourceTemplateHelper rth = new ResourceTemplateHelper ();
FolderResourceTemplate folderRT = rth.GetTemplate(folderResourceTemplateRId);  
+
FolderResourceTemplate folderRT = rth.GetTemplate(folderResourceTemplateRId);   
   
 
 
ResourceTemplatePropertyString propertyString = folderRT.Properties.First(function (object p){return p.Label=="propertyNameTypeString";});
 
ResourceTemplatePropertyString propertyString = folderRT.Properties.First(function (object p){return p.Label=="propertyNameTypeString";});
propertyString.Delete();  
+
propertyString.Delete(); //if the property is in use, you can not delete and will get error message: Property in use @
 
</source>
 
</source>

Revision as of 09:39, 5 December 2016

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 @