Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files Leave feedback
On this page
GroupDocs.Viewer for .NET allows you to render your spreadsheet files in HTML, PDF, PNG, and JPEG formats. You do not need to use Microsoft Excel or other spreadsheet programs to load and view Excel documents within your .NET application (web or desktop).
To start with the GroupDocs.Viewer API, create a Viewer class instance. Pass a spreadsheet file you want to view to the class constructor. You can load the document from a file or stream. Call one of the Viewer.View method overloads to convert the document to HTML, PDF, or image format. These methods allow you to render the entire document or specific pages.
GroupDocs.Viewer supports the following spreadsheet file formats:
- Microsoft Excel Workbook (.XLSX)
- Microsoft Excel 97-2003 Workbook (.XLS)
- Microsoft Excel Binary Workbook (.XLSB)
- Microsoft Excel Macro-Enabled Workbook (.XLSM)
- Microsoft Excel Template (.XLTX)
- Microsoft Excel 97-2003 Template (.XLT)
- Microsoft Excel Macro-Enabled Template (.XLTM)
- Microsoft Excel Add-In (.XLAM)
- XML Spreadsheet 2003 (.XML)
- OpenDocument Spreadsheet (.ODS)
- OpenDocument Spreadsheet Template (.OTS)
- OpenDocument Flat XML Spreadsheet (.FODS)
- Comma Separated Values File (.CSV)
- Tab Separated Values File (.TSV)
- StarOffice Calc Spreadsheet (.SXC)
- Apple Numbers Spreadsheet (.NUMBERS)
GroupDocs.Viewer can detect the document format automatically based on information in the file header.
Create an HtmlViewOptions class instance and pass it to the Viewer.View method to convert a spreadsheet file to HTML. The HtmlViewOptions class properties allow you to control the conversion process. For instance, you can embed all external resources in the generated HTML file, minify the output file, and optimize it for printing. Refer to the following documentation section for details: Rendering to HTML.
When rendering spreadsheets to HTML format, regardless of the exact rendering mode (one HTML file per one worksheet, or single HTML for all worksheets, embedded or external resources), there always is an HTML <table>, that contains all the data from a worksheet, and a set of different CSS properties, which are applied to different parts of this table (rows, cells, or their ranges) and decorate them. There always is a CSS stylesheet (embedded or external) with a set of rulesets and at-rules, which are binded with a HTML table and its content by different selectors.
In some cases it is required to embed the GroupDocs.Viewer into the other web-application. In this scenario may occur an issue, when the styles from the GroupDocs.Viewer interfere with the styles of the parent web application. In particular, when GroupDocs.Viewer converts the spreadsheet to the HTML, it creates several rulesets with <TR>, <TD>, <COL>, <BR> type-selector, and these rulesets may corrupt the behavior of the parent web-page.
It was a problem in the GroupDocs.Viewer before the version 24.3. Starting from version 24.3, when rendering spreadsheet documents, the GroupDocs.Viewer adds the unique ID value to every HTML element and CSS selector in order to eliminate any interference with styles of the parent application. So now all the type-selectors are replaced to be the combined id-type descendant selectors like #gdt-id-1 td, #gdt-id-2 tr, and so on. This excludes any style conflicts once and for all.
To save all elements of an HTML page (including text, graphics, and stylesheets) into a single file, call the HtmlViewOptions.ForEmbeddedResources method and specify the output file name.
using GroupDocs.Viewer;
using GroupDocs.Viewer.Options;
// ...
using (var viewer = new Viewer("invoice.xlsx"))
{
// Convert the spreadsheet to HTML.
// {0} is replaced with the current page number in the file names.
var viewOptions = HtmlViewOptions.ForEmbeddedResources("page_{0}.html");
viewer.View(viewOptions);
}
Imports GroupDocs.Viewer
Imports GroupDocs.Viewer.Options
' ...
Module Program
Sub Main(args As String())
Using viewer = New Viewer("invoice.xlsx")
' Convert the spreadsheet to HTML.
' {0} is replaced with the current page number in the file names.
Dim viewOptions = HtmlViewOptions.ForEmbeddedResources("page_{0}.html")
viewer.View(viewOptions)
End Using
End Sub
End Module
The following image demonstrates the result:
using GroupDocs.Viewer;
using GroupDocs.Viewer.Options;
// ...
using (var viewer = new Viewer("Products.numbers"))
{
// Convert the spreadsheet to HTML.
// {0} is replaced with the current page number in the file names.
var viewOptions = HtmlViewOptions.ForEmbeddedResources("page_{0}.html");
viewer.View(viewOptions);
}
Imports GroupDocs.Viewer
Imports GroupDocs.Viewer.Options
' ...
Module Program
Sub Main(args As String())
Using viewer = New Viewer("Products.numbers")
' Convert the spreadsheet to HTML.
' {0} is replaced with the current page number in the file names.
Dim viewOptions = HtmlViewOptions.ForEmbeddedResources("page_{0}.html")
viewer.View(viewOptions)
End Using
End Sub
End Module
The following image demonstrates the result:
If you want to store an HTML file and additional resource files (such as fonts, images, and stylesheets) separately, call the HtmlViewOptions.ForExternalResources method and pass the following parameters:
- The output file path format
- The path format for the folder with external resources
- The resource URL format
using GroupDocs.Viewer;
using GroupDocs.Viewer.Options;
// ...
using (var viewer = new Viewer("invoice.xlsx"))
{
// Convert the spreadsheet to HTML.
// Specify the HTML file names and location of external resources.
// {0} and {1} are replaced with the current page number and resource name, respectively.
var viewOptions = HtmlViewOptions.ForExternalResources("page_{0}.html", "page_{0}/resource_{0}_{1}", "page_{0}/resource_{0}_{1}");
viewer.View(viewOptions);
}
Imports GroupDocs.Viewer
Imports GroupDocs.Viewer.Options
' ...
Module Program
Sub Main(args As String())
Using viewer = New Viewer("invoice.xlsx")
' Convert the spreadsheet to HTML.
' Specify the HTML file names and location of external resources.
' {0} and {1} are replaced with the current page number and resource name, respectively.
Dim viewOptions = HtmlViewOptions.ForExternalResources("page_{0}.html", "page_{0}/resource_{0}_{1}", "page_{0}/resource_{0}_{1}")
viewer.View(viewOptions)
End Using
End Sub
End Module
using GroupDocs.Viewer;
using GroupDocs.Viewer.Options;
// ...
using (var viewer = new Viewer("Products.numbers"))
{
// Convert the spreadsheet to HTML.
// Specify the HTML file names and location of external resources.
// {0} and {1} are replaced with the current page number and resource name, respectively.
var viewOptions = HtmlViewOptions.ForExternalResources("page_{0}.html", "page_{0}/resource_{0}_{1}", "page_{0}/resource_{0}_{1}");
viewer.View(viewOptions);
}
Imports GroupDocs.Viewer
Imports GroupDocs.Viewer.Options
' ...
Module Program
Sub Main(args As String())
Using viewer = New Viewer("Products.numbers")
' Convert the spreadsheet to HTML.
' Specify the HTML file names and location of external resources.
' {0} and {1} are replaced with the current page number and resource name, respectively.
Dim viewOptions = HtmlViewOptions.ForExternalResources("page_{0}.html", "page_{0}/resource_{0}_{1}", "page_{0}/resource_{0}_{1}")
viewer.View(viewOptions)
End Using
End Sub
End Module
The image below demonstrates the result. External resources are placed in a separate folder.
To convert all worksheets to one HTML file, set the HtmlViewOptions.RenderToSinglePage property to true. This feature is supported in both cases - when converting to HTML with embedded and external resources.
using GroupDocs.Viewer;
using GroupDocs.Viewer.Options;
// ...
using (var viewer = new Viewer("Personal_net_worth_calculator.xlsx"))
{
// Convert all Excel worksheets to one HTML file.
var viewOptions = HtmlViewOptions.ForEmbeddedResources("page.html");
// Enable converting all worksheets to one file.
viewOptions.RenderToSinglePage = true;
viewer.View(viewOptions);
}
Imports GroupDocs.Viewer
Imports GroupDocs.Viewer.Options
' ...
Module Program
Sub Main(args As String())
Using viewer = New Viewer("Personal_net_worth_calculator.xlsx")
' Convert all Excel worksheets to one HTML file.
Dim viewOptions = HtmlViewOptions.ForEmbeddedResources("page.html")
' Enable converting all worksheets to one file.
viewOptions.RenderToSinglePage = True
viewer.View(viewOptions)
End Using
End Sub
End Module
The following image demonstrates the result:
Create a PdfViewOptions class instance and pass it to the Viewer.View method to convert a spreadsheet file to PDF. The PdfViewOptions class properties allow you to control the conversion process. For instance, you can protect the output PDF file, reorder its pages, and specify the quality of document images. Refer to the following documentation section for details: Rendering to PDF.
using GroupDocs.Viewer;
using GroupDocs.Viewer.Options;
// ...
using (var viewer = new Viewer("invoice.xlsx"))
{
// Convert the spreadsheet to PDF.
var viewOptions = new PdfViewOptions("output.pdf");
viewer.View(viewOptions);
}
Imports GroupDocs.Viewer
Imports GroupDocs.Viewer.Options
' ...
Module Program
Sub Main(args As String())
Using viewer = New Viewer("invoice.xlsx")
' Convert the spreadsheet to PDF.
Dim viewOptions = New PdfViewOptions("output.pdf")
viewer.View(viewOptions)
End Using
End Sub
End Module
The following image demonstrates the result:
using GroupDocs.Viewer;
using GroupDocs.Viewer.Options;
// ...
using (var viewer = new Viewer("Products.numbers"))
{
// Convert the spreadsheet to PDF.
var viewOptions = new PdfViewOptions("output.pdf");
viewer.View(viewOptions);
}
Imports GroupDocs.Viewer
Imports GroupDocs.Viewer.Options
' ...
Module Program
Sub Main(args As String())
Using viewer = New Viewer("Products.numbers")
' Convert the spreadsheet to PDF.
Dim viewOptions = New PdfViewOptions("output.pdf")
viewer.View(viewOptions)
End Using
End Sub
End Module
The following image demonstrates the result:
Create a PngViewOptions class instance and pass it to the Viewer.View method to convert a spreadsheet file to PNG. Use the PngViewOptions.Height and PngViewOptions.Width properties to specify the output image size in pixels.
using GroupDocs.Viewer;
using GroupDocs.Viewer.Options;
// ...
using (var viewer = new Viewer("invoice.xlsx"))
{
// Convert the spreadsheet to PNG.
// {0} is replaced with the current page number in the file names.
var viewOptions = new PngViewOptions("output_{0}.png");
// Set width and height.
viewOptions.Width = 800;
viewOptions.Height = 900;
viewer.View(viewOptions);
}
Imports GroupDocs.Viewer
Imports GroupDocs.Viewer.Options
' ...
Module Program
Sub Main(args As String())
Using viewer = New Viewer("invoice.xlsx")
' Convert the spreadsheet to PNG.
' {0} is replaced with the current page number in the file names.
Dim viewOptions = New PngViewOptions("output_{0}.png")
' Set width and height.
viewOptions.Width = 800
viewOptions.Height = 900
viewer.View(viewOptions)
End Using
End Sub
End Module
using GroupDocs.Viewer;
using GroupDocs.Viewer.Options;
// ...
using (var viewer = new Viewer("Products.numbers"))
{
// Convert the spreadsheet to PNG.
// {0} is replaced with the current page number in the file names.
var viewOptions = new PngViewOptions("output_{0}.png");
// Set width and height.
viewOptions.Width = 800;
viewOptions.Height = 900;
viewer.View(viewOptions);
}
Imports GroupDocs.Viewer
Imports GroupDocs.Viewer.Options
' ...
Module Program
Sub Main(args As String())
Using viewer = New Viewer("Products.numbers")
' Convert the spreadsheet to PNG.
' {0} is replaced with the current page number in the file names.
Dim viewOptions = New PngViewOptions("output_{0}.png")
' Set width and height.
viewOptions.Width = 800
viewOptions.Height = 900
viewer.View(viewOptions)
End Using
End Sub
End Module
The following image demonstrates the result:
Create a JpgViewOptions class instance and pass it to the Viewer.View method to convert a spreadsheet file to JPEG. Use the JpgViewOptions.Height and JpgViewOptions.Width properties to specify the output image size in pixels.
using GroupDocs.Viewer;
using GroupDocs.Viewer.Options;
// ...
using (var viewer = new Viewer("invoice.xlsx"))
{
// Convert the spreadsheet to JPEG.
// {0} is replaced with the current page number in the file names.
var viewOptions = new JpgViewOptions("output_{0}.jpg");
// Set width and height.
viewOptions.Width = 800;
viewOptions.Height = 900;
viewer.View(viewOptions);
}
Imports GroupDocs.Viewer
Imports GroupDocs.Viewer.Options
' ...
Module Program
Sub Main(args As String())
Using viewer = New Viewer("invoice.xlsx")
' Convert the spreadsheet to JPEG.
' {0} is replaced with the current page number in the file names.
Dim viewOptions = New JpgViewOptions("output_{0}.jpg")
' Set width and height.
viewOptions.Width = 800
viewOptions.Height = 900
viewer.View(viewOptions)
End Using
End Sub
End Module
using GroupDocs.Viewer;
using GroupDocs.Viewer.Options;
// ...
using (var viewer = new Viewer("Products.numbers"))
{
// Convert the spreadsheet to JPEG.
// {0} is replaced with the current page number in the file names.
var viewOptions = new JpgViewOptions("output_{0}.jpg");
// Set width and height.
viewOptions.Width = 800;
viewOptions.Height = 900;
viewer.View(viewOptions);
}
Imports GroupDocs.Viewer
Imports GroupDocs.Viewer.Options
' ...
Module Program
Sub Main(args As String())
Using viewer = New Viewer("Products.numbers")
' Convert the spreadsheet to JPEG.
' {0} is replaced with the current page number in the file names.
Dim viewOptions = New JpgViewOptions("output_{0}.jpg")
' Set width and height.
viewOptions.Width = 800
viewOptions.Height = 900
viewer.View(viewOptions)
End Using
End Sub
End Module
If you load a CSV/TSV file to convert it to another format, enable the SpreadsheetOptions.DetectSeparator property for a target view to automatically detect a delimiter used to separate values in the source file.
GroupDocs.Viewer can detect the following separators:
- A comma (the default separator)
- A semicolon
using GroupDocs.Viewer;
using GroupDocs.Viewer.Options;
// ...
using (var viewer = new Viewer("sample.csv"))
{
// Convert the spreadsheet to HTML.
// {0} is replaced with the current page number in the file names.
var viewOptions = HtmlViewOptions.ForEmbeddedResources("page_{0}.html");
// Detect a CSV/TSV separator.
viewOptions.SpreadsheetOptions.DetectSeparator = true;
viewer.View(viewOptions);
}
Imports GroupDocs.Viewer
Imports GroupDocs.Viewer.Options
' ...
Module Program
Sub Main(args As String())
Using viewer = New Viewer("sample.csv")
' Convert the spreadsheet to HTML.
' {0} is replaced with the current page number in the file names.
Dim viewOptions = HtmlViewOptions.ForEmbeddedResources("page_{0}.html")
' Detect a CSV/TSV separator.
viewOptions.SpreadsheetOptions.DetectSeparator = True
viewer.View(viewOptions)
End Using
End Sub
End Module
GroupDocs.Viewer allows you to obtain information about the source spreadsheet file. For example, you can retrieve worksheet names, as described below:
- Create a ViewInfoOptions instance for a specific view.
- Call the Viewer.GetViewInfo method and pass the
ViewInfoOptionsinstance to this method as a parameter. - Use the Pages property of the returned ViewInfo object to iterate through the list of worksheets and retrieve the worksheet names.
using GroupDocs.Viewer;
using GroupDocs.Viewer.Options;
using GroupDocs.Viewer.Results;
// ...
using (var viewer = new Viewer("sample.xlsx"))
{
var viewInfoOptions = ViewInfoOptions.ForHtmlView();
// Call this method to create a single page for each worksheet.
viewInfoOptions.SpreadsheetOptions = SpreadsheetOptions.ForOnePagePerSheet();
var viewInfo = viewer.GetViewInfo(viewInfoOptions);
// Print the worksheet names in the console window.
Console.WriteLine("The document contains the following worksheets:");
foreach (Page page in viewInfo.Pages)
{
Console.WriteLine($" - Worksheet {page.Number}: '{page.Name}'");
}
}
Imports GroupDocs.Viewer
Imports GroupDocs.Viewer.Options
Imports GroupDocs.Viewer.Results
' ...
Module Program
Sub Main(args As String())
Using viewer = New Viewer("sample.xlsx")
Dim viewInfoOptions = ViewInfoOptions.ForHtmlView()
' Call this method to create a single page for each worksheet.
viewInfoOptions.SpreadsheetOptions = SpreadsheetOptions.ForOnePagePerSheet()
Dim viewInfo = viewer.GetViewInfo(viewInfoOptions)
' Print the worksheet names in the console window.
Console.WriteLine("The document contains the following worksheets:")
For Each page As Page In viewInfo.Pages
Console.WriteLine($" - Worksheet {page.Number}: '{page.Name}'")
Next
End Using
End Sub
End Module
The following image shows a sample console output:
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
