com.aspose.cells
Class WorkbookSettings

java.lang.Object
    com.aspose.cells.WorkbookSettings

public class WorkbookSettings 
extends java.lang.Object

Workbook workbook = new Workbook();

WorkbookSettings settings = workbook.getSettings();

//do your business

public IStreamProvider getStreamProvider() / public void setStreamProvider(IStreamProvider value)

Gets and sets the stream provider for external resource.

NOTE: This member is now obsolete. Instead, please use ResourceProvider property. This property will be removed 12 months later since June 2022. Aspose apologizes for any inconvenience you may have experienced.

public void setStreamProvider(IStreamProvider value)

public IStreamProvider getResourceProvider() / public void setResourceProvider(IStreamProvider value)

Gets and sets the stream provider for external resource, such as loading image data for picture of type "LinkToFile".

public void setResourceProvider(IStreamProvider value)

public java.lang.String getAuthor() / public void setAuthor(java.lang.String value)

Gets and sets the author of the file.

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

public void setAuthor(java.lang.String value)

public boolean getCheckCustomNumberFormat() / public void setCheckCustomNumberFormat(boolean value)

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

public void setCheckCustomNumberFormat(boolean value)

public boolean getEnableMacros() / public void setEnableMacros(boolean value)

Enable macros;

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

public void setEnableMacros(boolean value)

public boolean getDate1904() / public void setDate1904(boolean value)

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

public void setDate1904(boolean value)

public int getProtectionType()

Gets the protection type of the workbook. The value of the property is ProtectionType integer constant.

public int getDisplayDrawingObjects() / public void setDisplayDrawingObjects(int value)

Indicates whether and how to show objects in the workbook. The value of the property is DisplayDrawingObjects integer constant.

public void setDisplayDrawingObjects(int value)

public int getSheetTabBarWidth() / public void setSheetTabBarWidth(int value)

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

public void setSheetTabBarWidth(int value)

public boolean getShowTabs() / public void setShowTabs(boolean value)

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

The default value is true.

Example:

// Hide the spreadsheet tabs.
workbook.getSettings().setShowTabs(false);

public void setShowTabs(boolean value)

public int getFirstVisibleTab() / public void setFirstVisibleTab(int value)

Gets or sets the first visible worksheet tab.

public void setFirstVisibleTab(int value)

public boolean isHScrollBarVisible() / public void setHScrollBarVisible(boolean value)

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

The default value is true.

Example:

// Hide the horizontal scroll bar of the Excel file.
settings.setHScrollBarVisible(false);

public void setHScrollBarVisible(boolean value)

public boolean isVScrollBarVisible() / public void setVScrollBarVisible(boolean value)

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

The default value is true.

Example:

// Hide the vertical scroll bar of the Excel file.
settings.setVScrollBarVisible(false);

public void setVScrollBarVisible(boolean value)

public boolean getShared() / public void setShared(boolean value)

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

The default value is false.

public void setShared(boolean value)

public int getLanguageCode() / public void setLanguageCode(int 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.

public void setLanguageCode(int value)

public int getRegion() / public void setRegion(int 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.

public void setRegion(int value)

public java.util.Locale getLocale() / public void setLocale(java.util.Locale value)

Gets or sets the Locale used by this workbook.

Returns null if neither Locale nor Region is set.

public void setLocale(java.util.Locale value)

public GlobalizationSettings getGlobalizationSettings() / public void setGlobalizationSettings(GlobalizationSettings value)

Gets and sets the globalization settings.

public void setGlobalizationSettings(GlobalizationSettings value)

public char getNumberDecimalSeparator() / public void setNumberDecimalSeparator(char value)

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

public void setNumberDecimalSeparator(char value)

public char getNumberGroupSeparator() / public void setNumberGroupSeparator(char 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.

public void setNumberGroupSeparator(char value)

public java.lang.String getPassword() / public void setPassword(java.lang.String value)

Represents Workbook file encryption password.

public void setPassword(java.lang.String value)

public WriteProtection getWriteProtection()

Provides access to the workbook write protection options.

public boolean isEncrypted()

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

public boolean isProtected()

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

public boolean isDefaultEncrypted() / public void setDefaultEncrypted(boolean 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.

public void setDefaultEncrypted(boolean value)

public boolean isMinimized() / public void setMinimized(boolean value)

Represents whether the generated spreadsheet will be opened Minimized.

public void setMinimized(boolean value)

public boolean isHidden() / public void setHidden(boolean value)

Indicates whether this workbook is hidden.

public void setHidden(boolean value)

public boolean getAutoCompressPictures() / public void setAutoCompressPictures(boolean value)

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

public void setAutoCompressPictures(boolean value)

public boolean getRemovePersonalInformation() / public void setRemovePersonalInformation(boolean value)

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

public void setRemovePersonalInformation(boolean value)

public boolean getHidePivotFieldList() / public void setHidePivotFieldList(boolean value)

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

public void setHidePivotFieldList(boolean value)

public int getUpdateLinksType() / public void setUpdateLinksType(int value)

Gets and sets how updates external links when the workbook is opened. The value of the property is UpdateLinksType integer constant.

public void setUpdateLinksType(int value)

public int getMaxRow()

Gets the max row index, zero-based.

Returns 65535 if the file format is Excel97-2003;

public int getMaxColumn()

Gets the max column index, zero-based.

Returns 255 if the file format is Excel97-2003;

public boolean getParsingFormulaOnOpen() / public void setParsingFormulaOnOpen(boolean 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.

public void setParsingFormulaOnOpen(boolean value)

public double getWindowLeft() / public void setWindowLeft(double value)

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

public void setWindowLeft(double value)

public double getWindowLeftInch() / public void setWindowLeftInch(double value)

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

public void setWindowLeftInch(double value)

public double getWindowLeftCM() / public void setWindowLeftCM(double value)

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

public void setWindowLeftCM(double value)

public double getWindowTop() / public void setWindowTop(double value)

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

public void setWindowTop(double value)

public double getWindowTopInch() / public void setWindowTopInch(double value)

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

public void setWindowTopInch(double value)

public double getWindowTopCM() / public void setWindowTopCM(double value)

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

public void setWindowTopCM(double value)

public double getWindowWidth() / public void setWindowWidth(double value)

The width of the window, in unit of point.

public void setWindowWidth(double value)

public double getWindowWidthInch() / public void setWindowWidthInch(double value)

The width of the window, in unit of inch.

public void setWindowWidthInch(double value)

public double getWindowWidthCM() / public void setWindowWidthCM(double value)

The width of the window, in unit of centimeter.

public void setWindowWidthCM(double value)

public double getWindowHeight() / public void setWindowHeight(double value)

The height of the window, in unit of point.

public void setWindowHeight(double value)

public double getWindowHeightInch() / public void setWindowHeightInch(double value)

The height of the window, in unit of inch.

public void setWindowHeightInch(double value)

public double getWindowHeightCM() / public void setWindowHeightCM(double value)

The height of the window, in unit of centimeter.

public void setWindowHeightCM(double value)

public boolean getUpdateAdjacentCellsBorder() / public void setUpdateAdjacentCellsBorder(boolean 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.

public void setUpdateAdjacentCellsBorder(boolean value)

public int getSignificantDigits() / public void setSignificantDigits(int value)

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

Only could be 15 or 17 now.

public void setSignificantDigits(int value)

public boolean getCheckCompatibility() / public void setCheckCompatibility(boolean value)

Indicates whether check compatibility with earlier versions when saving workbook.

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

public void setCheckCompatibility(boolean value)

public boolean getCheckExcelRestriction() / public void setCheckExcelRestriction(boolean 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.

public void setCheckExcelRestriction(boolean value)

public boolean getAutoRecover() / public void setAutoRecover(boolean value)

Indicates whether the file is mark for auto-recovery.

public void setAutoRecover(boolean value)

public boolean getCrashSave() / public void setCrashSave(boolean value)

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

public void setCrashSave(boolean value)

public boolean getDataExtractLoad() / public void setDataExtractLoad(boolean value)

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

public void setDataExtractLoad(boolean value)

public boolean getRepairLoad() / public void setRepairLoad(boolean value)

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

public void setRepairLoad(boolean value)

public java.lang.String getBuildVersion() / public void setBuildVersion(java.lang.String value)

Specifies the incremental public release of the application.

public void setBuildVersion(java.lang.String value)

public int getMemorySetting() / public void setMemorySetting(int 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.

public void setMemorySetting(int value)

public int getPaperSize() / public void setPaperSize(int 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.

public void setPaperSize(int value)

public IWarningCallback getWarningCallback() / public void setWarningCallback(IWarningCallback value)

Gets or sets warning callback.

public void setWarningCallback(IWarningCallback value)

public int getMaxRowsOfSharedFormula() / public void setMaxRowsOfSharedFormula(int 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.

public void setMaxRowsOfSharedFormula(int value)

public int getCompliance() / public void setCompliance(int 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.

public void setCompliance(int value)

public boolean getQuotePrefixToStyle() / public void setQuotePrefixToStyle(boolean value)

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

public void setQuotePrefixToStyle(boolean value)

public FormulaSettings getFormulaSettings()

Gets the settings for formula-related features.

public boolean getPrecisionAsDisplayed() / public void setPrecisionAsDisplayed(boolean 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.

public void setPrecisionAsDisplayed(boolean value)

public boolean getReCalculateOnOpen() / public void setReCalculateOnOpen(boolean 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.

public void setReCalculateOnOpen(boolean value)

public boolean getCreateCalcChain() / public void setCreateCalcChain(boolean 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.

public void setCreateCalcChain(boolean value)

public boolean getForceFullCalculate() / public void setForceFullCalculate(boolean 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.

public void setForceFullCalculate(boolean value)

public boolean getIteration() / public void setIteration(boolean 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.

public void setIteration(boolean value)

public int getMaxIteration() / public void setMaxIteration(int 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.

public void setMaxIteration(int value)

public double getMaxChange() / public void setMaxChange(double 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.

public void setMaxChange(double value)

public int getCalcMode() / public void setCalcMode(int 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.

public void setCalcMode(int value)

public java.lang.String getCalculationId() / public void setCalculationId(java.lang.String 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.

public void setCalculationId(java.lang.String value)

public int getCalcStackSize() / public void setCalcStackSize(int 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.

public void setCalcStackSize(int value)

public boolean getRecalculateBeforeSave() / public void setRecalculateBeforeSave(boolean 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.

public void setRecalculateBeforeSave(boolean value)

public void dispose()

Releases resources.

public java.lang.String getThemeFont(int type)

Gets the default theme font name.

Parameters:

type - A FontSchemeType value. The scheme type of the font.

Returns:

public void setPageOrientationType(int pageOrientationType)

Set the type of print orientation for the whole workbook.

Parameters:

pageOrientationType - A PageOrientationType value. The PageOrientationType