Class XmlLoadOptions

XmlLoadOptions class

Represents the options of loading xml.

public class XmlLoadOptions : LoadOptions

Constructors

NameDescription
XmlLoadOptions()Represents the options of loading xml file.
XmlLoadOptions(LoadFormat)Represents the options of loading xml file.

Properties

NameDescription
AutoFilter { get; set; }Indicates whether auto filtering the data when loading the files.(Inherited from LoadOptions.)
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.)
ContainsMultipleWorksheets { get; set; }Indicates whether importing xml as multiple worksheets.
ConvertNumericOrDate { get; set; }Indicates whether converting the value in xml file to numeric or date.
CultureInfo { get; set; }Gets or sets the system culture info at the time the file was loaded.(Inherited from LoadOptions.)
DateFormat { get; set; }Gets and sets the format of date value.
DefaultStyleSettings { get; }Gets the default style settings for initializing styles of the workbook(Inherited from LoadOptions.)
FontConfigs { get; set; }Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.(Inherited from LoadOptions.)
IgnoreNotPrinted { get; set; }Ignore the data which are not printed if directly printing the file(Inherited from LoadOptions.)
IgnoreRootAttributes { get; set; }Indicates whether ignore attributes of the root element.
IgnoreUselessShapes { get; set; }Indicates whether ignoring useless shapes.(Inherited from LoadOptions.)
InterruptMonitor { get; set; }Gets and sets the interrupt monitor.(Inherited from LoadOptions.)
IsXmlMap { get; set; }Indicates whether mapping xml to Excel. The default value is false.
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.)
MemorySetting { get; set; }Gets or sets the memory usage options.(Inherited from LoadOptions.)
NumberFormat { get; set; }Gets and sets the format of numeric value.
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.)
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.)
StartCell { get; set; }Gets and sets the start cell.
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;

    public class XmlLoadOptionsDemo
    {
        public static void XmlLoadOptionsExample()
        {
            // Create an instance of XmlLoadOptions
            XmlLoadOptions options = new XmlLoadOptions();

            // Setting properties
            options.StartCell = "A1";
            options.IsXmlMap = true;
            options.ContainsMultipleWorksheets = false;
            options.ConvertNumericOrDate = true;
            options.NumberFormat = "0.00";
            options.DateFormat = "yyyy-MM-dd";
            options.IgnoreRootAttributes = false;
            options.Password = "password";
            options.ParsingFormulaOnOpen = true;
            options.ParsingPivotCachedRecords = false;
            options.LanguageCode = CountryCode.USA;
            options.Region = CountryCode.USA;
            options.CultureInfo = new System.Globalization.CultureInfo("en-US");
            options.StandardFont = "Arial";
            options.StandardFontSize = 10.5;
            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(LoadDataFilterOptions.All);
            options.LightCellsDataHandler = null; // Assuming no 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 = null; // Assuming no individual font configs are set
            options.IgnoreUselessShapes = true;
            options.PreservePaddingSpacesInFormula = false;

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

            // Save the workbook to a new file
            workbook.Save("XmlLoadOptionsExample.xlsx");

            return;
        }
    }
}

See Also