Latest revision as of 06:34, 20 September 2026

QcsUserColumn

Represents a data cache specification column with user data.

Parent class

Inherits from QcsColumn

Constructors

(string userColumn "The column name from the user table to get data from.", DataCacheSpecification dcs "Dcs the column should belong to") - Create a new column with user data.

Methods

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

Properties

string CgScript { get; set; } - Get/set the cgscript for the column
string ColumnType { get; } - Get the source type of the column data
string DataType { get; } - Get the data type of the column
bool IsPii { get; } - Whether the column is classified as PII
string Name { get; set; } - Get/set the name of the column
string ObjectTypeName { get; } - The name of the type of object.
bool PresentAsText { get; set; } - Get/set if Show the data column as the option text
TypeInformation TypeInformation { get; } - Get information about this class.
string UserColumnName { get; } - Get the column in the user table used for getting data for this column.

Examples

DataCacheSpecification dcs = new DataCacheSpecification(15639274);
QcsUserColumn userColumn = new QcsUserColumn("ResourceId" ,dcs);
userColumn.Save();
dcs.Save();

@@ Line 2: / Line 2: @@
 |Name=<nowiki>QcsUserColumn</nowiki>
 |Description=<nowiki>Represents a data cache specification column with user data.</nowiki>
-|Constructors=
+|InheritsFrom=QcsColumn|Constructors=
 {{CGscriptConstructors_Template|Parameters=
 {{CGscriptParameters_Template|Type=string|Name=<nowiki>userColumn</nowiki>|Description=<nowiki>The column name from the user table to get data from.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>Dcs the column should belong to</nowiki>}}
 |Description=<nowiki>Create a new column with user data.</nowiki>}}
 |Methods=
+{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>ChangeDcs</nowiki>|Parameters=
+{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>New DCS to put the column in</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>|Description=<nowiki>Remove column from the dcs</nowiki>}}
 {{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>}}
@@ Line 14: / Line 17: @@
 {{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>DataType</nowiki>|HasGetter=1|Description=<nowiki>Get the data type of the column</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsPii</nowiki>|HasGetter=1|Description=<nowiki>Whether the column is classified as PII</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>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
@@ Line 20: / Line 24: @@
 {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>UserColumnName</nowiki>|HasGetter=1|Description=<nowiki>Get the column in the user table used for getting data for this column.</nowiki>}}
 }}
 === <span style="color:#DF8621">'''Examples'''</span> ===
 <source lang="javascript">