com.aspose.cells
Class WorkbookSettings

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

public abstract class WorkbookSettings 
extends java.lang.Object

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

Enable macros;

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

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

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

public abstract int getProtectionType()

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

public abstract boolean getPrecisionAsDisplayed() / public abstract void setPrecisionAsDisplayed(boolean value)

True if calculations in this workbook will be done using only the precision of the numbers as they're displayed

public abstract boolean getReCalculateOnOpen() / public abstract void setReCalculateOnOpen(boolean value)

Indicates whether re-calculate all formulas on opening file.

public abstract boolean getCreateCalcChain() / public abstract void setCreateCalcChain(boolean value)

Indicates whether create calculated formulas chain.

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

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

public abstract boolean getIteration() / public abstract void setIteration(boolean value)

Indicates if Aspose.Cells will use iteration to resolve circular references.

public abstract int getMaxIteration() / public abstract void setMaxIteration(int value)

Returns or sets the maximum number of iterations that Aspose.Cells can use to resolve a circular reference.

public abstract double getMaxChange() / public abstract void setMaxChange(double value)

Returns or sets the maximum number of change that Microsoft Excel can use to resolve a circular reference.

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

public abstract java.lang.String getCalculationId() / public abstract void setCalculationId(java.lang.String value)

Specifies the version of the calculation engine used to calculate values in the workbook.

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

public abstract boolean getRecalculateBeforeSave() / public abstract void setRecalculateBeforeSave(boolean value)

Indicates whether to recalculate before saving the document.

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

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

public abstract boolean getShowTabs() / public abstract void setShowTabs(boolean 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.getSettings().setShowTabs(false);

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

Gets or sets the first visible worksheet tab.

public abstract boolean isHScrollBarVisible() / public abstract 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:

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

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

public abstract boolean isVScrollBarVisible() / public abstract 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:

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

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

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

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

The default value is false.

public abstract int getLanguageCode() / public abstract 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 abstract int getRegion() / public abstract 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 abstract java.util.Locale getLocale() / public abstract 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 abstract GlobalizationSettings getGlobalizationSettings() / public abstract void setGlobalizationSettings(GlobalizationSettings value)

Gets and sets the globalization settings.

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

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

public abstract char getNumberGroupSeparator() / public abstract 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 abstract java.lang.String getPassword() / public abstract void setPassword(java.lang.String value)

Represents Workbook file encryption password.

public abstract WriteProtection getWriteProtection()

Provides access to the workbook write protection options.

public abstract boolean getRecommendReadOnly() / public abstract void setRecommendReadOnly(boolean value)

Indicates if the Read Only Recommended option is selected.

NOTE: This member is now obsolete. Instead, please use WorkbookSettings.WriteProtection.RecommendReadOnly property. This property will be removed 12 months later since October 2015. Aspose apologizes for any inconvenience you may have experienced.

public abstract boolean isWriteProtected() / public abstract void setWriteProtected(boolean value)

Indicates whether this workbook is write protected.

NOTE: This member is now obsolete. Instead, please use WorkbookSettings.WriteProtection.IsWriteProtected property. This property will be removed 12 months later since October 2015. Aspose apologizes for any inconvenience you may have experienced.

public abstract void setWriteProtectedPassword(java.lang.String value)

Sets the protected password to modify the file.

NOTE: This member is now obsolete. Instead, please use WorkbookSettings.WriteProtection.Password property. This property will be removed 12 months later since October 2015. Aspose apologizes for any inconvenience you may have experienced.

public abstract boolean isEncrypted()

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

public abstract boolean isProtected()

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

public abstract boolean isDefaultEncrypted() / public abstract 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 abstract boolean isMinimized() / public abstract void setMinimized(boolean value)

Represents whether the generated spreadsheet will be opened Minimized.

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

Indicates whether this workbook is hidden.

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

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

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

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

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

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

public abstract int getUpdateLinksType() / public abstract 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 abstract boolean getParsingFormulaOnOpen() / public abstract 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.

public abstract double getWindowLeft() / public abstract 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 abstract double getWindowLeftInch() / public abstract 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 abstract double getWindowLeftCM() / public abstract 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 abstract double getWindowTop() / public abstract 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 abstract double getWindowTopInch() / public abstract 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 abstract double getWindowTopCM() / public abstract 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 abstract double getWindowWidth() / public abstract void setWindowWidth(double value)

The width of the window, in unit of point.

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

The width of the window, in unit of inch.

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

The width of the window, in unit of centimeter.

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

The height of the window, in unit of point.

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

The height of the window, in unit of inch.

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

The height of the window, in unit of centimeter.

public abstract boolean getUpdateAdjacentCellsBorder() / public abstract 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 abstract boolean getCheckComptiliblity() / public abstract void setCheckComptiliblity(boolean value)

Indicates whether check compatiliblity when saving workbook.

The default value is true. NOTE: This member is now obsolete. Instead, please use CheckCompatibility. This property will be removed 12 months later since November 2016. Aspose apologizes for any inconvenience you may have experienced.

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

Indicates whether check compatiliblity when saving workbook.

The default value is true.

public abstract boolean getCheckExcelRestriction() / public abstract 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 abstract boolean getAutoRecover() / public abstract void setAutoRecover(boolean value)

Indicates whether the file is mark for auto-recovery.

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

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

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

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

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

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

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

Specifies the incremental public release of the application.

public abstract int getMemorySetting() / public abstract 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 abstract int getPaperSize() / public abstract 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.