Back to Devexpress

Workbook.ExportToHtmlAsync(String, Int32) Method

officefileapi-devexpress-dot-spreadsheet-dot-workbook-dot-exporttohtmlasync-x28-system-dot-string-system-dot-int32-x29.md

latest3.3 KB
Original Source

Workbook.ExportToHtmlAsync(String, Int32) Method

SECURITY-RELATED CONSIDERATIONS

Using file paths sourced from untrusted input may expose unauthorized files or allow unintended file access. Always validate and normalize all external paths to prevent path manipulation.

Asynchronously exports the specified worksheet to the specified file in HTML format.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.

Namespace : DevExpress.Spreadsheet

Assembly : DevExpress.Docs.v25.2.dll

NuGet Package : DevExpress.Document.Processor

Declaration

csharp
public Task ExportToHtmlAsync(
    string fileName,
    int sheetIndex
)
vb
Public Function ExportToHtmlAsync(
    fileName As String,
    sheetIndex As Integer
) As Task

Parameters

NameTypeDescription
fileNameString

A String value which contains the full path (including the file name and extension) specifying where the HTML file will be created.

| | sheetIndex | Int32 |

An integer value that is the index of the worksheet to be exported to HTML.

|

Returns

TypeDescription
Task

An Task object representing an asynchronous export operation.

|

Remarks

Important

Take into account the following when you call this method:

  • The events fired by this method call may occur in a different thread than the target operation.

  • The operation is not thread safe (the document should not be accessed simultaneously by different threads). Wait until the operation is completed before you continue to work with the document (for example, use the await operator).

Calculate Formulas Before Export

The default calculation mode for a Workbook is Manual. This mode implies that the Spreadsheet does not recalculate formulas before it generates an HTML file. Call the Workbook.Calculate or Workbook.CalculateFull method to calculate all formulas in the workbook before you export it to HTML.

See Also

Workbook Class

Workbook Members

DevExpress.Spreadsheet Namespace