Class EbookLoadOptions

EbookLoadOptions class

Represents options when importing an ebook file.

public class EbookLoadOptions : HtmlLoadOptions

Constructors

NameDescription
EbookLoadOptions()Creates an options of loading the ebook file.
EbookLoadOptions(LoadFormat)Creates an options of loading the ebook file.

Properties

NameDescription
AttachedFilesDirectory { get; set; }(Obsolete.) The directory that the attached files will be saved to.(Inherited from HtmlLoadOptions.)
AutoFilter { get; set; }Indicates whether auto filtering the data when loading the files.(Inherited from LoadOptions.)
AutoFitColsAndRows { get; set; }Indicates whether auto-fit columns and rows. The default value is false.(Inherited from HtmlLoadOptions.)
AutoFitterOptions { get; set; }Gets and sets the auto fitter options(Inherited from LoadOptions.)
CheckDataValid { get; set; }Check whether data is valid in the template file.(Inherited from LoadOptions.)
CheckExcelRestriction { get; set; }Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K such as by Cell.PutValue(string), if this property is true, you will get an Exception. If this property is false, we will accept your input string value as the cell’s value so that later you can output the complete string value for other file formats such as CSV. However, if you have set such kind of value that is invalid for excel file format, you should not save the workbook as excel file format later. Otherwise there may be unexpected error for the generated excel file.(Inherited from LoadOptions.)
ConvertDateTimeData { get; set; }Gets or sets a value that indicates whether the string in text file is converted to date data.(Inherited from AbstractTextLoadOptions.)
ConvertFormulasData { get; set; }(Obsolete.) if true, convert string to formula when string value starts with character ‘=’,the default value is false.(Inherited from HtmlLoadOptions.)
ConvertNumericData { get; set; }Gets or sets a value that indicates whether the string in text file is converted to numeric data.(Inherited from AbstractTextLoadOptions.)
CultureInfo { get; set; }Gets or sets the system culture info at the time the file was loaded.(Inherited from LoadOptions.)
DefaultStyleSettings { get; }Gets the default style settings for initializing styles of the workbook(Inherited from LoadOptions.)
DeleteRedundantSpaces { get; set; }Indicates whether delete redundant spaces when the text wraps lines using <br> tag. The default value is false.(Inherited from HtmlLoadOptions.)
Encoding { get; set; }Gets and sets the default encoding. Only applies for csv file.(Inherited from AbstractTextLoadOptions.)
FontConfigs { get; set; }Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.(Inherited from LoadOptions.)
HasFormula { get; set; }Indicates whether the text is formula if it starts with “=”.(Inherited from HtmlLoadOptions.)
IgnoreNotPrinted { get; set; }Ignore the data which are not printed if directly printing the file(Inherited from LoadOptions.)
IgnoreUselessShapes { get; set; }Indicates whether ignoring useless shapes.(Inherited from LoadOptions.)
InterruptMonitor { get; set; }Gets and sets the interrupt monitor.(Inherited from LoadOptions.)
KeepPrecision { get; set; }Indicates whether not parsing a string value if the length is 15.(Inherited from AbstractTextLoadOptions.)
KeepUnparsedData { get; set; }Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.(Inherited from LoadOptions.)
LanguageCode { get; set; }Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.(Inherited from LoadOptions.)
LightCellsDataHandler { get; set; }The data handler for processing cells data when reading template file.(Inherited from LoadOptions.)
LoadFilter { get; set; }The filter to denote how to load data.(Inherited from LoadOptions.)
LoadFormat { get; }Gets the load format.(Inherited from LoadOptions.)
LoadFormulas { get; set; }Indicates whether importing formulas if the original html file contains formulas(Inherited from HtmlLoadOptions.)
LoadStyleStrategy { get; set; }Indicates the strategy to apply style for parsed values when converting string value to number or datetime.(Inherited from AbstractTextLoadOptions.)
MemorySetting { get; set; }Gets or sets the memory usage options.(Inherited from LoadOptions.)
ParsingFormulaOnOpen { get; set; }Indicates whether parsing the formula when reading the file.(Inherited from LoadOptions.)
ParsingPivotCachedRecords { get; set; }Indicates whether parsing pivot cached records when loading the file. The default value is false.(Inherited from LoadOptions.)
Password { get; set; }Gets and set the password of the workbook.(Inherited from LoadOptions.)
PreservePaddingSpacesInFormula { get; set; }Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false.(Inherited from LoadOptions.)
ProgId { get; }Gets the program id of creating the file. Only for MHT files.(Inherited from HtmlLoadOptions.)
Region { get; set; }Gets or sets the system regional settings based on CountryCode at the time the file was loaded.(Inherited from LoadOptions.)
StandardFont { get; set; }(Obsolete.) Sets the default standard font name(Inherited from LoadOptions.)
StandardFontSize { get; set; }(Obsolete.) Sets the default standard font size.(Inherited from LoadOptions.)
StreamProvider { get; set; }Gets or sets the StreamProviderImportHtmlFile for importing objects.(Inherited from HtmlLoadOptions.)
SupportDivTag { get; set; }Indicates whether support the layout of <div> tag when the html file contains it. The default value is false.(Inherited from HtmlLoadOptions.)
TableLoadOptions { get; }Get the HtmlTableLoadOptionCollection instance(Inherited from HtmlLoadOptions.)
WarningCallback { get; set; }Gets or sets warning callback.(Inherited from LoadOptions.)

Methods

NameDescription
SetPaperSize(PaperSizeType)Sets the default print paper size from default printer’s setting.(Inherited from LoadOptions.)

Examples

[C#]

namespace Demos
{
    using Aspose.Cells;
    using System;
    using System.IO;
    using System.Text;

    public class EbookLoadOptionsDemo
    {
        public static void EbookLoadOptionsExample()
        {
            // Create an instance of EbookLoadOptions
            EbookLoadOptions options = new EbookLoadOptions();

            // Setting properties
            options.AttachedFilesDirectory = "C:\\AttachedFiles";
            options.LoadFormulas = true;
            options.SupportDivTag = true;
            options.DeleteRedundantSpaces = true;
            options.AutoFitColsAndRows = true;
            options.ConvertFormulasData = true;
            options.HasFormula = true;
            options.Encoding = Encoding.UTF8;
            options.LoadStyleStrategy = TxtLoadStyleStrategy.None;
            options.ConvertNumericData = true;
            options.ConvertDateTimeData = true;
            options.KeepPrecision = true;
            options.Password = "password";
            options.ParsingFormulaOnOpen = true;
            options.ParsingPivotCachedRecords = true;
            options.LanguageCode = CountryCode.USA;
            options.Region = CountryCode.USA;
            options.CultureInfo = new System.Globalization.CultureInfo("en-US");
            options.StandardFont = "Arial";
            options.StandardFontSize = 12.0;
            options.InterruptMonitor = null; // Assuming no interrupt monitor is set
            options.IgnoreNotPrinted = true;
            options.CheckDataValid = true;
            options.CheckExcelRestriction = true;
            options.KeepUnparsedData = true;
            options.LoadFilter = new LoadFilter();
            options.LightCellsDataHandler = null; // Assuming no light cells data handler is set
            options.MemorySetting = MemorySetting.Normal;
            options.WarningCallback = null; // Assuming no warning callback is set
            options.AutoFitterOptions = new AutoFitterOptions();
            options.AutoFilter = true;
            options.FontConfigs = new IndividualFontConfigs();
            options.IgnoreUselessShapes = true;
            options.PreservePaddingSpacesInFormula = true;

            // Load an ebook file into a Workbook using the specified options
            Workbook workbook = new Workbook("EbookLoadOptionsExample_original.ebook", options);

            // Save the workbook to an Excel file
            workbook.Save("EbookLoadOptionsExample.xlsx");

            return;
        }
    }
}

See Also