Latest revision as of 09:45, 11 May 2026

Folder

Represents a Folder resource.

Parent class

Inherits from Array

Constructors

(int Folder resource id "Folder resource id") - Get an existing folder by resource id
(string Folder name "Folder name", int Folder template resource id "Folder template resource id (0 for default)", int Parent resource id "Parent resource id (0 for root)") - Create a new folder

Methods

Empty Folder_save() - Save this folder object to the database
string ToString() - The string representation of the object.
object this[] { get; }(int index "Index") - Backward-compatible indexer
Empty this[] { get; }(int index "Index", object value "Value to set") - Backward-compatible indexer

Properties

number Average { get; } - Average of the objects in the Array object. Can only use if all the elements are of type Number
string Folder_description { get; set; } - Description of the folder
bool ManHours { get; set; } - Whether man-hours are calculated automatically
number Max { get; } - Largest of all the objects in the Array object. Can only use if all the elements are of type Number
number Min { get; } - Smallest of all the objects in the Array object. Can only use if all the elements are of type Number
string Name { get; set; } - Name of the folder
string ObjectTypeName { get; } - The name of the type of object.
int ParentResourceId { get; set; } - Resource id of the parent resource
int ResourceId { get; } - Resource id of the folder
number Sum { get; } - Sum of all the objects in the Array object. Can only use if all the elements are of type Number
int TemplateResourceId { get; set; } - Resource id of the folder template
int TimeBudget { get; set; } - Man-hours budget for the folder
bool TimeRegistration { get; set; } - Whether time registration is enabled
TypeInformation TypeInformation { get; } - Get information about this class.

Static Methods

Folder Folder_getFolderByName(string Folder qualified name "Folder qualified name") - Get a folder array object by its qualified name. Returns empty if not found.
Folder Folder_getFolderByResourceId(int Folder resource id "Folder resource id") - Get a folder array object by its resource id. Returns empty if not found.
Folder Folder_new(string Folder name "Folder name", int Folder template resource id "Folder template resource id (0 for default)", int Parent resource id "Parent resource id (0 for root)") - Create a new folder object
Empty Folder_save(Folder Folder "The folder to save") - Save a folder object to the database

@@ Line 1: / Line 1: @@
-{{CGscriptClass_Template|Name=<nowiki>Folder</nowiki>|Description=<nowiki>Represents a Folder resource.</nowiki>|InheritsFrom=Array|Constructors={{CGscriptConstructors_Template|Parameters=
+{{CGscriptClass_Template
+|Name=<nowiki>Folder</nowiki>
+|Description=<nowiki>Represents a Folder resource.</nowiki>
+|InheritsFrom=Array|Constructors=
+{{CGscriptConstructors_Template|Parameters=
 {{CGscriptParameters_Template|Type=int|Name=<nowiki>Folder resource id</nowiki>|Description=<nowiki>Folder resource id</nowiki>}}
 |Description=<nowiki>Get an existing folder by resource id</nowiki>}}
 {{CGscriptConstructors_Template|Parameters=
 {{CGscriptParameters_Template|Type=string|Name=<nowiki>Folder name</nowiki>|Description=<nowiki>Folder name</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Folder template resource id</nowiki>|Description=<nowiki>Folder template resource id (0 for default)</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Parent resource id</nowiki>|Description=<nowiki>Parent resource id (0 for root)</nowiki>}}
-|Description=<nowiki>Create a new folder</nowiki>}}|Methods={{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Folder_save</nowiki>|Description=<nowiki>Save this folder object to the database</nowiki>}}
+|Description=<nowiki>Create a new folder</nowiki>}}
+|Methods=
+{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Folder_save</nowiki>|Description=<nowiki>Save this folder object to the database</nowiki>}}
 {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
 {{CGscriptMethods_Template|ReturnType=object|Name=<nowiki>this[] { get; }</nowiki>|Parameters=
@@ Line 11: / Line 17: @@
 {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>this[] { get; }</nowiki>|Parameters=
 {{CGscriptParameters_Template|Type=int|Name=<nowiki>index</nowiki>|Description=<nowiki>Index</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=object|Name=<nowiki>value</nowiki>|Description=<nowiki>Value to set</nowiki>}}
-|Description=<nowiki>Backward-compatible indexer</nowiki>}}|Properties={{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Average</nowiki>|HasGetter=1|Description=<nowiki>Average of the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
+|Description=<nowiki>Backward-compatible indexer</nowiki>}}
+|Properties=
+{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Average</nowiki>|HasGetter=1|Description=<nowiki>Average of the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
 {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Folder_description</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Description of the folder</nowiki>}}
 {{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>ManHours</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Whether man-hours are calculated automatically</nowiki>}}
@@ Line 24: / Line 32: @@
 {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>TimeBudget</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Man-hours budget for the folder</nowiki>}}
 {{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>TimeRegistration</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Whether time registration is enabled</nowiki>}}
-{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}|StaticMethods={{CGscriptMethods_Template|ReturnType=Folder|Name=<nowiki>Folder_getFolderByName</nowiki>|Parameters=
+{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
+|StaticMethods=
+{{CGscriptMethods_Template|ReturnType=Folder|Name=<nowiki>Folder_getFolderByName</nowiki>|Parameters=
 {{CGscriptParameters_Template|Type=string|Name=<nowiki>Folder qualified name</nowiki>|Description=<nowiki>Folder qualified name</nowiki>}}
 |Description=<nowiki>Get a folder array object by its qualified name. Returns empty if not found.</nowiki>}}
 {{CGscriptMethods_Template|ReturnType=Folder|Name=<nowiki>Folder_getFolderByResourceId</nowiki>|Parameters=
 {{CGscriptParameters_Template|Type=int|Name=<nowiki>Folder resource id</nowiki>|Description=<nowiki>Folder resource id</nowiki>}}
-|Description=<nowiki>Get a folder array object by its resource id. Returns empty if not found.</nowiki>}}}}
+|Description=<nowiki>Get a folder array object by its resource id. Returns empty if not found.</nowiki>}}
+{{CGscriptMethods_Template|ReturnType=Folder|Name=<nowiki>Folder_new</nowiki>|Parameters=
+{{CGscriptParameters_Template|Type=string|Name=<nowiki>Folder name</nowiki>|Description=<nowiki>Folder name</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Folder template resource id</nowiki>|Description=<nowiki>Folder template resource id (0 for default)</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Parent resource id</nowiki>|Description=<nowiki>Parent resource id (0 for root)</nowiki>}}
+|Obsolete=1
+|Description=<nowiki>Create a new folder object</nowiki>}}
+{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Folder_save</nowiki>|Parameters=
+{{CGscriptParameters_Template|Type=Folder|Name=<nowiki>Folder</nowiki>|Description=<nowiki>The folder to save</nowiki>}}
+|Obsolete=1
+|Description=<nowiki>Save a folder object to the database</nowiki>}}
+}}