Latest revision as of 05:04, 2 July 2020

QcsGroupColumn

Represents a data cache specification column with group data.

Parent class

Inherits from QcsColumn

Constructors

(string name "Set column name.", int groupResourceId "Set the associated group.", DataCacheSpecification dcs "Dcs the column should belong to") - Create a new boolean column true if the user for a row belongs to the given group.

Methods

(From QcsColumn) Empty ChangeDcs(DataCacheSpecification dcs "New DCS to put the column in") - Change column to belong to another DCS. The origin DCS is not altered
(From QcsColumn) Empty Delete() - Remove column from the dcs
(From QcsColumn) Empty Save() - Add a new column to the dcs. Naming conflicts are automatically resolved. Notice the dcs itself also needs to be saved
(From object) string ToString() - The string representation of the object.

Properties

(From QcsColumn) string CgScript { get; set; } - Get/set the cgscript for the column
(From QcsColumn) string ColumnType { get; } - Get the source type of the column data
(From QcsColumn) string DataType { get; } - Get the data type of the column
int GroupResourceId { get; } - Get the group used for getting data for this column.
(From QcsColumn) string Name { get; set; } - Get/set the name of the column
string ObjectTypeName { get; } - The name of the type of object.
(From QcsColumn) bool PresentAsText { get; set; } - Get/set if Show the data column as the option text
(From object) TypeInformation TypeInformation { get; } - Get information about this class.

Examples

Add a new group column named "ccGroup" to an existing DCS

number groupResourceId = 15638274;
DataCacheSpecification dcs = new DataCacheSpecification(15641385);
QcsGroupColumn groupcolumn = new QcsGroupColumn ("ccGroup", groupResourceId, dcs);
groupcolumn.Save();
dcs.Save();
dcs.Rebuild();

Result true if the user for a row belongs to the given group.

@@ Line 2: / Line 2: @@
 |Name=<nowiki>QcsGroupColumn</nowiki>
 |Description=<nowiki>Represents a data cache specification column with group data.</nowiki>
-|Constructors=
+|InheritsFrom=QcsColumn|Constructors=
 {{CGscriptConstructors_Template|Parameters=
 {{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Set column name.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>groupResourceId</nowiki>|Description=<nowiki>Set the associated group.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>Dcs the column should belong to</nowiki>}}
 |Description=<nowiki>Create a new boolean column true if the user for a row belongs to the given group.</nowiki>}}
 |Methods=
-{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Delete</nowiki>|Description=<nowiki>Remove column from the dcs</nowiki>}}
+{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>ChangeDcs</nowiki>|Inherited=QcsColumn|Parameters=
-{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Add a new column to the dcs. Naming conflicts are automatically resolved. Notice the dcs itself also needs to be saved</nowiki>}}
+{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>New DCS to put the column in</nowiki>}}
-{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
+|Description=<nowiki>Change column to belong to another DCS. The origin DCS is not altered</nowiki>}}
+{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Delete</nowiki>|Inherited=QcsColumn|Description=<nowiki>Remove column from the dcs</nowiki>}}
+{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Inherited=QcsColumn|Description=<nowiki>Add a new column to the dcs. Naming conflicts are automatically resolved. Notice the dcs itself also needs to be saved</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>CgScript</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the cgscript for the column</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>CgScript</nowiki>|HasGetter=1|HasSetter=1|Inherited=QcsColumn|Description=<nowiki>Get/set the cgscript for the column</nowiki>}}
-{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ColumnType</nowiki>|HasGetter=1|Description=<nowiki>Get the source type of the column data</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ColumnType</nowiki>|HasGetter=1|Inherited=QcsColumn|Description=<nowiki>Get the source type of the column data</nowiki>}}
-{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>DataType</nowiki>|HasGetter=1|Description=<nowiki>Get the data type of the column</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>DataType</nowiki>|HasGetter=1|Inherited=QcsColumn|Description=<nowiki>Get the data type of the column</nowiki>}}
 {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>GroupResourceId</nowiki>|HasGetter=1|Description=<nowiki>Get the group used for getting data for this column.</nowiki>}}
-{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the name of the column</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Inherited=QcsColumn|Description=<nowiki>Get/set the name of the column</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>PresentAsText</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if Show the data column as the option text</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>PresentAsText</nowiki>|HasGetter=1|HasSetter=1|Inherited=QcsColumn|Description=<nowiki>Get/set if Show the data column as the option text</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>}}
 }}
+=== <span style="color:#DF8621">'''Examples'''</span> ===
+<span style="color:#DF8621"> Add a new group column named "ccGroup" to an existing DCS</span>
+<source lang="javascript">
+number groupResourceId = 15638274;
+DataCacheSpecification dcs = new DataCacheSpecification(15641385);
+QcsGroupColumn groupcolumn = new QcsGroupColumn ("ccGroup", groupResourceId, dcs);
+groupcolumn.Save();
+dcs.Save();
+dcs.Rebuild();
+</source>
+Result true if the user for a row belongs to the given group.
+[[File:2018-11-07_15-31-46.png]]