Difference between revisions of "QcsUserColumn class"
| Line 7: | Line 7: | ||
|Description=<nowiki>Create a new column with user data.</nowiki>}} | |Description=<nowiki>Create a new column with user data.</nowiki>}} | ||
|Methods= | |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>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>}} | {{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 20: | Line 23: | ||
{{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>}} | {{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> === | === <span style="color:#DF8621">'''Examples'''</span> === | ||
<source lang="javascript"> | <source lang="javascript"> | ||
Revision as of 11:07, 25 April 2019
QcsUserColumn
Represents a data cache specification column with user data.
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
- 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();
