ExcelSheet class: Difference between revisions
From Catglobe Wiki
More actions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{CGscriptClass_Template | {{CGscriptClass_Template | ||
|Name= | |Name=ExcelSheet | ||
|Description= | |Description=An excel sheet | ||
|Constructors= | |Constructors= | ||
{{CGscriptConstructors_Template|Parameters= | {{CGscriptConstructors_Template|Parameters= | ||
{{CGscriptParameters_Template|Type=string|Name= | {{CGscriptParameters_Template|Type=string|Name=filename|Description=Name of the file|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=isTemp|Description=Is the file temporary}} | ||
|Description= | |Description=Load a file from FileNamespace}} | ||
|Methods= | |Methods= | ||
{{CGscriptMethods_Template|ReturnType=array|Name= | {{CGscriptMethods_Template|ReturnType=array|Name=ToArray|Parameters= | ||
{{CGscriptParameters_Template|Type=string|Name= | {{CGscriptParameters_Template|Type=string|Name=sheetName|Description=The sheet to convert|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=fromrow|Description=Skip number of rows}} | ||
|Description= | |Description=Convert the sheet to an array of equal sized arrays}} | ||
{{CGscriptMethods_Template|ReturnType=array|Name= | {{CGscriptMethods_Template|ReturnType=array|Name=ToHeaders|Parameters= | ||
{{CGscriptParameters_Template|Type=string|Name= | {{CGscriptParameters_Template|Type=string|Name=sheetName|Description=The sheet to convert}} | ||
|Description= | |Description=Convert the first row to array of strings}} | ||
{{CGscriptMethods_Template|ReturnType=string|Name= | {{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}} | ||
|Properties= | |Properties= | ||
{{CGscriptProperties_Template|ReturnType=string|Name= | {{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}} | ||
{{CGscriptProperties_Template|ReturnType=array|Name= | {{CGscriptProperties_Template|ReturnType=array|Name=SheetNames|HasGetter=1|Description=Get list of sheets in the excel file}} | ||
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name= | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}} | ||
}} | }} | ||
=== Examples === | === Examples === | ||
<source lang="javascript"> | <source lang="javascript"> | ||
string filename = "Upload2.xlsx"; | string filename = "Upload2.xlsx"; | ||
bool isTemp = true; | bool isTemp = true; | ||
ExcelSheet es = new ExcelSheet(filename, isTemp); | ExcelSheet es = new ExcelSheet(filename, isTemp); | ||
string sheet1 = es.SheetNames.First(); | string sheet1 = es.SheetNames.First(function(string a) { true; }); | ||
array headers = es.ToHeaders(); | array headers = es.ToHeaders(); | ||
array data = es.ToArray(sheet1, 1); | array data = es.ToArray(sheet1, 1); | ||
| Line 31: | Line 32: | ||
Catglobe.File.Delete(filename, isTemp); | Catglobe.File.Delete(filename, isTemp); | ||
</source> | </source> | ||
Revision as of 04:48, 7 April 2015
ExcelSheet
An excel sheet
Constructors
- (string filename "Name of the file", bool isTemp "Is the file temporary") - Load a file from FileNamespace
Methods
- array ToArray(string sheetName "The sheet to convert", number fromrow "Skip number of rows") - Convert the sheet to an array of equal sized arrays
- array ToHeaders(string sheetName "The sheet to convert") - Convert the first row to array of strings
- string ToString() - The string representation of the object.
Properties
- string ObjectTypeName { get; } - The name of the type of object.
- array SheetNames { get; } - Get list of sheets in the excel file
- TypeInformation TypeInformation { get; } - Get information about this class.
Examples
string filename = "Upload2.xlsx";
bool isTemp = true;
ExcelSheet es = new ExcelSheet(filename, isTemp);
string sheet1 = es.SheetNames.First(function(string a) { true; });
array headers = es.ToHeaders();
array data = es.ToArray(sheet1, 1);
ImportManager im = new ImportManager(headers, data, ...);
Catglobe.File.Delete(filename, isTemp);