com.aspose.cells
Class WorkbookSettings

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

public class WorkbookSettings 
extends java.lang.Object

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

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

public int getProtectionType()

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

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

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

Indicates whether re-calculate all formulas on opening file.

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

Indicates whether create calculated formulas chain.

public boolean getReCalcOnOpen() / public void setReCalcOnOpen(boolean value)

Indicates whether re-calculate all formulas on opening file.

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

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

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

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

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

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

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

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.

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.

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 stakes of StackOverflowException. If use gets StackOverflowException when calculating formulas, this value should be decreased.

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

Indicates whether to recalculate before saving the document.

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

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

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:

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

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

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

Gets or sets the first visible worksheet tab.

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:

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 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:

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 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 int getLanguage() / public void setLanguage(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.

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

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

Gets or sets the system regional settings based on CountryCode at the time the file was saved. The value of the property is CountryCode integer constant.

If you do not want to use the region saved in the file, please reset it after reading the file.

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 com.aspose.cells.Encoding getEncoding() / public void setEncoding(com.aspose.cells.Encoding value)

Gets and sets the default encoding.Only applies for csv file.

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

Represents Workbook file encryption password.

public boolean getConvertNumericData() / public void setConvertNumericData(boolean value)

Gets or sets a value that indicates whether the string in text file is converted to numeric data.

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

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

Indicates if the Read Only Recommended option is selected.

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

Indicates whether this workbook is write protected.

public void setWriteProtectedPassword(java.lang.String value)

Sets the proected password to modify the file.

public boolean isProtected()

Gets a value that indicates whether the Workbook is protected.

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

Represents whether the generated spreadsheet will be opened Minimized.

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

Indicates whether this workbook is hidden.

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

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

public boolean getParsingFormulaOnOpen() / public void setParsingFormulaOnOpen(boolean value)

Indicates whether parsing the formula when reading the file.

Only applies for Excel Xlsx,Xltx, Xltm,Xlsm file because the formulas in the files are stored with a string formula.

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 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 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 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 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 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 double getWindowWidth() / public void setWindowWidth(double value)

The width of the window, in unit of point.

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

The width of the window,in unit of inch.

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

The width of the window,in unit of centimeter.

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

The height of the window, in unit of point.

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

The height of the window,in unit of inch.

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

The height of the window,in unit of centimeter.

public boolean getUpdateAdjacentCellsBorder() / public void setUpdateAdjacentCellsBorder(boolean value)

Indicates whether update adjacent cells' border.

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

public boolean getCheckComptiliblity() / public void setCheckComptiliblity(boolean value)

Indicates whether check comptiliblity when saving workbook.

The default value is true.

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 java.lang.String getBuildVersion() / public void setBuildVersion(java.lang.String value)

Specifies the incremental public release of the application.