ConvertToXML

Converts Excel file to XML.

Task version: 2.0.0

Required Frends version: 5.7+

Required .NET version: 8.0

Compatible Agents: Crossplatform

Source code: https://github.com/FrendsPlatform/Frends.Excel/tree/main/Frends.Excel.ConvertToXML

Task Parameters

Input

Name	Description
Path : String	Path to the Excel file. Default: C:\tmp\ExcelFile.xlsx Example: C:\tmp\ExcelFile.xlsx

Options

Name	Description
ReadOnlyWorkSheetWithName : String	If empty, all work sheets are read. Default: - Example: Sheet2
UseNumbersAsColumnHeaders : Boolean	If set to true, numbers will be used as column headers instead of letters (A = 1, B = 2...). Default: false Example: false
ThrowErrorOnFailure : Boolean	Choose if exception should be thrown when conversion fails. Default: True Example: true
ErrorMessageOnFailure : String	Overrides the error message on failure. Default: - Example: Excel conversion failed for input file.
DateFormat : DateFormats	Date format selection. Possible values: DEFAULT: Default format, will use CurrentCulture.DateTimeFormat.ShortDatePattern for ShortDatePattern option is set to true, otherwise will use CurrentCulture.DateTimeFormat.DateTimeFormat. DDMMYYYY: Will use dd/MM/yyyy if ShortDatePattern option is set to true, otherwise will use dd/MM/yyyy H:mm:ss. MMDDYYYY: Will use MM/dd/yyyy if ShortDatePattern option is set to true, otherwise will use MM/dd/yyyy h:mm:ss tt. YYYYMMDD: Will use yyyy/MM/dd if ShortDatePattern option is set to true, otherwise will use yyyy/MM/dd H:mm:ss. Default: DEFAULT Example: Default
ShortDatePattern : Boolean	If set to true, dates will exclude timestamps from dates. Default false Default: false Example: false

Task Result

Name	Description
Success : Boolean	Conversion's status. False if conversion fails. Example: true
XML : String	Excel-conversion to CSV. Example: workbook_name, worksheet_name, row_header, column_header
Error : Error	Error that occurred during task execution. Example: object { string Message, Exception AdditionalInfo }
Error.Message : String	Summary of the error. Example: Error while converting Excel file to XML.
Error.AdditionalInfo : Exception	Additional information about the error. Example: object { Exception AdditionalInfo }

Task Changelog

Changelog for Task Frends.Excel.ConvertToXML.

[2.0.0] - 2026-09-02

Changed

• [Breaking Change] Replaced ErrorMessage (string) in the result object with a structured Error object containing Message and AdditionalInfo.
• Added standard failure handling options ErrorMessageOnFailure.
• Updated the task to target .NET 8.

[1.1.0] - 2026-01-22

Fixed

• Open Excel files with FileAccess.Read to support read-only files

[1.0.2] - 2023-08-01

Fixed

• Fixed Options.ShouldReadSheet method to check if the Sheet name equals to the given name.

[1.0.1] - 2022-08-10

Change

• Documentation updates

[1.0.0] - 2022-02-24

Added

• Initial implementation