This shows you the differences between two versions of the page.
excel_file_adaptor [2025/03/14 09:15] ale |
excel_file_adaptor [2025/03/14 10:45] (current) ale |
||
---|---|---|---|
Line 31: | Line 31: | ||
* **generateFileAsEvidence(): ** generates a copy of the Excel file in its current state to add as evidence. | * **generateFileAsEvidence(): ** generates a copy of the Excel file in its current state to add as evidence. | ||
- | * **generateSheetFromTastRow**: The function copies the TastRowValues received under the Input Row parameter over the active sheet or over a new sheet created with the name given by the New Sheet Name parameter, if it has been populated. In that case the new sheet will remain as active sheet in the book. The copy will be performed over the line number specified by the Target Line parameter when First Line for Header parameter (that will override the indicator Use first line as column names in the adaptor) is deactivated, but in next line if it is activated. | + | * **generateSheetFromTastRow**: the function copies the TastRowValues received under the Input Row parameter over the active sheet or over a new sheet created with the name given by the New Sheet Name parameter, if it has been populated. In that case the new sheet will remain as active sheet in the book. The copy will be performed over the line number specified by the Target Line parameter when First Line for Header parameter (that will override the indicator Use first line as column names in the adaptor) is deactivated, but in next line if it is activated. |
- | * **generateSheetFromTastTable**: | + | * **generateSheetFromTastTable**: the function copies the TastTableData received under the Input Table parameter over a new sheet created with the name given by the New Sheet Name parameter. This new sheet will remain as the active sheet in the book. The parameter First Line for Header will override the Use first line as column names check in the adaptor and, if the parameter is active the copy will be performed from the first line in the sheet, but if it isn’t the copy will be performed from the second line in the sheet. |
- | * **getActiveSheetIndex**: | + | * **getActiveSheetIndex**: allows you to recover the index of the active sheet of the Excel file. |
* **getCellValue (CellReference):** this function returns the value of a cell with the reference of a said cell (e.g.: C7, C12, D2…); works with uppercase and lower case. | * **getCellValue (CellReference):** this function returns the value of a cell with the reference of a said cell (e.g.: C7, C12, D2…); works with uppercase and lower case. | ||
Line 49: | Line 49: | ||
* **getNumValueSearchOnColumn:** allows the user to search a value on the selected column and it returns the number of times the value appears in the column. In the mapping the user puts the value to find in SearchValue field and the number of column in Column field. | * **getNumValueSearchOnColumn:** allows the user to search a value on the selected column and it returns the number of times the value appears in the column. In the mapping the user puts the value to find in SearchValue field and the number of column in Column field. | ||
- | * **getNumberOfSheets**: returns the number of sheets. | + | * **getNumberOfSheets**: allows you to recover the number of sheets in an Excel file. |
* **getRowByColumnSearch():** returns a TastTableData, that contains the subset of rows in which the column has the indicated value. As imput parameters we have with SearchColumn and SearchValue. | * **getRowByColumnSearch():** returns a TastTableData, that contains the subset of rows in which the column has the indicated value. As imput parameters we have with SearchColumn and SearchValue. | ||
Line 60: | Line 60: | ||
* **newFile(FilePath):** creates or overwrites a file, with the path and the name indicated by the parameter filePath".\\ If the file doesn´t exist, TAST will create it, as an empty file.\\ If the file exists, TAST will delete the current file, and it will create a new empty one. | * **newFile(FilePath):** creates or overwrites a file, with the path and the name indicated by the parameter filePath".\\ If the file doesn´t exist, TAST will create it, as an empty file.\\ If the file exists, TAST will delete the current file, and it will create a new empty one. | ||
+ | |||
+ | * **renameSheet**: the function renames the sheet specified by the Old Sheet Name parameter (wich may contains an existing sheet name in the book or its ordinal), or the current sheet if this parameter hasn’t been populated. The new name given to the sheet will be taken from the New Sheet Name Parameter, and the renamed sheet will remain as the active sheet in the book. | ||
* **setCellValue (CellReference, value):** this function sets the value of a cell with the reference of a said cell (e.g.: C7, C12, D2…), works with uppercase and lower case. | * **setCellValue (CellReference, value):** this function sets the value of a cell with the reference of a said cell (e.g.: C7, C12, D2…), works with uppercase and lower case. |