asposecells.api

Classes

Constants

Class WorkbookSettings

Represents all settings of the workbook.

Property Getters/Setters Summary
`method`	`getAuthor()`
`method`	`setAuthor(value)`
	Gets and sets the author of the file.
`method`	`getAutoCompressPictures()`
`method`	`setAutoCompressPictures(value)`
	Specifies a boolean value that indicates the application automatically compressed pictures in the workbook.
`method`	`getAutoRecover()`
`method`	`setAutoRecover(value)`
	Indicates whether the file is mark for auto-recovery.
`method`	`getBuildVersion()`
`method`	`setBuildVersion(value)`
	Specifies the incremental public release of the application.
`method`	`getCalcMode()`
`method`	`setCalcMode(value)`
	It specifies whether to calculate formulas manually, automatically or automatically except for multiple table operations. The value of the property is CalcModeType integer constant.
`method`	`getCalcStackSize()`
`method`	`setCalcStackSize(value)`
	Specifies the stack size for calculating cells recursively. The large value for this size will give better performance when there are lots of cells need to be calculated recursively. On the other hand, larger value will raise the risk of StackOverflowException. If user gets StackOverflowException when calculating formulas, this value should be decreased.
`method`	`getCalculationId()`
`method`	`setCalculationId(value)`
	Specifies the version of the calculation engine used to calculate values in the workbook.
`method`	`getCheckCompatibility()`
`method`	`setCheckCompatibility(value)`
	Indicates whether check compatibility with earlier versions when saving workbook.
`method`	`getCheckCustomNumberFormat()`
`method`	`setCheckCustomNumberFormat(value)`
	Indicates whether checking custom number format when setting Style.Custom.
`method`	`getCheckExcelRestriction()`
`method`	`setCheckExcelRestriction(value)`
	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.
`method`	`getCompliance()`
`method`	`setCompliance(value)`
	Specifies the OOXML version for the output document. The default value is Ecma376_2006. The value of the property is OoxmlCompliance integer constant.
`method`	`getCrashSave()`
`method`	`setCrashSave(value)`
	indicates whether the application last saved the workbook file after a crash.
`method`	`getCreateCalcChain()`
`method`	`setCreateCalcChain(value)`
	Whether creates calculated formulas chain. Default is false.
`method`	`getDataExtractLoad()`
`method`	`setDataExtractLoad(value)`
	indicates whether the application last opened the workbook for data recovery.
`method`	`getDate1904()`
`method`	`setDate1904(value)`
	Gets or sets a value which represents if the workbook uses the 1904 date system.
`method`	`getDisplayDrawingObjects()`
`method`	`setDisplayDrawingObjects(value)`
	Indicates whether and how to show objects in the workbook. The value of the property is DisplayDrawingObjects integer constant.
`method`	`getEnableMacros()`
`method`	`setEnableMacros(value)`
	Enable macros;
`method`	`getFirstVisibleTab()`
`method`	`setFirstVisibleTab(value)`
	Gets or sets the first visible worksheet tab.
`method`	`getForceFullCalculate()`
`method`	`setForceFullCalculate(value)`
	Fully calculates every time when a calculation is triggered.
`method`	`getFormulaSettings()`
	Gets the settings for formula-related features.
`method`	`getGlobalizationSettings()`
`method`	`setGlobalizationSettings(value)`
	Gets and sets the globalization settings.
`method`	`getHidePivotFieldList()`
`method`	`setHidePivotFieldList(value)`
	Gets and sets whether hide the field list for the PivotTable.
`method`	`isDefaultEncrypted()`
`method`	`setDefaultEncrypted(value)`
	Indicates whether encrypting the workbook with default password if Structure and Windows of the workbook are locked.
`method`	`isEncrypted()`
	Gets a value that indicates whether a password is required to open this workbook.
`method`	`isHidden()`
`method`	`setHidden(value)`
	Indicates whether this workbook is hidden.
`method`	`isHScrollBarVisible()`
`method`	`setHScrollBarVisible(value)`
	Gets or sets a value indicating whether the generated spreadsheet will contain a horizontal scroll bar.
`method`	`isMinimized()`
`method`	`setMinimized(value)`
	Represents whether the generated spreadsheet will be opened Minimized.
`method`	`isProtected()`
	Gets a value that indicates whether the structure or window of the Workbook is protected.
`method`	`isVScrollBarVisible()`
`method`	`setVScrollBarVisible(value)`
	Gets or sets a value indicating whether the generated spreadsheet will contain a vertical scroll bar.
`method`	`getIteration()`
`method`	`setIteration(value)`
	Indicates whether enable iterative calculation to resolve circular references.
`method`	`getLanguageCode()`
`method`	`setLanguageCode(value)`
	Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file. The value of the property is CountryCode integer constant.
`method`	`getLocale()`
`method`	`setLocale(value)`
	Gets or sets the Locale used by this workbook.
`method`	`getMaxChange()`
`method`	`setMaxChange(value)`
	Returns or sets the maximum number of change to resolve a circular reference.
`method`	`getMaxColumn()`
	Gets the max column index, zero-based.
`method`	`getMaxIteration()`
`method`	`setMaxIteration(value)`
	Returns or sets the maximum number of iterations to resolve a circular reference.
`method`	`getMaxRow()`
	Gets the max row index, zero-based.
`method`	`getMaxRowsOfSharedFormula()`
`method`	`setMaxRowsOfSharedFormula(value)`
	Gets and sets the max row number of shared formula.
`method`	`getMemorySetting()`
`method`	`setMemorySetting(value)`
	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. The value of the property is MemorySetting integer constant.
`method`	`getNumberDecimalSeparator()`
`method`	`setNumberDecimalSeparator(value)`
	Gets or sets the decimal separator for formatting/parsing numeric values. Default is the decimal separator of current Region.
`method`	`getNumberGroupSeparator()`
`method`	`setNumberGroupSeparator(value)`
	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.
`method`	`getPaperSize()`
`method`	`setPaperSize(value)`
	Gets and sets the default print paper size. The value of the property is PaperSizeType integer constant.
`method`	`getParsingFormulaOnOpen()`
`method`	`setParsingFormulaOnOpen(value)`
	Indicates whether parsing the formula when reading the file.
`method`	`getPassword()`
`method`	`setPassword(value)`
	Represents Workbook file encryption password.
`method`	`getPrecisionAsDisplayed()`
`method`	`setPrecisionAsDisplayed(value)`
	True if calculations in this workbook will be done using only the precision of the numbers as they're displayed
`method`	`getProtectionType()`
	Gets the protection type of the workbook. The value of the property is ProtectionType integer constant.
`method`	`getQuotePrefixToStyle()`
`method`	`setQuotePrefixToStyle(value)`
	Indicates whether setting Style.QuotePrefix property when entering the string value(which starts with single quote mark ) to the cell
`method`	`getRecalculateBeforeSave()`
`method`	`setRecalculateBeforeSave(value)`
	Indicates whether to recalculate before saving the document.
`method`	`getReCalculateOnOpen()`
`method`	`setReCalculateOnOpen(value)`
	Indicates whether re-calculate all formulas on opening file.
`method`	`getRegion()`
`method`	`setRegion(value)`
	Gets or sets the regional settings for workbook. The value of the property is CountryCode integer constant.
`method`	`getRemovePersonalInformation()`
`method`	`setRemovePersonalInformation(value)`
	True if personal information can be removed from the specified workbook.
`method`	`getRepairLoad()`
`method`	`setRepairLoad(value)`
	Indicates whether the application last opened the workbook in safe or repair mode.
`method`	`getResourceProvider()`
`method`	`setResourceProvider(value)`
	Gets and sets the stream provider for external resource, such as loading image data for picture of type "LinkToFile".
`method`	`getShared()`
`method`	`setShared(value)`
	Gets or sets a value that indicates whether the Workbook is shared.
`method`	`getSheetTabBarWidth()`
`method`	`setSheetTabBarWidth(value)`
	Width of worksheet tab bar (in 1/1000 of window width).
`method`	`getShowTabs()`
`method`	`setShowTabs(value)`
	Get or sets a value whether the Workbook tabs are displayed.
`method`	`getSignificantDigits()`
`method`	`setSignificantDigits(value)`
	Gets and sets the number of significant digits. The default value is CellsHelper.SignificantDigits.
`method`	`getStreamProvider()`
`method`	`setStreamProvider(value)`
	Gets and sets the stream provider for external resource.
`method`	`getUpdateAdjacentCellsBorder()`
`method`	`setUpdateAdjacentCellsBorder(value)`
	Indicates whether update adjacent cells' border.
`method`	`getUpdateLinksType()`
`method`	`setUpdateLinksType(value)`
	Gets and sets how updates external links when the workbook is opened. The value of the property is UpdateLinksType integer constant.
`method`	`getWindowHeight()`
`method`	`setWindowHeight(value)`
	The height of the window, in unit of point.
`method`	`getWindowHeightCM()`
`method`	`setWindowHeightCM(value)`
	The height of the window, in unit of centimeter.
`method`	`getWindowHeightInch()`
`method`	`setWindowHeightInch(value)`
	The height of the window, in unit of inch.
`method`	`getWindowLeft()`
`method`	`setWindowLeft(value)`
	The distance from the left edge of the client area to the left edge of the window, in unit of point.
`method`	`getWindowLeftCM()`
`method`	`setWindowLeftCM(value)`
	The distance from the left edge of the client area to the left edge of the window. In unit of centimeter.
`method`	`getWindowLeftInch()`
`method`	`setWindowLeftInch(value)`
	The distance from the left edge of the client area to the left edge of the window. In unit of inch.
`method`	`getWindowTop()`
`method`	`setWindowTop(value)`
	The distance from the top edge of the client area to the top edge of the window, in unit of point.
`method`	`getWindowTopCM()`
`method`	`setWindowTopCM(value)`
	The distance from the top edge of the client area to the top edge of the window, in unit of centimeter.
`method`	`getWindowTopInch()`
`method`	`setWindowTopInch(value)`
	The distance from the top edge of the client area to the top edge of the window, in unit of inch.
`method`	`getWindowWidth()`
`method`	`setWindowWidth(value)`
	The width of the window, in unit of point.
`method`	`getWindowWidthCM()`
`method`	`setWindowWidthCM(value)`
	The width of the window, in unit of centimeter.
`method`	`getWindowWidthInch()`
`method`	`setWindowWidthInch(value)`
	The width of the window, in unit of inch.
`method`	`getWriteProtection()`
	Provides access to the workbook write protection options.

Method Summary
`method`	`dispose()`
`method`	Releases resources.
`method`	`getThemeFont(type)`
`method`	Gets the default theme font name.
`method`	`setPageOrientationType(pageOrientationType)`
`method`	Set the type of print orientation for the whole workbook.

- Property Getters/Setters Detail
  - getStreamProvider/setStreamProvider : IStreamProvider
```
IStreamProvider getStreamProvider() / setStreamProvider(value)
```
    Gets and sets the stream provider for external resource.
  - getResourceProvider/setResourceProvider : IStreamProvider
```
IStreamProvider getResourceProvider() / setResourceProvider(value)
```
    Gets and sets the stream provider for external resource, such as loading image data for picture of type "LinkToFile".
  - getAuthor/setAuthor : String
```
String getAuthor() / setAuthor(value)
```
    Gets and sets the author of the file.
    It''s not set, check BuiltInDocumentPropertyCollection.Author first, then check the user of Environment.
  - getCheckCustomNumberFormat/setCheckCustomNumberFormat : boolean
```
boolean getCheckCustomNumberFormat() / setCheckCustomNumberFormat(value)
```
    Indicates whether checking custom number format when setting Style.Custom.
  - getEnableMacros/setEnableMacros : boolean
```
boolean getEnableMacros() / setEnableMacros(value)
```
    Enable macros;
    Now it only works when copying a worksheet to other worksheet in a workbook.
  - getDate1904/setDate1904 : boolean
```
boolean getDate1904() / setDate1904(value)
```
    Gets or sets a value which represents if the workbook uses the 1904 date system.
  - getProtectionType : int
```
int getProtectionType()
```
    Gets the protection type of the workbook. The value of the property is ProtectionType integer constant.
  - getDisplayDrawingObjects/setDisplayDrawingObjects : int
```
int getDisplayDrawingObjects() / setDisplayDrawingObjects(value)
```
    Indicates whether and how to show objects in the workbook. The value of the property is DisplayDrawingObjects integer constant.
  - getSheetTabBarWidth/setSheetTabBarWidth : int
```
int getSheetTabBarWidth() / setSheetTabBarWidth(value)
```
    Width of worksheet tab bar (in 1/1000 of window width).
  - getShowTabs/setShowTabs : boolean
```
boolean getShowTabs() / setShowTabs(value)
```
    Get or sets a value whether the Workbook tabs are displayed.
    The default value is true.
    Example:
    The following code hides the Sheet Tabs and Tab Scrolling Buttons for the spreadsheet.
    // Hide the spreadsheet tabs. workbook = Workbook() workbook.getSettings().setShowTabs(False)
  - getFirstVisibleTab/setFirstVisibleTab : int
```
int getFirstVisibleTab() / setFirstVisibleTab(value)
```
    Gets or sets the first visible worksheet tab.
  - isHScrollBarVisible/setHScrollBarVisible : boolean
```
boolean isHScrollBarVisible() / setHScrollBarVisible(value)
```
    Gets or sets a value indicating whether the generated spreadsheet will contain a horizontal scroll bar.
    The default value is true.
    Example:
    The following code makes the horizontal scroll bar invisible for the spreadsheet.
    // Hide the horizontal scroll bar of the Excel file. workbook = Workbook() workbook.getSettings().setHScrollBarVisible(False)
  - isVScrollBarVisible/setVScrollBarVisible : boolean
```
boolean isVScrollBarVisible() / setVScrollBarVisible(value)
```
    Gets or sets a value indicating whether the generated spreadsheet will contain a vertical scroll bar.
    The default value is true.
    Example:
    The following code makes the vertical scroll bar invisible for the spreadsheet.
    // Hide the vertical scroll bar of the Excel file. workbook = Workbook() workbook.getSettings().setVScrollBarVisible(False)
  - getShared/setShared : boolean
```
boolean getShared() / setShared(value)
```
    Gets or sets a value that indicates whether the Workbook is shared.
    The default value is false.
  - getLanguageCode/setLanguageCode : int
```
int getLanguageCode() / setLanguageCode(value)
```
    Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file. The value of the property is CountryCode integer constant.
  - getRegion/setRegion : int
```
int getRegion() / setRegion(value)
```
    Gets or sets the regional settings for workbook. The value of the property is CountryCode integer constant.
    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.
  - getLocale/setLocale : Locale
```
Locale getLocale() / setLocale(value)
```
    Gets or sets the Locale used by this workbook.
    Returns null if neither Locale nor Region is set.
  - getGlobalizationSettings/setGlobalizationSettings : GlobalizationSettings
```
GlobalizationSettings getGlobalizationSettings() / setGlobalizationSettings(value)
```
    Gets and sets the globalization settings.
  - getNumberDecimalSeparator/setNumberDecimalSeparator : char
```
char getNumberDecimalSeparator() / setNumberDecimalSeparator(value)
```
    Gets or sets the decimal separator for formatting/parsing numeric values. Default is the decimal separator of current Region.
  - getNumberGroupSeparator/setNumberGroupSeparator : char
```
char getNumberGroupSeparator() / setNumberGroupSeparator(value)
```
    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/setPassword : String
```
String getPassword() / setPassword(value)
```
    Represents Workbook file encryption password.
  - getWriteProtection : WriteProtection
```
WriteProtection getWriteProtection()
```
    Provides access to the workbook write protection options.
  - isEncrypted : boolean
```
boolean isEncrypted()
```
    Gets a value that indicates whether a password is required to open this workbook.
  - isProtected : boolean
```
boolean isProtected()
```
    Gets a value that indicates whether the structure or window of the Workbook is protected.
  - isDefaultEncrypted/setDefaultEncrypted : boolean
```
boolean isDefaultEncrypted() / setDefaultEncrypted(value)
```
    Indicates whether encrypting the workbook with default password if Structure and Windows of the workbook are locked.
    The default value is false now. It's same as MS Excel 2013.
  - isMinimized/setMinimized : boolean
```
boolean isMinimized() / setMinimized(value)
```
    Represents whether the generated spreadsheet will be opened Minimized.
  - isHidden/setHidden : boolean
```
boolean isHidden() / setHidden(value)
```
    Indicates whether this workbook is hidden.
  - getAutoCompressPictures/setAutoCompressPictures : boolean
```
boolean getAutoCompressPictures() / setAutoCompressPictures(value)
```
    Specifies a boolean value that indicates the application automatically compressed pictures in the workbook.
  - getRemovePersonalInformation/setRemovePersonalInformation : boolean
```
boolean getRemovePersonalInformation() / setRemovePersonalInformation(value)
```
    True if personal information can be removed from the specified workbook.
  - getHidePivotFieldList/setHidePivotFieldList : boolean
```
boolean getHidePivotFieldList() / setHidePivotFieldList(value)
```
    Gets and sets whether hide the field list for the PivotTable.
  - getUpdateLinksType/setUpdateLinksType : int
```
int getUpdateLinksType() / setUpdateLinksType(value)
```
    Gets and sets how updates external links when the workbook is opened. The value of the property is UpdateLinksType integer constant.
  - getMaxRow : int
```
int getMaxRow()
```
    Gets the max row index, zero-based.
    Returns 65535 if the file format is Excel97-2003;
  - getMaxColumn : int
```
int getMaxColumn()
```
    Gets the max column index, zero-based.
    Returns 255 if the file format is Excel97-2003;
  - getParsingFormulaOnOpen/setParsingFormulaOnOpen : boolean
```
boolean getParsingFormulaOnOpen() / setParsingFormulaOnOpen(value)
```
    Indicates whether parsing the formula when reading the file.
    Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file because the formulas in the files are stored with a string formula. NOTE: This member is now obsolete. Instead, please use LoadOptions.ParsingFormulaOnOpen. This property will be removed 12 months later since January 2020. Aspose apologizes for any inconvenience you may have experienced.
  - getWindowLeft/setWindowLeft : float
```
float getWindowLeft() / setWindowLeft(value)
```
    The distance from the left edge of the client area to the left edge of the window, in unit of point.
  - getWindowLeftInch/setWindowLeftInch : float
```
float getWindowLeftInch() / setWindowLeftInch(value)
```
    The distance from the left edge of the client area to the left edge of the window. In unit of inch.
  - getWindowLeftCM/setWindowLeftCM : float
```
float getWindowLeftCM() / setWindowLeftCM(value)
```
    The distance from the left edge of the client area to the left edge of the window. In unit of centimeter.
  - getWindowTop/setWindowTop : float
```
float getWindowTop() / setWindowTop(value)
```
    The distance from the top edge of the client area to the top edge of the window, in unit of point.
  - getWindowTopInch/setWindowTopInch : float
```
float getWindowTopInch() / setWindowTopInch(value)
```
    The distance from the top edge of the client area to the top edge of the window, in unit of inch.
  - getWindowTopCM/setWindowTopCM : float
```
float getWindowTopCM() / setWindowTopCM(value)
```
    The distance from the top edge of the client area to the top edge of the window, in unit of centimeter.
  - getWindowWidth/setWindowWidth : float
```
float getWindowWidth() / setWindowWidth(value)
```
    The width of the window, in unit of point.
  - getWindowWidthInch/setWindowWidthInch : float
```
float getWindowWidthInch() / setWindowWidthInch(value)
```
    The width of the window, in unit of inch.
  - getWindowWidthCM/setWindowWidthCM : float
```
float getWindowWidthCM() / setWindowWidthCM(value)
```
    The width of the window, in unit of centimeter.
  - getWindowHeight/setWindowHeight : float
```
float getWindowHeight() / setWindowHeight(value)
```
    The height of the window, in unit of point.
  - getWindowHeightInch/setWindowHeightInch : float
```
float getWindowHeightInch() / setWindowHeightInch(value)
```
    The height of the window, in unit of inch.
  - getWindowHeightCM/setWindowHeightCM : float
```
float getWindowHeightCM() / setWindowHeightCM(value)
```
    The height of the window, in unit of centimeter.
  - getUpdateAdjacentCellsBorder/setUpdateAdjacentCellsBorder : boolean
```
boolean getUpdateAdjacentCellsBorder() / setUpdateAdjacentCellsBorder(value)
```
    Indicates whether update adjacent cells' border.
    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/setSignificantDigits : int
```
int getSignificantDigits() / setSignificantDigits(value)
```
    Gets and sets the number of significant digits. The default value is CellsHelper.SignificantDigits.
    Only could be 15 or 17 now.
  - getCheckCompatibility/setCheckCompatibility : boolean
```
boolean getCheckCompatibility() / setCheckCompatibility(value)
```
    Indicates whether check compatibility with earlier versions when saving workbook.
    The default value is true. Only for Excel97-2003 xls or xlt files.
  - getCheckExcelRestriction/setCheckExcelRestriction : boolean
```
boolean getCheckExcelRestriction() / setCheckExcelRestriction(value)
```
    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/setAutoRecover : boolean
```
boolean getAutoRecover() / setAutoRecover(value)
```
    Indicates whether the file is mark for auto-recovery.
  - getCrashSave/setCrashSave : boolean
```
boolean getCrashSave() / setCrashSave(value)
```
    indicates whether the application last saved the workbook file after a crash.
  - getDataExtractLoad/setDataExtractLoad : boolean
```
boolean getDataExtractLoad() / setDataExtractLoad(value)
```
    indicates whether the application last opened the workbook for data recovery.
  - getRepairLoad/setRepairLoad : boolean
```
boolean getRepairLoad() / setRepairLoad(value)
```
    Indicates whether the application last opened the workbook in safe or repair mode.
  - getBuildVersion/setBuildVersion : String
```
String getBuildVersion() / setBuildVersion(value)
```
    Specifies the incremental public release of the application.
  - getMemorySetting/setMemorySetting : int
```
int getMemorySetting() / setMemorySetting(value)
```
    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. The value of the property is MemorySetting integer constant.
  - getPaperSize/setPaperSize : int
```
int getPaperSize() / setPaperSize(value)
```
    Gets and sets the default print paper size. The value of the property is PaperSizeType integer constant.
    If there is no setting about paper size,MS Excel will use default printer's setting.
  - getMaxRowsOfSharedFormula/setMaxRowsOfSharedFormula : int
```
int getMaxRowsOfSharedFormula() / setMaxRowsOfSharedFormula(value)
```
    Gets and sets the max row number of shared formula.
    If the number is too large, the autofilter works very slow in MS Excel 2013.
  - getCompliance/setCompliance : int
```
int getCompliance() / setCompliance(value)
```
    Specifies the OOXML version for the output document. The default value is Ecma376_2006. The value of the property is OoxmlCompliance integer constant.
    Only for .xlsx files.
  - getQuotePrefixToStyle/setQuotePrefixToStyle : boolean
```
boolean getQuotePrefixToStyle() / setQuotePrefixToStyle(value)
```
    Indicates whether setting Style.QuotePrefix property when entering the string value(which starts with single quote mark ) to the cell
  - getFormulaSettings : FormulaSettings
```
FormulaSettings getFormulaSettings()
```
    Gets the settings for formula-related features.
  - getPrecisionAsDisplayed/setPrecisionAsDisplayed : boolean
```
boolean getPrecisionAsDisplayed() / setPrecisionAsDisplayed(value)
```
    True if calculations in this workbook will be done using only the precision of the numbers as they're displayed
    NOTE: This member is now obsolete. Instead, please use FormulaSettings.PrecisionAsDisplayed. This property will be removed 12 months later since February 2022. Aspose apologizes for any inconvenience you may have experienced.
  - getReCalculateOnOpen/setReCalculateOnOpen : boolean
```
boolean getReCalculateOnOpen() / setReCalculateOnOpen(value)
```
    Indicates whether re-calculate all formulas on opening file.
    NOTE: This member is now obsolete. Instead, please use FormulaSettings.CalculateOnOpen. This property will be removed 12 months later since February 2022. Aspose apologizes for any inconvenience you may have experienced.
  - getCreateCalcChain/setCreateCalcChain : boolean
```
boolean getCreateCalcChain() / setCreateCalcChain(value)
```
    Whether creates calculated formulas chain. Default is false.
    NOTE: This member is now obsolete. Instead, please use FormulaSettings.EnableCalculationChain. This property will be removed 12 months later since February 2022. Aspose apologizes for any inconvenience you may have experienced.
  - getForceFullCalculate/setForceFullCalculate : boolean
```
boolean getForceFullCalculate() / setForceFullCalculate(value)
```
    Fully calculates every time when a calculation is triggered.
    NOTE: This member is now obsolete. Instead, please use FormulaSettings.ForceFullCalculation. This property will be removed 12 months later since February 2022. Aspose apologizes for any inconvenience you may have experienced.
  - getIteration/setIteration : boolean
```
boolean getIteration() / setIteration(value)
```
    Indicates whether enable iterative calculation to resolve circular references.
    NOTE: This member is now obsolete. Instead, please use FormulaSettings.EnableIterativeCalculation. This property will be removed 12 months later since February 2022. Aspose apologizes for any inconvenience you may have experienced.
  - getMaxIteration/setMaxIteration : int
```
int getMaxIteration() / setMaxIteration(value)
```
    Returns or sets the maximum number of iterations to resolve a circular reference.
    NOTE: This member is now obsolete. Instead, please use FormulaSettings.MaxIteration. This property will be removed 12 months later since February 2022. Aspose apologizes for any inconvenience you may have experienced.
  - getMaxChange/setMaxChange : float
```
float getMaxChange() / setMaxChange(value)
```
    Returns or sets the maximum number of change to resolve a circular reference.
    NOTE: This member is now obsolete. Instead, please use FormulaSettings.MaxChange. This property will be removed 12 months later since February 2022. Aspose apologizes for any inconvenience you may have experienced.
  - getCalcMode/setCalcMode : int
```
int getCalcMode() / setCalcMode(value)
```
    It specifies whether to calculate formulas manually, automatically or automatically except for multiple table operations. The value of the property is CalcModeType integer constant.
    Only sets for MS Excel. Please manually calling Workbook.CalculateFormula() method to calculate formulas with Aspose.Cells. NOTE: This member is now obsolete. Instead, please use FormulaSettings.CalculationMode. This property will be removed 12 months later since February 2022. Aspose apologizes for any inconvenience you may have experienced.
  - getCalculationId/setCalculationId : String
```
String getCalculationId() / setCalculationId(value)
```
    Specifies the version of the calculation engine used to calculate values in the workbook.
    NOTE: This member is now obsolete. Instead, please use FormulaSettings.CalculationId. This property will be removed 12 months later since February 2022. Aspose apologizes for any inconvenience you may have experienced.
  - getCalcStackSize/setCalcStackSize : int
```
int getCalcStackSize() / setCalcStackSize(value)
```
    Specifies the stack size for calculating cells recursively. The large value for this size will give better performance when there are lots of cells need to be calculated recursively. On the other hand, larger value will raise the risk of StackOverflowException. If user gets StackOverflowException when calculating formulas, this value should be decreased.
    NOTE: This member is now obsolete. Instead, please use CalculationOptions with the specified CalcStackSize when calculating formulas. This property will be removed 12 months later since February 2022. Aspose apologizes for any inconvenience you may have experienced.
  - getRecalculateBeforeSave/setRecalculateBeforeSave : boolean
```
boolean getRecalculateBeforeSave() / setRecalculateBeforeSave(value)
```
    Indicates whether to recalculate before saving the document.
    NOTE: This member is now obsolete. Instead, please use FormulaSettings.CalculateOnSave. This property will be removed 12 months later since February 2022. Aspose apologizes for any inconvenience you may have experienced.
- Method Detail
  - dispose
```
 dispose()
```
    Releases resources.
  - getThemeFont
```
String getThemeFont(type)
```
    Gets the default theme font name.
    Parameters:
    type: int - A FontSchemeType value. The scheme type of the font.
    Returns:
  - setPageOrientationType
```
 setPageOrientationType(pageOrientationType)
```
    Set the type of print orientation for the whole workbook.
    Parameters:
    pageOrientationType: int - A PageOrientationType value. The PageOrientationType

asposecells.api

Classes

Constants

Class WorkbookSettings

Property Getters/Setters Detail

getStreamProvider/setStreamProvider : IStreamProvider

getResourceProvider/setResourceProvider : IStreamProvider

getAuthor/setAuthor : String

getCheckCustomNumberFormat/setCheckCustomNumberFormat : boolean

getEnableMacros/setEnableMacros : boolean

getDate1904/setDate1904 : boolean

getProtectionType : int

getDisplayDrawingObjects/setDisplayDrawingObjects : int

getSheetTabBarWidth/setSheetTabBarWidth : int

getShowTabs/setShowTabs : boolean

getFirstVisibleTab/setFirstVisibleTab : int

isHScrollBarVisible/setHScrollBarVisible : boolean

isVScrollBarVisible/setVScrollBarVisible : boolean

getShared/setShared : boolean

getLanguageCode/setLanguageCode : int

getRegion/setRegion : int

getLocale/setLocale : Locale

getGlobalizationSettings/setGlobalizationSettings : GlobalizationSettings

getNumberDecimalSeparator/setNumberDecimalSeparator : char

getNumberGroupSeparator/setNumberGroupSeparator : char

getPassword/setPassword : String

getWriteProtection : WriteProtection

isEncrypted : boolean

isProtected : boolean

isDefaultEncrypted/setDefaultEncrypted : boolean

isMinimized/setMinimized : boolean

isHidden/setHidden : boolean

getAutoCompressPictures/setAutoCompressPictures : boolean

getRemovePersonalInformation/setRemovePersonalInformation : boolean

getHidePivotFieldList/setHidePivotFieldList : boolean

getUpdateLinksType/setUpdateLinksType : int

getMaxRow : int

getMaxColumn : int

getParsingFormulaOnOpen/setParsingFormulaOnOpen : boolean

getWindowLeft/setWindowLeft : float

getWindowLeftInch/setWindowLeftInch : float

getWindowLeftCM/setWindowLeftCM : float

getWindowTop/setWindowTop : float

getWindowTopInch/setWindowTopInch : float

getWindowTopCM/setWindowTopCM : float

getWindowWidth/setWindowWidth : float

getWindowWidthInch/setWindowWidthInch : float

getWindowWidthCM/setWindowWidthCM : float

getWindowHeight/setWindowHeight : float

getWindowHeightInch/setWindowHeightInch : float

getWindowHeightCM/setWindowHeightCM : float

getUpdateAdjacentCellsBorder/setUpdateAdjacentCellsBorder : boolean

getSignificantDigits/setSignificantDigits : int

getCheckCompatibility/setCheckCompatibility : boolean

getCheckExcelRestriction/setCheckExcelRestriction : boolean

getAutoRecover/setAutoRecover : boolean

getCrashSave/setCrashSave : boolean

getDataExtractLoad/setDataExtractLoad : boolean

getRepairLoad/setRepairLoad : boolean

getBuildVersion/setBuildVersion : String

getMemorySetting/setMemorySetting : int

getPaperSize/setPaperSize : int

getMaxRowsOfSharedFormula/setMaxRowsOfSharedFormula : int

getCompliance/setCompliance : int

getQuotePrefixToStyle/setQuotePrefixToStyle : boolean

getFormulaSettings : FormulaSettings

getPrecisionAsDisplayed/setPrecisionAsDisplayed : boolean

getReCalculateOnOpen/setReCalculateOnOpen : boolean

getCreateCalcChain/setCreateCalcChain : boolean

getForceFullCalculate/setForceFullCalculate : boolean

getIteration/setIteration : boolean

getMaxIteration/setMaxIteration : int

getMaxChange/setMaxChange : float

getCalcMode/setCalcMode : int

getCalculationId/setCalculationId : String

getCalcStackSize/setCalcStackSize : int

getRecalculateBeforeSave/setRecalculateBeforeSave : boolean

Method Detail

dispose

getThemeFont