Load Spreadsheet document with options Leave feedback
On this page
GroupDocs.Conversion provides the SpreadsheetLoadOptions class which controls how the source spreadsheet will be processed. Below are some of the load options that you can use while converting spreadsheets:
| Option | Description |
|---|---|
| Format | The document type is auto-detected while loading. However, you can explicitly specify the type of the source spreadsheet document. Available options are: Csv, Fods, Ods, Ots, Tsv, Xlam, Xls, Xlsb, Xlsm, Xlsx, Xlt, Xltm, Xltx |
| AllColumnsInOnePagePerSheet | If true, all column content from a single sheet will be converted into a single page. The width of paper size of page setup will be ignored, while keeping the rest of page settings. |
| AutoFitRows | If enabled, automatically adjusts the content of all rows while converting. |
| CheckExcelRestriction | Whether to check restrictions of Excel file when modifying cell objects. |
| ConvertRange | Defines a specific range of cells to be converted. For example: “D1:F8” |
| CultureInfo | Specifies system culture info at the time file is loaded. |
| DefaultFont | Specify the default font to use if a spreadsheet font is missing. |
| FontSubstitutes | Substitute specific fonts from the source spreadsheet. |
| PrintComments | Specifies how comments are printed with each sheet: PrintNoComments (default, comments are not printed), PrintInPlace, PrintSheetEnd, or PrintWithThreadedComments. |
| OnePagePerSheet | If specified, each spreadsheet will be converted into a single page. |
| OptimizePdfSize | If enabled, optimizes the resulting PDF for smaller file size, rather than for better print quality. |
| Password | Defines a password to unlock a protected document. |
| SheetIndexes | Defines the indexes of the particular sheets to be converted. |
| Sheets | Defines the names of the particular sheets to be converted. |
| ShowGridLines | Specify if the grid lines should be visible. |
| ShowHiddenSheets | Specify if the hidden sheets should be included in the converted document. |
| SkipEmptyRowsAndColumns | Specify if empty rows and columns should be ignored. |
| ColumnsPerPage | Specifies the number of columns to include on each page when converting large spreadsheets. |
| RowsPerPage | Specifies the number of rows to include on each page when converting large spreadsheets. |
| SkipHeaders | Specifies the number of header rows to skip during conversion. |
| SkipFooters | Specifies the number of footer rows to skip during conversion. |
| IgnoreFormulaCalculationErrors | If true, ignores errors that occur during formula calculation. Useful for spreadsheets with broken or external references. |
| ExternalResourceHandler | A handler called for each resource the document asks to load; it can allow the resource, skip it or supply its content. Default: null. Available since version 26.10. |
| SkipExternalResources | Whether to skip the external resources the document references. Default: true. Content the document carries, local files inside its folder and resources that match WhitelistedResources still load. See Skip loading of external resources. |
| WhitelistedResources | Absolute URI prefixes, such as https://cdn.example.com/assets/, of external resources to load while SkipExternalResources is true. Since version 26.10, an entry that is not an absolute URI prefix makes the load fail with InvalidLoadOptionsException. |
By default, comments are not printed (SpreadsheetPrintComments.PrintNoComments). The following code snippet shows how to convert a spreadsheet and print its comments at the end of each sheet:
Func<LoadContext, LoadOptions> getLoadOptions = loadContext => new SpreadsheetLoadOptions
{
PrintComments = SpreadsheetPrintComments.PrintSheetEnd,
OnePagePerSheet = true
};
using (Converter converter = new Converter("sample.xlsx", getLoadOptions))
{
PdfConvertOptions options = new PdfConvertOptions();
converter.Convert("converted.pdf", options);
}
The following code snippet shows how to convert a spreadsheet and show grid lines:
Func<LoadContext, LoadOptions> getLoadOptions = loadContext => new SpreadsheetLoadOptions
{
ShowGridLines = true,
OnePagePerSheet = true
};
using (Converter converter = new Converter("sample.xlsx", getLoadOptions))
{
PdfConvertOptions options = new PdfConvertOptions();
converter.Convert("converted.pdf", options);
}
The following code snippet shows how to convert a spreadsheet and skip empty rows and columns:
Func<LoadContext, LoadOptions> getLoadOptions = loadContext => new SpreadsheetLoadOptions
{
SkipEmptyRowsAndColumns = true,
OnePagePerSheet = true
};
using (Converter converter = new Converter("sample.xlsx", getLoadOptions))
{
PdfConvertOptions options = new PdfConvertOptions();
converter.Convert("converted.pdf", options);
}
The following code snippet shows how to convert a spreadsheet and specify font substitution for missing fonts:
Func<LoadContext, LoadOptions> getLoadOptions = loadContext => new SpreadsheetLoadOptions
{
DefaultFont = "Helvetica",
FontSubstitutes = new List<FontSubstitute>
{
FontSubstitute.Create("Tahoma", "Arial"),
FontSubstitute.Create("Times New Roman", "Arial"),
},
OnePagePerSheet = true
};
using (Converter converter = new Converter("sample.xlsx", getLoadOptions))
{
PdfConvertOptions options = new PdfConvertOptions();
converter.Convert("converted.pdf", options);
}
You can specify the sheets to be converted either by names or by indexes.
The following code snippet shows how to convert a spreadsheet and specify the desired sheets by their names:
Func<LoadContext, LoadOptions> getLoadOptions = loadContext => new SpreadsheetLoadOptions
{
Sheets = new[] {"Expenses", "Taxes" },
OnePagePerSheet = true
};
using (Converter converter = new Converter("sample.xlsx", getLoadOptions))
{
PdfConvertOptions options = new PdfConvertOptions();
converter.Convert("converted.pdf", options);
}
The following code snippet shows how to convert a spreadsheet and specify the desired sheets by their zero-based indexes:
Func<LoadContext, LoadOptions> getLoadOptions = loadContext => new SpreadsheetLoadOptions
{
SheetIndexes = new[] { 0, 2 },
OnePagePerSheet = true
};
using (Converter converter = new Converter("sample.xlsx", getLoadOptions))
{
PdfConvertOptions options = new PdfConvertOptions();
converter.Convert("converted.pdf", options);
}
The following code snippet shows how to convert a spreadsheet and specify the exact range of rows and columns to be converted:
Func<LoadContext, LoadOptions> getLoadOptions = loadContext => new SpreadsheetLoadOptions
{
ConvertRange = "10:30",
OnePagePerSheet = true
};
using (Converter converter = new Converter("sample.xlsx", getLoadOptions))
{
PdfConvertOptions options = new PdfConvertOptions();
converter.Convert("converted.pdf", options);
}
The following code snippet shows how to convert a spreadsheet including the hidden sheets:
Func<LoadContext, LoadOptions> getLoadOptions = loadContext => new SpreadsheetLoadOptions
{
ShowHiddenSheets = true,
OnePagePerSheet = true
};
using (Converter converter = new Converter("sample.xlsx", getLoadOptions))
{
PdfConvertOptions options = new PdfConvertOptions();
converter.Convert("converted.pdf", options);
}
To fit the row content of all rows while converting from a spreadsheet, set the AutoFitRows property to true:
Func<LoadContext, LoadOptions> getLoadOptions = loadContext => new SpreadsheetLoadOptions
{
AutoFitRows = true
};
using (Converter converter = new Converter("sample.xlsx", getLoadOptions))
{
PdfConvertOptions options = new PdfConvertOptions();
converter.Convert("converted.pdf", options);
}
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.
