WorkbookSettings

WorkbookSettings class

Represents all settings of the workbook.

class WorkbookSettings;

Properties

PropertyTypeDescription
authorstringGets and sets the author of the file.
checkCustomNumberFormatbooleanIndicates whether checking custom number format when setting Style.Custom.
enableMacrosbooleanEnable macros;
date1904booleanGets or sets a value which represents if the workbook uses the 1904 date system.
protectionTypeProtectionTypeReadonly. Gets the protection type of the workbook.
displayDrawingObjectsDisplayDrawingObjectsIndicates whether and how to show objects in the workbook.
sheetTabBarWidthnumberWidth of worksheet tab bar (in 1/1000 of window width).
showTabsbooleanGet or sets a value whether the Workbook tabs are displayed.
firstVisibleTabnumberGets or sets the first visible worksheet tab.
isHScrollBarVisiblebooleanGets or sets a value indicating whether the generated spreadsheet will contain a horizontal scroll bar.
isVScrollBarVisiblebooleanGets or sets a value indicating whether the generated spreadsheet will contain a vertical scroll bar.
sharedbooleanGets or sets a value that indicates whether the Workbook is shared.
languageCodeCountryCodeGets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
regionCountryCodeGets or sets the regional settings for workbook.
globalizationSettingsGlobalizationSettingsGets and sets the globalization settings.
numberDecimalSeparatorstringGets or sets the decimal separator for formatting/parsing numeric values. Default is the decimal separator of current Region.
numberGroupSeparatorstringGets or sets the character that separates groups of digits to the left of the decimal in numeric values. Default is the group separator of current Region.
passwordstringRepresents Workbook file encryption password.
writeProtectionWriteProtectionReadonly. Provides access to the workbook write protection options.
isEncryptedbooleanReadonly. Gets a value that indicates whether a password is required to open this workbook.
isProtectedbooleanReadonly. Gets a value that indicates whether the structure or window of the Workbook is protected.
isDefaultEncryptedbooleanIndicates whether encrypting the workbook with default password if Structure and Windows of the workbook are locked.
isMinimizedbooleanRepresents whether the generated spreadsheet will be opened Minimized.
isHiddenbooleanIndicates whether this workbook is hidden.
autoCompressPicturesbooleanSpecifies a boolean value that indicates the application automatically compressed pictures in the workbook.
removePersonalInformationbooleanTrue if personal information can be removed from the specified workbook.
hidePivotFieldListbooleanGets and sets whether hide the field list for the PivotTable.
updateLinksTypeUpdateLinksTypeGets and sets how updates external links when the workbook is opened.
maxRownumberReadonly. Gets the max row index, zero-based.
maxColumnnumberReadonly. Gets the max column index, zero-based.
defaultStyleSettingsDefaultStyleSettingsReadonly. Gets the settings for default values of style-related properties for this workbook.
windowLeftnumberThe distance from the left edge of the client area to the left edge of the window, in unit of point.
windowLeftInchnumberThe distance from the left edge of the client area to the left edge of the window. In unit of inch.
windowLeftCMnumberThe distance from the left edge of the client area to the left edge of the window. In unit of centimeter.
windowTopnumberThe distance from the top edge of the client area to the top edge of the window, in unit of point.
windowTopInchnumberThe distance from the top edge of the client area to the top edge of the window, in unit of inch.
windowTopCMnumberThe distance from the top edge of the client area to the top edge of the window, in unit of centimeter.
windowWidthnumberThe width of the window, in unit of point.
windowWidthInchnumberThe width of the window, in unit of inch.
windowWidthCMnumberThe width of the window, in unit of centimeter.
windowHeightnumberThe height of the window, in unit of point.
windowHeightInchnumberThe height of the window, in unit of inch.
windowHeightCMnumberThe height of the window, in unit of centimeter.
updateAdjacentCellsBorderbooleanIndicates whether update adjacent cells’ border.
significantDigitsnumberGets and sets the number of significant digits. The default value is CellsHelper.SignificantDigits.
checkCompatibilitybooleanIndicates whether check compatibility with earlier versions when saving workbook.
checkExcelRestrictionbooleanWhether 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.
autoRecoverbooleanIndicates whether the file is marked for auto-recovery.
crashSavebooleanindicates whether the application last saved the workbook file after a crash.
dataExtractLoadbooleanindicates whether the application last opened the workbook for data recovery.
repairLoadbooleanIndicates whether the application last opened the workbook in safe or repair mode.
buildVersionstringSpecifies the incremental public release of the application.
memorySettingMemorySettingGets or sets the memory usage options. The new option will be taken as the default option for newly created worksheets but does not take effect for existing worksheets.
paperSizePaperSizeTypeGets and sets the default print paper size.
warningCallbackIWarningCallbackGets or sets warning callback.
maxRowsOfSharedFormulanumberGets and sets the max row number of shared formula.
complianceOoxmlComplianceSpecifies the OOXML version for the output document. The default value is Ecma376_2006.
quotePrefixToStylebooleanIndicates whether setting Style.QuotePrefix property when entering the string value(which starts with single quote mark ) to the cell
formulaSettingsFormulaSettingsReadonly. Gets the settings for formula-related features.
propertiesFollowChartPointbooleanIndicates whether datapoint properties and datalabels in all charts in this workbook follow their reference.
discardImageEditDatabooleanIndicates whether discarding editting image data.
defaultImageResolutionnumberGets and sets default resolution of image.

Methods

MethodDescription
getAuthor()@deprecated. Please use the ‘author’ property instead. Gets and sets the author of the file.
setAuthor(string)@deprecated. Please use the ‘author’ property instead. Gets and sets the author of the file.
getCheckCustomNumberFormat()@deprecated. Please use the ‘checkCustomNumberFormat’ property instead. Indicates whether checking custom number format when setting Style.Custom.
setCheckCustomNumberFormat(boolean)@deprecated. Please use the ‘checkCustomNumberFormat’ property instead. Indicates whether checking custom number format when setting Style.Custom.
getEnableMacros()@deprecated. Please use the ’enableMacros’ property instead. Enable macros;
setEnableMacros(boolean)@deprecated. Please use the ’enableMacros’ property instead. Enable macros;
getDate1904()@deprecated. Please use the ‘date1904’ property instead. Gets or sets a value which represents if the workbook uses the 1904 date system.
setDate1904(boolean)@deprecated. Please use the ‘date1904’ property instead. Gets or sets a value which represents if the workbook uses the 1904 date system.
getProtectionType()@deprecated. Please use the ‘protectionType’ property instead. Gets the protection type of the workbook.
getDisplayDrawingObjects()@deprecated. Please use the ‘displayDrawingObjects’ property instead. Indicates whether and how to show objects in the workbook.
setDisplayDrawingObjects(DisplayDrawingObjects)@deprecated. Please use the ‘displayDrawingObjects’ property instead. Indicates whether and how to show objects in the workbook.
getSheetTabBarWidth()@deprecated. Please use the ‘sheetTabBarWidth’ property instead. Width of worksheet tab bar (in 1/1000 of window width).
setSheetTabBarWidth(number)@deprecated. Please use the ‘sheetTabBarWidth’ property instead. Width of worksheet tab bar (in 1/1000 of window width).
getShowTabs()@deprecated. Please use the ‘showTabs’ property instead. Get or sets a value whether the Workbook tabs are displayed.
setShowTabs(boolean)@deprecated. Please use the ‘showTabs’ property instead. Get or sets a value whether the Workbook tabs are displayed.
getFirstVisibleTab()@deprecated. Please use the ‘firstVisibleTab’ property instead. Gets or sets the first visible worksheet tab.
setFirstVisibleTab(number)@deprecated. Please use the ‘firstVisibleTab’ property instead. Gets or sets the first visible worksheet tab.
isHScrollBarVisible()@deprecated. Please use the ‘isHScrollBarVisible’ property instead. Gets or sets a value indicating whether the generated spreadsheet will contain a horizontal scroll bar.
setIsHScrollBarVisible(boolean)@deprecated. Please use the ‘isHScrollBarVisible’ property instead. Gets or sets a value indicating whether the generated spreadsheet will contain a horizontal scroll bar.
isVScrollBarVisible()@deprecated. Please use the ‘isVScrollBarVisible’ property instead. Gets or sets a value indicating whether the generated spreadsheet will contain a vertical scroll bar.
setIsVScrollBarVisible(boolean)@deprecated. Please use the ‘isVScrollBarVisible’ property instead. Gets or sets a value indicating whether the generated spreadsheet will contain a vertical scroll bar.
getShared()@deprecated. Please use the ‘shared’ property instead. Gets or sets a value that indicates whether the Workbook is shared.
setShared(boolean)@deprecated. Please use the ‘shared’ property instead. Gets or sets a value that indicates whether the Workbook is shared.
getLanguageCode()@deprecated. Please use the ’languageCode’ property instead. Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
setLanguageCode(CountryCode)@deprecated. Please use the ’languageCode’ property instead. Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
getRegion()@deprecated. Please use the ‘region’ property instead. Gets or sets the regional settings for workbook.
setRegion(CountryCode)@deprecated. Please use the ‘region’ property instead. Gets or sets the regional settings for workbook.
getGlobalizationSettings()@deprecated. Please use the ‘globalizationSettings’ property instead. Gets and sets the globalization settings.
setGlobalizationSettings(GlobalizationSettings)@deprecated. Please use the ‘globalizationSettings’ property instead. Gets and sets the globalization settings.
getNumberDecimalSeparator()@deprecated. Please use the ’numberDecimalSeparator’ property instead. Gets or sets the decimal separator for formatting/parsing numeric values. Default is the decimal separator of current Region.
setNumberDecimalSeparator(string)@deprecated. Please use the ’numberDecimalSeparator’ property instead. Gets or sets the decimal separator for formatting/parsing numeric values. Default is the decimal separator of current Region.
getNumberGroupSeparator()@deprecated. Please use the ’numberGroupSeparator’ property instead. Gets or sets the character that separates groups of digits to the left of the decimal in numeric values. Default is the group separator of current Region.
setNumberGroupSeparator(string)@deprecated. Please use the ’numberGroupSeparator’ property instead. Gets or sets the character that separates groups of digits to the left of the decimal in numeric values. Default is the group separator of current Region.
getPassword()@deprecated. Please use the ‘password’ property instead. Represents Workbook file encryption password.
setPassword(string)@deprecated. Please use the ‘password’ property instead. Represents Workbook file encryption password.
getWriteProtection()@deprecated. Please use the ‘writeProtection’ property instead. Provides access to the workbook write protection options.
isEncrypted()@deprecated. Please use the ‘isEncrypted’ property instead. Gets a value that indicates whether a password is required to open this workbook.
isProtected()@deprecated. Please use the ‘isProtected’ property instead. Gets a value that indicates whether the structure or window of the Workbook is protected.
isDefaultEncrypted()@deprecated. Please use the ‘isDefaultEncrypted’ property instead. Indicates whether encrypting the workbook with default password if Structure and Windows of the workbook are locked.
setIsDefaultEncrypted(boolean)@deprecated. Please use the ‘isDefaultEncrypted’ property instead. Indicates whether encrypting the workbook with default password if Structure and Windows of the workbook are locked.
isMinimized()@deprecated. Please use the ‘isMinimized’ property instead. Represents whether the generated spreadsheet will be opened Minimized.
setIsMinimized(boolean)@deprecated. Please use the ‘isMinimized’ property instead. Represents whether the generated spreadsheet will be opened Minimized.
isHidden()@deprecated. Please use the ‘isHidden’ property instead. Indicates whether this workbook is hidden.
setIsHidden(boolean)@deprecated. Please use the ‘isHidden’ property instead. Indicates whether this workbook is hidden.
getAutoCompressPictures()@deprecated. Please use the ‘autoCompressPictures’ property instead. Specifies a boolean value that indicates the application automatically compressed pictures in the workbook.
setAutoCompressPictures(boolean)@deprecated. Please use the ‘autoCompressPictures’ property instead. Specifies a boolean value that indicates the application automatically compressed pictures in the workbook.
getRemovePersonalInformation()@deprecated. Please use the ‘removePersonalInformation’ property instead. True if personal information can be removed from the specified workbook.
setRemovePersonalInformation(boolean)@deprecated. Please use the ‘removePersonalInformation’ property instead. True if personal information can be removed from the specified workbook.
getHidePivotFieldList()@deprecated. Please use the ‘hidePivotFieldList’ property instead. Gets and sets whether hide the field list for the PivotTable.
setHidePivotFieldList(boolean)@deprecated. Please use the ‘hidePivotFieldList’ property instead. Gets and sets whether hide the field list for the PivotTable.
getUpdateLinksType()@deprecated. Please use the ‘updateLinksType’ property instead. Gets and sets how updates external links when the workbook is opened.
setUpdateLinksType(UpdateLinksType)@deprecated. Please use the ‘updateLinksType’ property instead. Gets and sets how updates external links when the workbook is opened.
getMaxRow()@deprecated. Please use the ‘maxRow’ property instead. Gets the max row index, zero-based.
getMaxColumn()@deprecated. Please use the ‘maxColumn’ property instead. Gets the max column index, zero-based.
getDefaultStyleSettings()@deprecated. Please use the ‘defaultStyleSettings’ property instead. Gets the settings for default values of style-related properties for this workbook.
getWindowLeft()@deprecated. Please use the ‘windowLeft’ property instead. The distance from the left edge of the client area to the left edge of the window, in unit of point.
setWindowLeft(number)@deprecated. Please use the ‘windowLeft’ property instead. The distance from the left edge of the client area to the left edge of the window, in unit of point.
getWindowLeftInch()@deprecated. Please use the ‘windowLeftInch’ property instead. The distance from the left edge of the client area to the left edge of the window. In unit of inch.
setWindowLeftInch(number)@deprecated. Please use the ‘windowLeftInch’ property instead. The distance from the left edge of the client area to the left edge of the window. In unit of inch.
getWindowLeftCM()@deprecated. Please use the ‘windowLeftCM’ property instead. The distance from the left edge of the client area to the left edge of the window. In unit of centimeter.
setWindowLeftCM(number)@deprecated. Please use the ‘windowLeftCM’ property instead. The distance from the left edge of the client area to the left edge of the window. In unit of centimeter.
getWindowTop()@deprecated. Please use the ‘windowTop’ property instead. The distance from the top edge of the client area to the top edge of the window, in unit of point.
setWindowTop(number)@deprecated. Please use the ‘windowTop’ property instead. The distance from the top edge of the client area to the top edge of the window, in unit of point.
getWindowTopInch()@deprecated. Please use the ‘windowTopInch’ property instead. The distance from the top edge of the client area to the top edge of the window, in unit of inch.
setWindowTopInch(number)@deprecated. Please use the ‘windowTopInch’ property instead. The distance from the top edge of the client area to the top edge of the window, in unit of inch.
getWindowTopCM()@deprecated. Please use the ‘windowTopCM’ property instead. The distance from the top edge of the client area to the top edge of the window, in unit of centimeter.
setWindowTopCM(number)@deprecated. Please use the ‘windowTopCM’ property instead. The distance from the top edge of the client area to the top edge of the window, in unit of centimeter.
getWindowWidth()@deprecated. Please use the ‘windowWidth’ property instead. The width of the window, in unit of point.
setWindowWidth(number)@deprecated. Please use the ‘windowWidth’ property instead. The width of the window, in unit of point.
getWindowWidthInch()@deprecated. Please use the ‘windowWidthInch’ property instead. The width of the window, in unit of inch.
setWindowWidthInch(number)@deprecated. Please use the ‘windowWidthInch’ property instead. The width of the window, in unit of inch.
getWindowWidthCM()@deprecated. Please use the ‘windowWidthCM’ property instead. The width of the window, in unit of centimeter.
setWindowWidthCM(number)@deprecated. Please use the ‘windowWidthCM’ property instead. The width of the window, in unit of centimeter.
getWindowHeight()@deprecated. Please use the ‘windowHeight’ property instead. The height of the window, in unit of point.
setWindowHeight(number)@deprecated. Please use the ‘windowHeight’ property instead. The height of the window, in unit of point.
getWindowHeightInch()@deprecated. Please use the ‘windowHeightInch’ property instead. The height of the window, in unit of inch.
setWindowHeightInch(number)@deprecated. Please use the ‘windowHeightInch’ property instead. The height of the window, in unit of inch.
getWindowHeightCM()@deprecated. Please use the ‘windowHeightCM’ property instead. The height of the window, in unit of centimeter.
setWindowHeightCM(number)@deprecated. Please use the ‘windowHeightCM’ property instead. The height of the window, in unit of centimeter.
getUpdateAdjacentCellsBorder()@deprecated. Please use the ‘updateAdjacentCellsBorder’ property instead. Indicates whether update adjacent cells’ border.
setUpdateAdjacentCellsBorder(boolean)@deprecated. Please use the ‘updateAdjacentCellsBorder’ property instead. Indicates whether update adjacent cells’ border.
getSignificantDigits()@deprecated. Please use the ‘significantDigits’ property instead. Gets and sets the number of significant digits. The default value is CellsHelper.SignificantDigits.
setSignificantDigits(number)@deprecated. Please use the ‘significantDigits’ property instead. Gets and sets the number of significant digits. The default value is CellsHelper.SignificantDigits.
getCheckCompatibility()@deprecated. Please use the ‘checkCompatibility’ property instead. Indicates whether check compatibility with earlier versions when saving workbook.
setCheckCompatibility(boolean)@deprecated. Please use the ‘checkCompatibility’ property instead. Indicates whether check compatibility with earlier versions when saving workbook.
getCheckExcelRestriction()@deprecated. Please use the ‘checkExcelRestriction’ property instead. 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.
setCheckExcelRestriction(boolean)@deprecated. Please use the ‘checkExcelRestriction’ property instead. 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.
getAutoRecover()@deprecated. Please use the ‘autoRecover’ property instead. Indicates whether the file is marked for auto-recovery.
setAutoRecover(boolean)@deprecated. Please use the ‘autoRecover’ property instead. Indicates whether the file is marked for auto-recovery.
getCrashSave()@deprecated. Please use the ‘crashSave’ property instead. indicates whether the application last saved the workbook file after a crash.
setCrashSave(boolean)@deprecated. Please use the ‘crashSave’ property instead. indicates whether the application last saved the workbook file after a crash.
getDataExtractLoad()@deprecated. Please use the ‘dataExtractLoad’ property instead. indicates whether the application last opened the workbook for data recovery.
setDataExtractLoad(boolean)@deprecated. Please use the ‘dataExtractLoad’ property instead. indicates whether the application last opened the workbook for data recovery.
getRepairLoad()@deprecated. Please use the ‘repairLoad’ property instead. Indicates whether the application last opened the workbook in safe or repair mode.
setRepairLoad(boolean)@deprecated. Please use the ‘repairLoad’ property instead. Indicates whether the application last opened the workbook in safe or repair mode.
getBuildVersion()@deprecated. Please use the ‘buildVersion’ property instead. Specifies the incremental public release of the application.
setBuildVersion(string)@deprecated. Please use the ‘buildVersion’ property instead. Specifies the incremental public release of the application.
getMemorySetting()@deprecated. Please use the ‘memorySetting’ property instead. Gets or sets the memory usage options. The new option will be taken as the default option for newly created worksheets but does not take effect for existing worksheets.
setMemorySetting(MemorySetting)@deprecated. Please use the ‘memorySetting’ property instead. Gets or sets the memory usage options. The new option will be taken as the default option for newly created worksheets but does not take effect for existing worksheets.
getPaperSize()@deprecated. Please use the ‘paperSize’ property instead. Gets and sets the default print paper size.
setPaperSize(PaperSizeType)@deprecated. Please use the ‘paperSize’ property instead. Gets and sets the default print paper size.
setWarningCallback(IWarningCallback)@deprecated. Please use the ‘warningCallback’ property instead. Gets or sets warning callback.
getWarningCallback()@deprecated. Please use the ‘warningCallback’ property instead. Gets or sets warning callback.
getMaxRowsOfSharedFormula()@deprecated. Please use the ‘maxRowsOfSharedFormula’ property instead. Gets and sets the max row number of shared formula.
setMaxRowsOfSharedFormula(number)@deprecated. Please use the ‘maxRowsOfSharedFormula’ property instead. Gets and sets the max row number of shared formula.
getCompliance()@deprecated. Please use the ‘compliance’ property instead. Specifies the OOXML version for the output document. The default value is Ecma376_2006.
setCompliance(OoxmlCompliance)@deprecated. Please use the ‘compliance’ property instead. Specifies the OOXML version for the output document. The default value is Ecma376_2006.
getQuotePrefixToStyle()@deprecated. Please use the ‘quotePrefixToStyle’ property instead. Indicates whether setting Style.QuotePrefix property when entering the string value(which starts with single quote mark ) to the cell
setQuotePrefixToStyle(boolean)@deprecated. Please use the ‘quotePrefixToStyle’ property instead. Indicates whether setting Style.QuotePrefix property when entering the string value(which starts with single quote mark ) to the cell
getFormulaSettings()@deprecated. Please use the ‘formulaSettings’ property instead. Gets the settings for formula-related features.
getPropertiesFollowChartPoint()@deprecated. Please use the ‘propertiesFollowChartPoint’ property instead. Indicates whether datapoint properties and datalabels in all charts in this workbook follow their reference.
setPropertiesFollowChartPoint(boolean)@deprecated. Please use the ‘propertiesFollowChartPoint’ property instead. Indicates whether datapoint properties and datalabels in all charts in this workbook follow their reference.
getDiscardImageEditData()@deprecated. Please use the ‘discardImageEditData’ property instead. Indicates whether discarding editting image data.
setDiscardImageEditData(boolean)@deprecated. Please use the ‘discardImageEditData’ property instead. Indicates whether discarding editting image data.
getDefaultImageResolution()@deprecated. Please use the ‘defaultImageResolution’ property instead. Gets and sets default resolution of image.
setDefaultImageResolution(number)@deprecated. Please use the ‘defaultImageResolution’ property instead. Gets and sets default resolution of image.
dispose()Releases resources.
getThemeFont(FontSchemeType)Gets the default theme font name.
setPageOrientationType(PageOrientationType)Set the type of print orientation for the whole workbook.
isNull()Checks whether the implementation object is null.

author

Gets and sets the author of the file.

author : string;

Remarks

It’’s not set, check BuiltInDocumentPropertyCollection.Author first, then check the user of Environment.

checkCustomNumberFormat

Indicates whether checking custom number format when setting Style.Custom.

checkCustomNumberFormat : boolean;

enableMacros

Enable macros;

enableMacros : boolean;

Remarks

Now it only works when copying a worksheet to other worksheet in a workbook.

date1904

Gets or sets a value which represents if the workbook uses the 1904 date system.

date1904 : boolean;

protectionType

Readonly. Gets the protection type of the workbook.

protectionType : ProtectionType;

displayDrawingObjects

Indicates whether and how to show objects in the workbook.

displayDrawingObjects : DisplayDrawingObjects;

sheetTabBarWidth

Width of worksheet tab bar (in 1/1000 of window width).

sheetTabBarWidth : number;

showTabs

Get or sets a value whether the Workbook tabs are displayed.

showTabs : boolean;

Remarks

The default value is true.

Example

The following code hides the Sheet Tabs and Tab Scrolling Buttons for the spreadsheet.

const { Workbook } = require("aspose.cells.node");

var workbook = new Workbook();
// Hide the spreadsheet tabs.
workbook.settings.showTabs = false;

firstVisibleTab

Gets or sets the first visible worksheet tab.

firstVisibleTab : number;

isHScrollBarVisible

Gets or sets a value indicating whether the generated spreadsheet will contain a horizontal scroll bar.

isHScrollBarVisible : boolean;

Remarks

The default value is true.

Example

The following code makes the horizontal scroll bar invisible for the spreadsheet.

const { Workbook } = require("aspose.cells.node");

var workbook = new Workbook();
// Hide the horizontal scroll bar of the Excel file.
workbook.settings.isHScrollBarVisible = false;

isVScrollBarVisible

Gets or sets a value indicating whether the generated spreadsheet will contain a vertical scroll bar.

isVScrollBarVisible : boolean;

Remarks

The default value is true.

Example

The following code makes the vertical scroll bar invisible for the spreadsheet.

const { Workbook } = require("aspose.cells.node");

var workbook = new Workbook();
// Hide the vertical scroll bar of the Excel file.
workbook.settings.isVScrollBarVisible = false;

shared

Gets or sets a value that indicates whether the Workbook is shared.

shared : boolean;

Remarks

The default value is false.

languageCode

Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.

languageCode : CountryCode;

region

Gets or sets the regional settings for workbook.

region : CountryCode;

Remarks

  1. Regional settings used by Aspose.Cells component for a workbook loaded from template file: i). For an XLS file, there are fields defined for regional settings and MS Excel does save regional settings data into the file when saving the XLS file. So, we use the saved region in the template file for the workbook. If you do not want to use the region saved in the XLS file, please reset it to the expected one (such as, CountryCode.Default) after loading the template file. And, we save the user specified value (by this method) into the file too when saving an XLS file. ii). For other file formats, such as, XLSX, XLSB…etc., there is no field defined for regional settings in the file format specification. So, we use the regional settings of application’s environment for the workbook. And, the user specified value (by this method) cannot be kept for the generated files with those file formats. 2. For the view effect in MS Excel: The applied regional settings here can take effect only at runtime with Aspose.Cells component and not when viewing the generated file with MS Excel. Even for the generated XLS file in which the specified regional settings data has been saved, when viewing/editing it with MS Excel, the used region to perform formatting by MS Excel is always the default regional settings of the environment where MS Excel is running, not the one saved in the file. It is MS Excel’s behavior and cannot be changed by code.

globalizationSettings

Gets and sets the globalization settings.

globalizationSettings : GlobalizationSettings;

numberDecimalSeparator

Gets or sets the decimal separator for formatting/parsing numeric values. Default is the decimal separator of current Region.

numberDecimalSeparator : string;

numberGroupSeparator

Gets or sets the character that separates groups of digits to the left of the decimal in numeric values. Default is the group separator of current Region.

numberGroupSeparator : string;

password

Represents Workbook file encryption password.

password : string;

writeProtection

Readonly. Provides access to the workbook write protection options.

writeProtection : WriteProtection;

isEncrypted

Readonly. Gets a value that indicates whether a password is required to open this workbook.

isEncrypted : boolean;

isProtected

Readonly. Gets a value that indicates whether the structure or window of the Workbook is protected.

isProtected : boolean;

isDefaultEncrypted

Indicates whether encrypting the workbook with default password if Structure and Windows of the workbook are locked.

isDefaultEncrypted : boolean;

Remarks

The default value is false now. It’s same as MS Excel 2013.

isMinimized

Represents whether the generated spreadsheet will be opened Minimized.

isMinimized : boolean;

isHidden

Indicates whether this workbook is hidden.

isHidden : boolean;

autoCompressPictures

Specifies a boolean value that indicates the application automatically compressed pictures in the workbook.

autoCompressPictures : boolean;

removePersonalInformation

True if personal information can be removed from the specified workbook.

removePersonalInformation : boolean;

hidePivotFieldList

Gets and sets whether hide the field list for the PivotTable.

hidePivotFieldList : boolean;

updateLinksType

Gets and sets how updates external links when the workbook is opened.

updateLinksType : UpdateLinksType;

maxRow

Readonly. Gets the max row index, zero-based.

maxRow : number;

Remarks

Returns 65535 if the file format is Excel97-2003;

maxColumn

Readonly. Gets the max column index, zero-based.

maxColumn : number;

Remarks

Returns 255 if the file format is Excel97-2003;

defaultStyleSettings

Readonly. Gets the settings for default values of style-related properties for this workbook.

defaultStyleSettings : DefaultStyleSettings;

windowLeft

The distance from the left edge of the client area to the left edge of the window, in unit of point.

windowLeft : number;

windowLeftInch

The distance from the left edge of the client area to the left edge of the window. In unit of inch.

windowLeftInch : number;

windowLeftCM

The distance from the left edge of the client area to the left edge of the window. In unit of centimeter.

windowLeftCM : number;

windowTop

The distance from the top edge of the client area to the top edge of the window, in unit of point.

windowTop : number;

windowTopInch

The distance from the top edge of the client area to the top edge of the window, in unit of inch.

windowTopInch : number;

windowTopCM

The distance from the top edge of the client area to the top edge of the window, in unit of centimeter.

windowTopCM : number;

windowWidth

The width of the window, in unit of point.

windowWidth : number;

windowWidthInch

The width of the window, in unit of inch.

windowWidthInch : number;

windowWidthCM

The width of the window, in unit of centimeter.

windowWidthCM : number;

windowHeight

The height of the window, in unit of point.

windowHeight : number;

windowHeightInch

The height of the window, in unit of inch.

windowHeightInch : number;

windowHeightCM

The height of the window, in unit of centimeter.

windowHeightCM : number;

updateAdjacentCellsBorder

Indicates whether update adjacent cells’ border.

updateAdjacentCellsBorder : boolean;

Remarks

The default value is false. For example: the bottom border of the cell A1 is update, the top border of the cell A2 should be changed too.

significantDigits

Gets and sets the number of significant digits. The default value is CellsHelper.SignificantDigits.

significantDigits : number;

Remarks

Only could be 15 or 17 now.

checkCompatibility

Indicates whether check compatibility with earlier versions when saving workbook.

checkCompatibility : boolean;

Remarks

The default value is true. Only for Excel97-2003 xls or xlt files.

checkExcelRestriction

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.

checkExcelRestriction : boolean;

autoRecover

Indicates whether the file is marked for auto-recovery.

autoRecover : boolean;

crashSave

indicates whether the application last saved the workbook file after a crash.

crashSave : boolean;

dataExtractLoad

indicates whether the application last opened the workbook for data recovery.

dataExtractLoad : boolean;

repairLoad

Indicates whether the application last opened the workbook in safe or repair mode.

repairLoad : boolean;

buildVersion

Specifies the incremental public release of the application.

buildVersion : string;

memorySetting

Gets or sets the memory usage options. The new option will be taken as the default option for newly created worksheets but does not take effect for existing worksheets.

memorySetting : MemorySetting;

paperSize

Gets and sets the default print paper size.

paperSize : PaperSizeType;

Remarks

If there is no setting about paper size,MS Excel will use default printer’s setting.

warningCallback

Gets or sets warning callback.

warningCallback : IWarningCallback;

maxRowsOfSharedFormula

Gets and sets the max row number of shared formula.

maxRowsOfSharedFormula : number;

Remarks

If the number is too large, the autofilter works very slow in MS Excel 2013.

compliance

Specifies the OOXML version for the output document. The default value is Ecma376_2006.

compliance : OoxmlCompliance;

Remarks

Only for .xlsx files.

quotePrefixToStyle

Indicates whether setting Style.QuotePrefix property when entering the string value(which starts with single quote mark ) to the cell

quotePrefixToStyle : boolean;

formulaSettings

Readonly. Gets the settings for formula-related features.

formulaSettings : FormulaSettings;

propertiesFollowChartPoint

Indicates whether datapoint properties and datalabels in all charts in this workbook follow their reference.

propertiesFollowChartPoint : boolean;

discardImageEditData

Indicates whether discarding editting image data.

discardImageEditData : boolean;

defaultImageResolution

Gets and sets default resolution of image.

defaultImageResolution : number;

getAuthor()

@deprecated. Please use the ‘author’ property instead. Gets and sets the author of the file.

getAuthor() : string;

Remarks

It’’s not set, check BuiltInDocumentPropertyCollection.Author first, then check the user of Environment.

setAuthor(string)

@deprecated. Please use the ‘author’ property instead. Gets and sets the author of the file.

setAuthor(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

Remarks

It’’s not set, check BuiltInDocumentPropertyCollection.Author first, then check the user of Environment.

getCheckCustomNumberFormat()

@deprecated. Please use the ‘checkCustomNumberFormat’ property instead. Indicates whether checking custom number format when setting Style.Custom.

getCheckCustomNumberFormat() : boolean;

setCheckCustomNumberFormat(boolean)

@deprecated. Please use the ‘checkCustomNumberFormat’ property instead. Indicates whether checking custom number format when setting Style.Custom.

setCheckCustomNumberFormat(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getEnableMacros()

@deprecated. Please use the ’enableMacros’ property instead. Enable macros;

getEnableMacros() : boolean;

Remarks

Now it only works when copying a worksheet to other worksheet in a workbook.

setEnableMacros(boolean)

@deprecated. Please use the ’enableMacros’ property instead. Enable macros;

setEnableMacros(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

Remarks

Now it only works when copying a worksheet to other worksheet in a workbook.

getDate1904()

@deprecated. Please use the ‘date1904’ property instead. Gets or sets a value which represents if the workbook uses the 1904 date system.

getDate1904() : boolean;

setDate1904(boolean)

@deprecated. Please use the ‘date1904’ property instead. Gets or sets a value which represents if the workbook uses the 1904 date system.

setDate1904(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getProtectionType()

@deprecated. Please use the ‘protectionType’ property instead. Gets the protection type of the workbook.

getProtectionType() : ProtectionType;

Returns

ProtectionType

getDisplayDrawingObjects()

@deprecated. Please use the ‘displayDrawingObjects’ property instead. Indicates whether and how to show objects in the workbook.

getDisplayDrawingObjects() : DisplayDrawingObjects;

Returns

DisplayDrawingObjects

setDisplayDrawingObjects(DisplayDrawingObjects)

@deprecated. Please use the ‘displayDrawingObjects’ property instead. Indicates whether and how to show objects in the workbook.

setDisplayDrawingObjects(value: DisplayDrawingObjects) : void;

Parameters:

ParameterTypeDescription
valueDisplayDrawingObjectsThe value to set.

getSheetTabBarWidth()

@deprecated. Please use the ‘sheetTabBarWidth’ property instead. Width of worksheet tab bar (in 1/1000 of window width).

getSheetTabBarWidth() : number;

setSheetTabBarWidth(number)

@deprecated. Please use the ‘sheetTabBarWidth’ property instead. Width of worksheet tab bar (in 1/1000 of window width).

setSheetTabBarWidth(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

getShowTabs()

@deprecated. Please use the ‘showTabs’ property instead. Get or sets a value whether the Workbook tabs are displayed.

getShowTabs() : boolean;

Remarks

The default value is true.

setShowTabs(boolean)

@deprecated. Please use the ‘showTabs’ property instead. Get or sets a value whether the Workbook tabs are displayed.

setShowTabs(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

Remarks

The default value is true.

getFirstVisibleTab()

@deprecated. Please use the ‘firstVisibleTab’ property instead. Gets or sets the first visible worksheet tab.

getFirstVisibleTab() : number;

setFirstVisibleTab(number)

@deprecated. Please use the ‘firstVisibleTab’ property instead. Gets or sets the first visible worksheet tab.

setFirstVisibleTab(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

isHScrollBarVisible()

@deprecated. Please use the ‘isHScrollBarVisible’ property instead. Gets or sets a value indicating whether the generated spreadsheet will contain a horizontal scroll bar.

isHScrollBarVisible() : boolean;

Remarks

The default value is true.

setIsHScrollBarVisible(boolean)

@deprecated. Please use the ‘isHScrollBarVisible’ property instead. Gets or sets a value indicating whether the generated spreadsheet will contain a horizontal scroll bar.

setIsHScrollBarVisible(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

Remarks

The default value is true.

isVScrollBarVisible()

@deprecated. Please use the ‘isVScrollBarVisible’ property instead. Gets or sets a value indicating whether the generated spreadsheet will contain a vertical scroll bar.

isVScrollBarVisible() : boolean;

Remarks

The default value is true.

setIsVScrollBarVisible(boolean)

@deprecated. Please use the ‘isVScrollBarVisible’ property instead. Gets or sets a value indicating whether the generated spreadsheet will contain a vertical scroll bar.

setIsVScrollBarVisible(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

Remarks

The default value is true.

getShared()

@deprecated. Please use the ‘shared’ property instead. Gets or sets a value that indicates whether the Workbook is shared.

getShared() : boolean;

Remarks

The default value is false.

setShared(boolean)

@deprecated. Please use the ‘shared’ property instead. Gets or sets a value that indicates whether the Workbook is shared.

setShared(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

Remarks

The default value is false.

getLanguageCode()

@deprecated. Please use the ’languageCode’ property instead. Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.

getLanguageCode() : CountryCode;

Returns

CountryCode

setLanguageCode(CountryCode)

@deprecated. Please use the ’languageCode’ property instead. Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.

setLanguageCode(value: CountryCode) : void;

Parameters:

ParameterTypeDescription
valueCountryCodeThe value to set.

getRegion()

@deprecated. Please use the ‘region’ property instead. Gets or sets the regional settings for workbook.

getRegion() : CountryCode;

Returns

CountryCode

Remarks

  1. Regional settings used by Aspose.Cells component for a workbook loaded from template file: i). For an XLS file, there are fields defined for regional settings and MS Excel does save regional settings data into the file when saving the XLS file. So, we use the saved region in the template file for the workbook. If you do not want to use the region saved in the XLS file, please reset it to the expected one (such as, CountryCode.Default) after loading the template file. And, we save the user specified value (by this method) into the file too when saving an XLS file. ii). For other file formats, such as, XLSX, XLSB…etc., there is no field defined for regional settings in the file format specification. So, we use the regional settings of application’s environment for the workbook. And, the user specified value (by this method) cannot be kept for the generated files with those file formats. 2. For the view effect in MS Excel: The applied regional settings here can take effect only at runtime with Aspose.Cells component and not when viewing the generated file with MS Excel. Even for the generated XLS file in which the specified regional settings data has been saved, when viewing/editing it with MS Excel, the used region to perform formatting by MS Excel is always the default regional settings of the environment where MS Excel is running, not the one saved in the file. It is MS Excel’s behavior and cannot be changed by code.

setRegion(CountryCode)

@deprecated. Please use the ‘region’ property instead. Gets or sets the regional settings for workbook.

setRegion(value: CountryCode) : void;

Parameters:

ParameterTypeDescription
valueCountryCodeThe value to set.

Remarks

  1. Regional settings used by Aspose.Cells component for a workbook loaded from template file: i). For an XLS file, there are fields defined for regional settings and MS Excel does save regional settings data into the file when saving the XLS file. So, we use the saved region in the template file for the workbook. If you do not want to use the region saved in the XLS file, please reset it to the expected one (such as, CountryCode.Default) after loading the template file. And, we save the user specified value (by this method) into the file too when saving an XLS file. ii). For other file formats, such as, XLSX, XLSB…etc., there is no field defined for regional settings in the file format specification. So, we use the regional settings of application’s environment for the workbook. And, the user specified value (by this method) cannot be kept for the generated files with those file formats. 2. For the view effect in MS Excel: The applied regional settings here can take effect only at runtime with Aspose.Cells component and not when viewing the generated file with MS Excel. Even for the generated XLS file in which the specified regional settings data has been saved, when viewing/editing it with MS Excel, the used region to perform formatting by MS Excel is always the default regional settings of the environment where MS Excel is running, not the one saved in the file. It is MS Excel’s behavior and cannot be changed by code.

getGlobalizationSettings()

@deprecated. Please use the ‘globalizationSettings’ property instead. Gets and sets the globalization settings.

getGlobalizationSettings() : GlobalizationSettings;

Returns

GlobalizationSettings

setGlobalizationSettings(GlobalizationSettings)

@deprecated. Please use the ‘globalizationSettings’ property instead. Gets and sets the globalization settings.

setGlobalizationSettings(value: GlobalizationSettings) : void;

Parameters:

ParameterTypeDescription
valueGlobalizationSettingsThe value to set.

getNumberDecimalSeparator()

@deprecated. Please use the ’numberDecimalSeparator’ property instead. Gets or sets the decimal separator for formatting/parsing numeric values. Default is the decimal separator of current Region.

getNumberDecimalSeparator() : string;

setNumberDecimalSeparator(string)

@deprecated. Please use the ’numberDecimalSeparator’ property instead. Gets or sets the decimal separator for formatting/parsing numeric values. Default is the decimal separator of current Region.

setNumberDecimalSeparator(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

getNumberGroupSeparator()

@deprecated. Please use the ’numberGroupSeparator’ property instead. Gets or sets the character that separates groups of digits to the left of the decimal in numeric values. Default is the group separator of current Region.

getNumberGroupSeparator() : string;

setNumberGroupSeparator(string)

@deprecated. Please use the ’numberGroupSeparator’ property instead. Gets or sets the character that separates groups of digits to the left of the decimal in numeric values. Default is the group separator of current Region.

setNumberGroupSeparator(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

getPassword()

@deprecated. Please use the ‘password’ property instead. Represents Workbook file encryption password.

getPassword() : string;

setPassword(string)

@deprecated. Please use the ‘password’ property instead. Represents Workbook file encryption password.

setPassword(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

getWriteProtection()

@deprecated. Please use the ‘writeProtection’ property instead. Provides access to the workbook write protection options.

getWriteProtection() : WriteProtection;

Returns

WriteProtection

isEncrypted()

@deprecated. Please use the ‘isEncrypted’ property instead. Gets a value that indicates whether a password is required to open this workbook.

isEncrypted() : boolean;

isProtected()

@deprecated. Please use the ‘isProtected’ property instead. Gets a value that indicates whether the structure or window of the Workbook is protected.

isProtected() : boolean;

isDefaultEncrypted()

@deprecated. Please use the ‘isDefaultEncrypted’ property instead. Indicates whether encrypting the workbook with default password if Structure and Windows of the workbook are locked.

isDefaultEncrypted() : boolean;

Remarks

The default value is false now. It’s same as MS Excel 2013.

setIsDefaultEncrypted(boolean)

@deprecated. Please use the ‘isDefaultEncrypted’ property instead. Indicates whether encrypting the workbook with default password if Structure and Windows of the workbook are locked.

setIsDefaultEncrypted(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

Remarks

The default value is false now. It’s same as MS Excel 2013.

isMinimized()

@deprecated. Please use the ‘isMinimized’ property instead. Represents whether the generated spreadsheet will be opened Minimized.

isMinimized() : boolean;

setIsMinimized(boolean)

@deprecated. Please use the ‘isMinimized’ property instead. Represents whether the generated spreadsheet will be opened Minimized.

setIsMinimized(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

isHidden()

@deprecated. Please use the ‘isHidden’ property instead. Indicates whether this workbook is hidden.

isHidden() : boolean;

setIsHidden(boolean)

@deprecated. Please use the ‘isHidden’ property instead. Indicates whether this workbook is hidden.

setIsHidden(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getAutoCompressPictures()

@deprecated. Please use the ‘autoCompressPictures’ property instead. Specifies a boolean value that indicates the application automatically compressed pictures in the workbook.

getAutoCompressPictures() : boolean;

setAutoCompressPictures(boolean)

@deprecated. Please use the ‘autoCompressPictures’ property instead. Specifies a boolean value that indicates the application automatically compressed pictures in the workbook.

setAutoCompressPictures(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getRemovePersonalInformation()

@deprecated. Please use the ‘removePersonalInformation’ property instead. True if personal information can be removed from the specified workbook.

getRemovePersonalInformation() : boolean;

setRemovePersonalInformation(boolean)

@deprecated. Please use the ‘removePersonalInformation’ property instead. True if personal information can be removed from the specified workbook.

setRemovePersonalInformation(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getHidePivotFieldList()

@deprecated. Please use the ‘hidePivotFieldList’ property instead. Gets and sets whether hide the field list for the PivotTable.

getHidePivotFieldList() : boolean;

setHidePivotFieldList(boolean)

@deprecated. Please use the ‘hidePivotFieldList’ property instead. Gets and sets whether hide the field list for the PivotTable.

setHidePivotFieldList(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getUpdateLinksType()

@deprecated. Please use the ‘updateLinksType’ property instead. Gets and sets how updates external links when the workbook is opened.

getUpdateLinksType() : UpdateLinksType;

Returns

UpdateLinksType

setUpdateLinksType(UpdateLinksType)

@deprecated. Please use the ‘updateLinksType’ property instead. Gets and sets how updates external links when the workbook is opened.

setUpdateLinksType(value: UpdateLinksType) : void;

Parameters:

ParameterTypeDescription
valueUpdateLinksTypeThe value to set.

getMaxRow()

@deprecated. Please use the ‘maxRow’ property instead. Gets the max row index, zero-based.

getMaxRow() : number;

Remarks

Returns 65535 if the file format is Excel97-2003;

getMaxColumn()

@deprecated. Please use the ‘maxColumn’ property instead. Gets the max column index, zero-based.

getMaxColumn() : number;

Remarks

Returns 255 if the file format is Excel97-2003;

getDefaultStyleSettings()

@deprecated. Please use the ‘defaultStyleSettings’ property instead. Gets the settings for default values of style-related properties for this workbook.

getDefaultStyleSettings() : DefaultStyleSettings;

Returns

DefaultStyleSettings

getWindowLeft()

@deprecated. Please use the ‘windowLeft’ property instead. The distance from the left edge of the client area to the left edge of the window, in unit of point.

getWindowLeft() : number;

setWindowLeft(number)

@deprecated. Please use the ‘windowLeft’ property instead. The distance from the left edge of the client area to the left edge of the window, in unit of point.

setWindowLeft(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

getWindowLeftInch()

@deprecated. Please use the ‘windowLeftInch’ property instead. The distance from the left edge of the client area to the left edge of the window. In unit of inch.

getWindowLeftInch() : number;

setWindowLeftInch(number)

@deprecated. Please use the ‘windowLeftInch’ property instead. The distance from the left edge of the client area to the left edge of the window. In unit of inch.

setWindowLeftInch(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

getWindowLeftCM()

@deprecated. Please use the ‘windowLeftCM’ property instead. The distance from the left edge of the client area to the left edge of the window. In unit of centimeter.

getWindowLeftCM() : number;

setWindowLeftCM(number)

@deprecated. Please use the ‘windowLeftCM’ property instead. The distance from the left edge of the client area to the left edge of the window. In unit of centimeter.

setWindowLeftCM(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

getWindowTop()

@deprecated. Please use the ‘windowTop’ property instead. The distance from the top edge of the client area to the top edge of the window, in unit of point.

getWindowTop() : number;

setWindowTop(number)

@deprecated. Please use the ‘windowTop’ property instead. The distance from the top edge of the client area to the top edge of the window, in unit of point.

setWindowTop(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

getWindowTopInch()

@deprecated. Please use the ‘windowTopInch’ property instead. The distance from the top edge of the client area to the top edge of the window, in unit of inch.

getWindowTopInch() : number;

setWindowTopInch(number)

@deprecated. Please use the ‘windowTopInch’ property instead. The distance from the top edge of the client area to the top edge of the window, in unit of inch.

setWindowTopInch(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

getWindowTopCM()

@deprecated. Please use the ‘windowTopCM’ property instead. The distance from the top edge of the client area to the top edge of the window, in unit of centimeter.

getWindowTopCM() : number;

setWindowTopCM(number)

@deprecated. Please use the ‘windowTopCM’ property instead. The distance from the top edge of the client area to the top edge of the window, in unit of centimeter.

setWindowTopCM(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

getWindowWidth()

@deprecated. Please use the ‘windowWidth’ property instead. The width of the window, in unit of point.

getWindowWidth() : number;

setWindowWidth(number)

@deprecated. Please use the ‘windowWidth’ property instead. The width of the window, in unit of point.

setWindowWidth(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

getWindowWidthInch()

@deprecated. Please use the ‘windowWidthInch’ property instead. The width of the window, in unit of inch.

getWindowWidthInch() : number;

setWindowWidthInch(number)

@deprecated. Please use the ‘windowWidthInch’ property instead. The width of the window, in unit of inch.

setWindowWidthInch(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

getWindowWidthCM()

@deprecated. Please use the ‘windowWidthCM’ property instead. The width of the window, in unit of centimeter.

getWindowWidthCM() : number;

setWindowWidthCM(number)

@deprecated. Please use the ‘windowWidthCM’ property instead. The width of the window, in unit of centimeter.

setWindowWidthCM(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

getWindowHeight()

@deprecated. Please use the ‘windowHeight’ property instead. The height of the window, in unit of point.

getWindowHeight() : number;

setWindowHeight(number)

@deprecated. Please use the ‘windowHeight’ property instead. The height of the window, in unit of point.

setWindowHeight(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

getWindowHeightInch()

@deprecated. Please use the ‘windowHeightInch’ property instead. The height of the window, in unit of inch.

getWindowHeightInch() : number;

setWindowHeightInch(number)

@deprecated. Please use the ‘windowHeightInch’ property instead. The height of the window, in unit of inch.

setWindowHeightInch(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

getWindowHeightCM()

@deprecated. Please use the ‘windowHeightCM’ property instead. The height of the window, in unit of centimeter.

getWindowHeightCM() : number;

setWindowHeightCM(number)

@deprecated. Please use the ‘windowHeightCM’ property instead. The height of the window, in unit of centimeter.

setWindowHeightCM(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

getUpdateAdjacentCellsBorder()

@deprecated. Please use the ‘updateAdjacentCellsBorder’ property instead. Indicates whether update adjacent cells’ border.

getUpdateAdjacentCellsBorder() : boolean;

Remarks

The default value is false. For example: the bottom border of the cell A1 is update, the top border of the cell A2 should be changed too.

setUpdateAdjacentCellsBorder(boolean)

@deprecated. Please use the ‘updateAdjacentCellsBorder’ property instead. Indicates whether update adjacent cells’ border.

setUpdateAdjacentCellsBorder(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

Remarks

The default value is false. For example: the bottom border of the cell A1 is update, the top border of the cell A2 should be changed too.

getSignificantDigits()

@deprecated. Please use the ‘significantDigits’ property instead. Gets and sets the number of significant digits. The default value is CellsHelper.SignificantDigits.

getSignificantDigits() : number;

Remarks

Only could be 15 or 17 now.

setSignificantDigits(number)

@deprecated. Please use the ‘significantDigits’ property instead. Gets and sets the number of significant digits. The default value is CellsHelper.SignificantDigits.

setSignificantDigits(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

Remarks

Only could be 15 or 17 now.

getCheckCompatibility()

@deprecated. Please use the ‘checkCompatibility’ property instead. Indicates whether check compatibility with earlier versions when saving workbook.

getCheckCompatibility() : boolean;

Remarks

The default value is true. Only for Excel97-2003 xls or xlt files.

setCheckCompatibility(boolean)

@deprecated. Please use the ‘checkCompatibility’ property instead. Indicates whether check compatibility with earlier versions when saving workbook.

setCheckCompatibility(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

Remarks

The default value is true. Only for Excel97-2003 xls or xlt files.

getCheckExcelRestriction()

@deprecated. Please use the ‘checkExcelRestriction’ property instead. 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.

getCheckExcelRestriction() : boolean;

setCheckExcelRestriction(boolean)

@deprecated. Please use the ‘checkExcelRestriction’ property instead. 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.

setCheckExcelRestriction(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getAutoRecover()

@deprecated. Please use the ‘autoRecover’ property instead. Indicates whether the file is marked for auto-recovery.

getAutoRecover() : boolean;

setAutoRecover(boolean)

@deprecated. Please use the ‘autoRecover’ property instead. Indicates whether the file is marked for auto-recovery.

setAutoRecover(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getCrashSave()

@deprecated. Please use the ‘crashSave’ property instead. indicates whether the application last saved the workbook file after a crash.

getCrashSave() : boolean;

setCrashSave(boolean)

@deprecated. Please use the ‘crashSave’ property instead. indicates whether the application last saved the workbook file after a crash.

setCrashSave(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getDataExtractLoad()

@deprecated. Please use the ‘dataExtractLoad’ property instead. indicates whether the application last opened the workbook for data recovery.

getDataExtractLoad() : boolean;

setDataExtractLoad(boolean)

@deprecated. Please use the ‘dataExtractLoad’ property instead. indicates whether the application last opened the workbook for data recovery.

setDataExtractLoad(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getRepairLoad()

@deprecated. Please use the ‘repairLoad’ property instead. Indicates whether the application last opened the workbook in safe or repair mode.

getRepairLoad() : boolean;

setRepairLoad(boolean)

@deprecated. Please use the ‘repairLoad’ property instead. Indicates whether the application last opened the workbook in safe or repair mode.

setRepairLoad(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getBuildVersion()

@deprecated. Please use the ‘buildVersion’ property instead. Specifies the incremental public release of the application.

getBuildVersion() : string;

setBuildVersion(string)

@deprecated. Please use the ‘buildVersion’ property instead. Specifies the incremental public release of the application.

setBuildVersion(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

getMemorySetting()

@deprecated. Please use the ‘memorySetting’ property instead. Gets or sets the memory usage options. The new option will be taken as the default option for newly created worksheets but does not take effect for existing worksheets.

getMemorySetting() : MemorySetting;

Returns

MemorySetting

setMemorySetting(MemorySetting)

@deprecated. Please use the ‘memorySetting’ property instead. Gets or sets the memory usage options. The new option will be taken as the default option for newly created worksheets but does not take effect for existing worksheets.

setMemorySetting(value: MemorySetting) : void;

Parameters:

ParameterTypeDescription
valueMemorySettingThe value to set.

getPaperSize()

@deprecated. Please use the ‘paperSize’ property instead. Gets and sets the default print paper size.

getPaperSize() : PaperSizeType;

Returns

PaperSizeType

Remarks

If there is no setting about paper size,MS Excel will use default printer’s setting.

setPaperSize(PaperSizeType)

@deprecated. Please use the ‘paperSize’ property instead. Gets and sets the default print paper size.

setPaperSize(value: PaperSizeType) : void;

Parameters:

ParameterTypeDescription
valuePaperSizeTypeThe value to set.

Remarks

If there is no setting about paper size,MS Excel will use default printer’s setting.

setWarningCallback(IWarningCallback)

@deprecated. Please use the ‘warningCallback’ property instead. Gets or sets warning callback.

setWarningCallback(value: IWarningCallback) : void;

Parameters:

ParameterTypeDescription
valueIWarningCallbackThe value to set.

getWarningCallback()

@deprecated. Please use the ‘warningCallback’ property instead. Gets or sets warning callback.

getWarningCallback() : IWarningCallback;

Returns

IWarningCallback

getMaxRowsOfSharedFormula()

@deprecated. Please use the ‘maxRowsOfSharedFormula’ property instead. Gets and sets the max row number of shared formula.

getMaxRowsOfSharedFormula() : number;

Remarks

If the number is too large, the autofilter works very slow in MS Excel 2013.

setMaxRowsOfSharedFormula(number)

@deprecated. Please use the ‘maxRowsOfSharedFormula’ property instead. Gets and sets the max row number of shared formula.

setMaxRowsOfSharedFormula(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

Remarks

If the number is too large, the autofilter works very slow in MS Excel 2013.

getCompliance()

@deprecated. Please use the ‘compliance’ property instead. Specifies the OOXML version for the output document. The default value is Ecma376_2006.

getCompliance() : OoxmlCompliance;

Returns

OoxmlCompliance

Remarks

Only for .xlsx files.

setCompliance(OoxmlCompliance)

@deprecated. Please use the ‘compliance’ property instead. Specifies the OOXML version for the output document. The default value is Ecma376_2006.

setCompliance(value: OoxmlCompliance) : void;

Parameters:

ParameterTypeDescription
valueOoxmlComplianceThe value to set.

Remarks

Only for .xlsx files.

getQuotePrefixToStyle()

@deprecated. Please use the ‘quotePrefixToStyle’ property instead. Indicates whether setting Style.QuotePrefix property when entering the string value(which starts with single quote mark ) to the cell

getQuotePrefixToStyle() : boolean;

setQuotePrefixToStyle(boolean)

@deprecated. Please use the ‘quotePrefixToStyle’ property instead. Indicates whether setting Style.QuotePrefix property when entering the string value(which starts with single quote mark ) to the cell

setQuotePrefixToStyle(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getFormulaSettings()

@deprecated. Please use the ‘formulaSettings’ property instead. Gets the settings for formula-related features.

getFormulaSettings() : FormulaSettings;

Returns

FormulaSettings

getPropertiesFollowChartPoint()

@deprecated. Please use the ‘propertiesFollowChartPoint’ property instead. Indicates whether datapoint properties and datalabels in all charts in this workbook follow their reference.

getPropertiesFollowChartPoint() : boolean;

setPropertiesFollowChartPoint(boolean)

@deprecated. Please use the ‘propertiesFollowChartPoint’ property instead. Indicates whether datapoint properties and datalabels in all charts in this workbook follow their reference.

setPropertiesFollowChartPoint(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getDiscardImageEditData()

@deprecated. Please use the ‘discardImageEditData’ property instead. Indicates whether discarding editting image data.

getDiscardImageEditData() : boolean;

setDiscardImageEditData(boolean)

@deprecated. Please use the ‘discardImageEditData’ property instead. Indicates whether discarding editting image data.

setDiscardImageEditData(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getDefaultImageResolution()

@deprecated. Please use the ‘defaultImageResolution’ property instead. Gets and sets default resolution of image.

getDefaultImageResolution() : number;

setDefaultImageResolution(number)

@deprecated. Please use the ‘defaultImageResolution’ property instead. Gets and sets default resolution of image.

setDefaultImageResolution(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

dispose()

Releases resources.

dispose() : void;

getThemeFont(FontSchemeType)

Gets the default theme font name.

getThemeFont(type: FontSchemeType) : string;

Parameters:

ParameterTypeDescription
typeFontSchemeTypeThe scheme type of the font.

setPageOrientationType(PageOrientationType)

Set the type of print orientation for the whole workbook.

setPageOrientationType(pageOrientationType: PageOrientationType) : void;

Parameters:

ParameterTypeDescription
pageOrientationTypePageOrientationTypeThe page orientation type

isNull()

Checks whether the implementation object is null.

isNull() : boolean;