WorkbookSettings (Aspose.Cells for Java)

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

public class WorkbookSettings
extends java.lang.Object

Represents all settings of the workbook.

Example

 
         Workbook workbook = new Workbook();
 
         WorkbookSettings settings = workbook.getSettings();
 
         //do your business

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`dispose()` Releases resources.
`java.lang.String`	`getAuthor()` Gets the author of the file.
`boolean`	`getAutoCompressPictures()` Specifies a boolean value that indicates the application automatically compressed pictures in the workbook.
`boolean`	`getAutoRecover()` Indicates whether the file is marked for auto-recovery.
`java.lang.String`	`getBuildVersion()` Specifies the incremental public release of the application.
`boolean`	`getCheckCompatibility()` Indicates whether check compatibility with earlier versions when saving workbook.
`boolean`	`getCheckCustomNumberFormat()` Indicates whether checking custom number format when setting Style.Custom.
`boolean`	`getCheckExcelRestriction()` Whether check restriction of excel file when user modify cells related objects.
`int`	`getCompliance()` Specifies the OOXML version for the output document.
`boolean`	`getCrashSave()` indicates whether the application last saved the workbook file after a crash.
`boolean`	`getDataExtractLoad()` indicates whether the application last opened the workbook for data recovery.
`boolean`	`getDate1904()` Gets a value which represents if the workbook uses the 1904 date system.
`int`	`getDefaultImageResolution()` Gets default resolution of image.
`DefaultStyleSettings`	`getDefaultStyleSettings()` Gets the settings for default values of style-related properties for this workbook.
`boolean`	`getDiscardImageEditData()` Indicates whether discarding editting image data.
`int`	`getDisplayDrawingObjects()` Indicates whether and how to show objects in the workbook.
`boolean`	`getEnableMacros()` Enable macros;
`int`	`getFirstVisibleTab()` Gets the first visible worksheet tab.
`FormulaSettings`	`getFormulaSettings()` Gets the settings for formula-related features.
`GlobalizationSettings`	`getGlobalizationSettings()` Gets the globalization settings.
`boolean`	`getHidePivotFieldList()` Gets whether hide the field list for the PivotTable.
`int`	`getLanguageCode()` Gets the user interface language of the Workbook version based on CountryCode that has saved the file.
`java.util.Locale`	`getLocale()` Gets the Locale used by this workbook.
`int`	`getMaxColumn()` Gets the max column index, zero-based.
`int`	`getMaxRow()` Gets the max row index, zero-based.
`int`	`getMaxRowsOfSharedFormula()` Gets the max row number of shared formula.
`int`	`getMaxUniqueItemsPerField()` Gets the limitation of unique items per field
`int`	`getMemorySetting()` Gets the memory usage options.
`char`	`getNumberDecimalSeparator()` Gets the decimal separator for formatting/parsing numeric values.
`char`	`getNumberGroupSeparator()` Gets the character that separates groups of digits to the left of the decimal in numeric values.
`int`	`getPaperSize()` Gets the default print paper size.
`java.lang.String`	`getPassword()` Represents Workbook file encryption password.
`boolean`	`getPropertiesFollowChartPoint()` Indicates whether datapoint properties and datalabels in all charts in this workbook follow their reference.
`int`	`getProtectionType()` Gets the protection type of the workbook.
`boolean`	`getQuotePrefixToStyle()` Indicates whether setting `Style.getQuotePrefix()` property when entering the string value(which starts with single quote mark ) to the cell
`int`	`getRegion()` Gets the regional settings for workbook.
`boolean`	`getRemovePersonalInformation()` True if personal information can be removed from the specified workbook.
`boolean`	`getRepairLoad()` Indicates whether the application last opened the workbook in safe or repair mode.
`IStreamProvider`	`getResourceProvider()` Gets the stream provider for external resource, such as loading image data for picture of type "LinkToFile".
`boolean`	`getShared()` Gets a value that indicates whether the Workbook is shared.
`int`	`getSheetTabBarWidth()` Width of worksheet tab bar (in 1/1000 of window width).
`boolean`	`getShowTabs()` Gets a value whether the Workbook tabs are displayed.
`int`	`getSignificantDigits()` Deprecated. Use SignificantDigitsType property instead.
`int`	`getSignificantDigitsType()` Gets the type of significant digits for outputing numeric values in this workbook.
`SmartTagOptions`	`getSmartTagOptions()` Gets the options of the smart tag.
`IStreamProvider`	`getStreamProvider()` Deprecated. Use ResourceProvider property instead.
`java.lang.String`	`getThemeFont(int type)` Gets the default theme font name.
`boolean`	`getUpdateAdjacentCellsBorder()` Indicates whether update adjacent cells' border.
`int`	`getUpdateLinksType()` Gets how updates external links when the workbook is opened.
`IWarningCallback`	`getWarningCallback()` Gets warning callback.
`double`	`getWindowHeight()` The height of the window, in unit of point.
`double`	`getWindowHeightCM()` The height of the window, in unit of centimeter.
`double`	`getWindowHeightInch()` The height of the window, in unit of inch.
`double`	`getWindowLeft()` The distance from the left edge of the client area to the left edge of the window, in unit of point.
`double`	`getWindowLeftCM()` The distance from the left edge of the client area to the left edge of the window.
`double`	`getWindowLeftInch()` The distance from the left edge of the client area to the left edge of the window.
`double`	`getWindowTop()` The distance from the top edge of the client area to the top edge of the window, in unit of point.
`double`	`getWindowTopCM()` The distance from the top edge of the client area to the top edge of the window, in unit of centimeter.
`double`	`getWindowTopInch()` The distance from the top edge of the client area to the top edge of the window, in unit of inch.
`double`	`getWindowWidth()` The width of the window, in unit of point.
`double`	`getWindowWidthCM()` The width of the window, in unit of centimeter.
`double`	`getWindowWidthInch()` The width of the window, in unit of inch.
`WriteProtection`	`getWriteProtection()` Provides access to the workbook write protection options.
`boolean`	`isDefaultEncrypted()` Indicates whether encrypting the workbook with default password if Structure and Windows of the workbook are locked.
`boolean`	`isEncrypted()` Gets a value that indicates whether a password is required to open this workbook.
`boolean`	`isHidden()` Indicates whether this workbook is hidden.
`boolean`	`isHScrollBarVisible()` Gets a value indicating whether the generated spreadsheet will contain a horizontal scroll bar.
`boolean`	`isMinimized()` Represents whether the generated spreadsheet will be opened Minimized.
`boolean`	`isProtected()` Gets a value that indicates whether the structure or window of the Workbook is protected.
`boolean`	`isVScrollBarVisible()` Gets a value indicating whether the generated spreadsheet will contain a vertical scroll bar.
`void`	`setAuthor(java.lang.String value)` Sets the author of the file.
`void`	`setAutoCompressPictures(boolean value)` Specifies a boolean value that indicates the application automatically compressed pictures in the workbook.
`void`	`setAutoRecover(boolean value)` Indicates whether the file is marked for auto-recovery.
`void`	`setBuildVersion(java.lang.String value)` Specifies the incremental public release of the application.
`void`	`setCheckCompatibility(boolean value)` Indicates whether check compatibility with earlier versions when saving workbook.
`void`	`setCheckCustomNumberFormat(boolean value)` Indicates whether checking custom number format when setting Style.Custom.
`void`	`setCheckExcelRestriction(boolean value)` Whether check restriction of excel file when user modify cells related objects.
`void`	`setCompliance(int value)` Specifies the OOXML version for the output document.
`void`	`setCrashSave(boolean value)` indicates whether the application last saved the workbook file after a crash.
`void`	`setDataExtractLoad(boolean value)` indicates whether the application last opened the workbook for data recovery.
`void`	`setDate1904(boolean value)` Sets a value which represents if the workbook uses the 1904 date system.
`void`	`setDefaultEncrypted(boolean value)` Indicates whether encrypting the workbook with default password if Structure and Windows of the workbook are locked.
`void`	`setDefaultImageResolution(int value)` Sets default resolution of image.
`void`	`setDiscardImageEditData(boolean value)` Indicates whether discarding editting image data.
`void`	`setDisplayDrawingObjects(int value)` Indicates whether and how to show objects in the workbook.
`void`	`setEnableMacros(boolean value)` Enable macros;
`void`	`setFirstVisibleTab(int value)` Sets the first visible worksheet tab.
`void`	`setGlobalizationSettings(GlobalizationSettings value)` Sets the globalization settings.
`void`	`setHidden(boolean value)` Indicates whether this workbook is hidden.
`void`	`setHidePivotFieldList(boolean value)` Sets whether hide the field list for the PivotTable.
`void`	`setHScrollBarVisible(boolean value)` Sets a value indicating whether the generated spreadsheet will contain a horizontal scroll bar.
`void`	`setLanguageCode(int value)` Sets the user interface language of the Workbook version based on CountryCode that has saved the file.
`void`	`setLocale(java.util.Locale value)` Sets the Locale used by this workbook.
`void`	`setMaxRowsOfSharedFormula(int value)` Sets the max row number of shared formula.
`void`	`setMaxUniqueItemsPerField(int value)` Sets the limitation of unique items per field
`void`	`setMemorySetting(int value)` Sets the memory usage options.
`void`	`setMinimized(boolean value)` Represents whether the generated spreadsheet will be opened Minimized.
`void`	`setNumberDecimalSeparator(char value)` Sets the decimal separator for formatting/parsing numeric values.
`void`	`setNumberGroupSeparator(char value)` Sets the character that separates groups of digits to the left of the decimal in numeric values.
`void`	`setPageOrientationType(int pageOrientationType)` Set the type of print orientation for the whole workbook.
`void`	`setPaperSize(int value)` Sets the default print paper size.
`void`	`setPassword(java.lang.String value)` Represents Workbook file encryption password.
`void`	`setPropertiesFollowChartPoint(boolean value)` Indicates whether datapoint properties and datalabels in all charts in this workbook follow their reference.
`void`	`setQuotePrefixToStyle(boolean value)` Indicates whether setting `Style.getQuotePrefix()` property when entering the string value(which starts with single quote mark ) to the cell
`void`	`setRegion(int value)` Sets the regional settings for workbook.
`void`	`setRemovePersonalInformation(boolean value)` True if personal information can be removed from the specified workbook.
`void`	`setRepairLoad(boolean value)` Indicates whether the application last opened the workbook in safe or repair mode.
`void`	`setResourceProvider(IStreamProvider value)` Sets the stream provider for external resource, such as loading image data for picture of type "LinkToFile".
`void`	`setShared(boolean value)` Sets a value that indicates whether the Workbook is shared.
`void`	`setSheetTabBarWidth(int value)` Width of worksheet tab bar (in 1/1000 of window width).
`void`	`setShowTabs(boolean value)` Sets a value whether the Workbook tabs are displayed.
`void`	`setSignificantDigits(int value)` Deprecated. Use SignificantDigitsType property instead.
`void`	`setSignificantDigitsType(int value)` Sets the type of significant digits for outputing numeric values in this workbook.
`void`	`setStreamProvider(IStreamProvider value)` Deprecated. Use ResourceProvider property instead.
`void`	`setUpdateAdjacentCellsBorder(boolean value)` Indicates whether update adjacent cells' border.
`void`	`setUpdateLinksType(int value)` Sets how updates external links when the workbook is opened.
`void`	`setVScrollBarVisible(boolean value)` Sets a value indicating whether the generated spreadsheet will contain a vertical scroll bar.
`void`	`setWarningCallback(IWarningCallback value)` Sets warning callback.
`void`	`setWindowHeight(double value)` The height of the window, in unit of point.
`void`	`setWindowHeightCM(double value)` The height of the window, in unit of centimeter.
`void`	`setWindowHeightInch(double value)` The height of the window, in unit of inch.
`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.
`void`	`setWindowLeftCM(double value)` The distance from the left edge of the client area to the left edge of the window.
`void`	`setWindowLeftInch(double value)` The distance from the left edge of the client area to the left edge of the window.
`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.
`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.
`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.
`void`	`setWindowWidth(double value)` The width of the window, in unit of point.
`void`	`setWindowWidthCM(double value)` The width of the window, in unit of centimeter.
`void`	`setWindowWidthInch(double value)` The width of the window, in unit of inch.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - dispose
```
public void dispose()
```
    Releases resources.
  - getThemeFont
```
public java.lang.String getThemeFont(int type)
```
    Gets the default theme font name.
    
    Parameters:
    type - FontSchemeType. The scheme type of the font.
    
    Returns:
  - getStreamProvider
```
public IStreamProvider getStreamProvider()
```
    Deprecated. Use ResourceProvider property instead.
    
    Gets the stream provider for external resource.
    Remarks
    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.
  - setStreamProvider
```
public void setStreamProvider(IStreamProvider value)
```
    Deprecated. Use ResourceProvider property instead.
    
    Sets the stream provider for external resource.
    Remarks
    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.
  - getResourceProvider
```
public IStreamProvider getResourceProvider()
```
    Gets the stream provider for external resource, such as loading image data for picture of type "LinkToFile".
  - setResourceProvider
```
public void setResourceProvider(IStreamProvider value)
```
    Sets the stream provider for external resource, such as loading image data for picture of type "LinkToFile".
  - getAuthor
```
public java.lang.String getAuthor()
```
    Gets the author of the file.
    Remarks
    It''s not set, check BuiltInDocumentPropertyCollection.getAuthor() first, then check the user of Environment.
  - setAuthor
```
public void setAuthor(java.lang.String value)
```
    Sets the author of the file.
    Remarks
    It''s not set, check BuiltInDocumentPropertyCollection.getAuthor() first, then check the user of Environment.
  - getCheckCustomNumberFormat
```
public boolean getCheckCustomNumberFormat()
```
    Indicates whether checking custom number format when setting Style.Custom.
  - setCheckCustomNumberFormat
```
public void setCheckCustomNumberFormat(boolean value)
```
    Indicates whether checking custom number format when setting Style.Custom.
  - getEnableMacros
```
public boolean getEnableMacros()
```
    Enable macros;
    Remarks
    Now it only works when copying a worksheet to other worksheet in a workbook.
  - setEnableMacros
```
public void setEnableMacros(boolean value)
```
    Enable macros;
    Remarks
    Now it only works when copying a worksheet to other worksheet in a workbook.
  - getDate1904
```
public boolean getDate1904()
```
    Gets a value which represents if the workbook uses the 1904 date system.
  - setDate1904
```
public void setDate1904(boolean value)
```
    Sets a value which represents if the workbook uses the 1904 date system.
  - getProtectionType
```
public int getProtectionType()
```
    Gets the protection type of the workbook.
    See ProtectionType.
  - getDisplayDrawingObjects
```
public int getDisplayDrawingObjects()
```
    Indicates whether and how to show objects in the workbook.
    See DisplayDrawingObjects.
  - setDisplayDrawingObjects
```
public void setDisplayDrawingObjects(int value)
```
    Indicates whether and how to show objects in the workbook.
    See DisplayDrawingObjects.
  - getSheetTabBarWidth
```
public int getSheetTabBarWidth()
```
    Width of worksheet tab bar (in 1/1000 of window width).
  - setSheetTabBarWidth
```
public void setSheetTabBarWidth(int value)
```
    Width of worksheet tab bar (in 1/1000 of window width).
  - getShowTabs
```
public boolean getShowTabs()
```
    Gets a value whether the Workbook tabs are displayed.
    Remarks
    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);
 
```
  - setShowTabs
```
public void setShowTabs(boolean value)
```
    Sets a value whether the Workbook tabs are displayed.
    Remarks
    The default value is true.
  - getFirstVisibleTab
```
public int getFirstVisibleTab()
```
    Gets the first visible worksheet tab.
  - setFirstVisibleTab
```
public void setFirstVisibleTab(int value)
```
    Sets the first visible worksheet tab.
  - isHScrollBarVisible
```
public boolean isHScrollBarVisible()
```
    Gets a value indicating whether the generated spreadsheet will contain a horizontal scroll bar.
    Remarks
    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.
         settings.setHScrollBarVisible(false);
 
```
  - setHScrollBarVisible
```
public void setHScrollBarVisible(boolean value)
```
    Sets a value indicating whether the generated spreadsheet will contain a horizontal scroll bar.
    Remarks
    The default value is true.
  - isVScrollBarVisible
```
public boolean isVScrollBarVisible()
```
    Gets a value indicating whether the generated spreadsheet will contain a vertical scroll bar.
    Remarks
    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.
         settings.setVScrollBarVisible(false);
 
```
  - setVScrollBarVisible
```
public void setVScrollBarVisible(boolean value)
```
    Sets a value indicating whether the generated spreadsheet will contain a vertical scroll bar.
    Remarks
    The default value is true.
  - getShared
```
public boolean getShared()
```
    Gets a value that indicates whether the Workbook is shared.
    Remarks
    The default value is false.
  - setShared
```
public void setShared(boolean value)
```
    Sets a value that indicates whether the Workbook is shared.
    Remarks
    The default value is false.
  - getLanguageCode
```
public int getLanguageCode()
```
    Gets the user interface language of the Workbook version based on CountryCode that has saved the file.
    See CountryCode.
  - setLanguageCode
```
public void setLanguageCode(int value)
```
    Sets the user interface language of the Workbook version based on CountryCode that has saved the file.
    See CountryCode.
  - getRegion
```
public int getRegion()
```
    Gets the regional settings for workbook.
    See 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
```
public void setRegion(int value)
```
    Sets the regional settings for workbook.
    See 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.
  - getLocale
```
public java.util.Locale getLocale()
```
    Gets the Locale used by this workbook.
    Remarks
    Returns null if neither Locale nor getRegion() is set.
  - setLocale
```
public void setLocale(java.util.Locale value)
```
    Sets the Locale used by this workbook.
    Remarks
    Returns null if neither Locale nor getRegion() is set.
  - getGlobalizationSettings
```
public GlobalizationSettings getGlobalizationSettings()
```
    Gets the globalization settings.
  - setGlobalizationSettings
```
public void setGlobalizationSettings(GlobalizationSettings value)
```
    Sets the globalization settings.
  - getNumberDecimalSeparator
```
public char getNumberDecimalSeparator()
```
    Gets the decimal separator for formatting/parsing numeric values. Default is the decimal separator of current Region.
  - setNumberDecimalSeparator
```
public void setNumberDecimalSeparator(char value)
```
    Sets the decimal separator for formatting/parsing numeric values. Default is the decimal separator of current Region.
  - getNumberGroupSeparator
```
public char getNumberGroupSeparator()
```
    Gets 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
```
public void setNumberGroupSeparator(char value)
```
    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
```
public java.lang.String getPassword()
```
    Represents Workbook file encryption password.
  - setPassword
```
public void setPassword(java.lang.String value)
```
    Represents Workbook file encryption password.
  - getWriteProtection
```
public WriteProtection getWriteProtection()
```
    Provides access to the workbook write protection options.
  - isEncrypted
```
public boolean isEncrypted()
```
    Gets a value that indicates whether a password is required to open this workbook.
  - isProtected
```
public boolean isProtected()
```
    Gets a value that indicates whether the structure or window of the Workbook is protected.
  - isDefaultEncrypted
```
public boolean isDefaultEncrypted()
```
    Indicates whether encrypting the workbook with default password if Structure and Windows of the workbook are locked.
    Remarks
    The default value is false now. It's same as MS Excel 2013.
  - setDefaultEncrypted
```
public void setDefaultEncrypted(boolean value)
```
    Indicates whether encrypting the workbook with default password if Structure and Windows of the workbook are locked.
    Remarks
    The default value is false now. It's same as MS Excel 2013.
  - isMinimized
```
public boolean isMinimized()
```
    Represents whether the generated spreadsheet will be opened Minimized.
  - setMinimized
```
public void setMinimized(boolean value)
```
    Represents whether the generated spreadsheet will be opened Minimized.
  - isHidden
```
public boolean isHidden()
```
    Indicates whether this workbook is hidden.
  - setHidden
```
public void setHidden(boolean value)
```
    Indicates whether this workbook is hidden.
  - getAutoCompressPictures
```
public boolean getAutoCompressPictures()
```
    Specifies a boolean value that indicates the application automatically compressed pictures in the workbook.
  - setAutoCompressPictures
```
public void setAutoCompressPictures(boolean value)
```
    Specifies a boolean value that indicates the application automatically compressed pictures in the workbook.
  - getRemovePersonalInformation
```
public boolean getRemovePersonalInformation()
```
    True if personal information can be removed from the specified workbook.
    Remarks
  - setRemovePersonalInformation
```
public void setRemovePersonalInformation(boolean value)
```
    True if personal information can be removed from the specified workbook.
    Remarks
  - getHidePivotFieldList
```
public boolean getHidePivotFieldList()
```
    Gets whether hide the field list for the PivotTable.
  - setHidePivotFieldList
```
public void setHidePivotFieldList(boolean value)
```
    Sets whether hide the field list for the PivotTable.
  - getMaxUniqueItemsPerField
```
public int getMaxUniqueItemsPerField()
```
    Gets the limitation of unique items per field
    Remarks
  - setMaxUniqueItemsPerField
```
public void setMaxUniqueItemsPerField(int value)
```
    Sets the limitation of unique items per field
    Remarks
  - getUpdateLinksType
```
public int getUpdateLinksType()
```
    Gets how updates external links when the workbook is opened.
    See UpdateLinksType.
  - setUpdateLinksType
```
public void setUpdateLinksType(int value)
```
    Sets how updates external links when the workbook is opened.
    See UpdateLinksType.
  - setPageOrientationType
```
public void setPageOrientationType(int pageOrientationType)
```
    Set the type of print orientation for the whole workbook.
    
    Parameters:
    pageOrientationType - PageOrientationType. The page orientation type
  - getMaxRow
```
public int getMaxRow()
```
    Gets the max row index, zero-based.
    Remarks
    Returns 65535 if the file format is Excel97-2003;
  - getMaxColumn
```
public int getMaxColumn()
```
    Gets the max column index, zero-based.
    Remarks
    Returns 255 if the file format is Excel97-2003;
  - getSmartTagOptions
```
public SmartTagOptions getSmartTagOptions()
```
    Gets the options of the smart tag.
  - getDefaultStyleSettings
```
public DefaultStyleSettings getDefaultStyleSettings()
```
    Gets the settings for default values of style-related properties for this workbook.
  - getWindowLeft
```
public double getWindowLeft()
```
    The distance from the left edge of the client area to the left edge of the window, in unit of point.
  - setWindowLeft
```
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.
  - getWindowLeftInch
```
public double getWindowLeftInch()
```
    The distance from the left edge of the client area to the left edge of the window. In unit of inch.
  - setWindowLeftInch
```
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.
  - getWindowLeftCM
```
public double getWindowLeftCM()
```
    The distance from the left edge of the client area to the left edge of the window. In unit of centimeter.
  - setWindowLeftCM
```
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.
  - getWindowTop
```
public double getWindowTop()
```
    The distance from the top edge of the client area to the top edge of the window, in unit of point.
  - setWindowTop
```
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.
  - getWindowTopInch
```
public double getWindowTopInch()
```
    The distance from the top edge of the client area to the top edge of the window, in unit of inch.
  - setWindowTopInch
```
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.
  - getWindowTopCM
```
public double getWindowTopCM()
```
    The distance from the top edge of the client area to the top edge of the window, in unit of centimeter.
  - setWindowTopCM
```
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.
  - getWindowWidth
```
public double getWindowWidth()
```
    The width of the window, in unit of point.
  - setWindowWidth
```
public void setWindowWidth(double value)
```
    The width of the window, in unit of point.
  - getWindowWidthInch
```
public double getWindowWidthInch()
```
    The width of the window, in unit of inch.
  - setWindowWidthInch
```
public void setWindowWidthInch(double value)
```
    The width of the window, in unit of inch.
  - getWindowWidthCM
```
public double getWindowWidthCM()
```
    The width of the window, in unit of centimeter.
  - setWindowWidthCM
```
public void setWindowWidthCM(double value)
```
    The width of the window, in unit of centimeter.
  - getWindowHeight
```
public double getWindowHeight()
```
    The height of the window, in unit of point.
  - setWindowHeight
```
public void setWindowHeight(double value)
```
    The height of the window, in unit of point.
  - getWindowHeightInch
```
public double getWindowHeightInch()
```
    The height of the window, in unit of inch.
  - setWindowHeightInch
```
public void setWindowHeightInch(double value)
```
    The height of the window, in unit of inch.
  - getWindowHeightCM
```
public double getWindowHeightCM()
```
    The height of the window, in unit of centimeter.
  - setWindowHeightCM
```
public void setWindowHeightCM(double value)
```
    The height of the window, in unit of centimeter.
  - getUpdateAdjacentCellsBorder
```
public boolean getUpdateAdjacentCellsBorder()
```
    Indicates whether update adjacent cells' border.
    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
```
public void setUpdateAdjacentCellsBorder(boolean value)
```
    Indicates whether update adjacent cells' border.
    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
```
public int getSignificantDigits()
```
    Deprecated. Use SignificantDigitsType property instead.
    
    Gets the number of significant digits. The default value is CellsHelper.getSignificantDigits().
    Remarks
    Only could be 15 or 17 now. NOTE: This member is now obsolete. Instead, please use getSignificantDigitsType(). This property will be removed 12 months later since June 2025. Aspose apologizes for any inconvenience you may have experienced.
  - setSignificantDigits
```
public void setSignificantDigits(int value)
```
    Deprecated. Use SignificantDigitsType property instead.
    
    Sets the number of significant digits. The default value is CellsHelper.getSignificantDigits().
    Remarks
    Only could be 15 or 17 now. NOTE: This member is now obsolete. Instead, please use getSignificantDigitsType(). This property will be removed 12 months later since June 2025. Aspose apologizes for any inconvenience you may have experienced.
  - getSignificantDigitsType
```
public int getSignificantDigitsType()
```
    Gets the type of significant digits for outputing numeric values in this workbook. Default value is CellsHelper.getSignificantDigitsType().
    See getSignificantDigitsType().
  - setSignificantDigitsType
```
public void setSignificantDigitsType(int value)
```
    Sets the type of significant digits for outputing numeric values in this workbook. Default value is CellsHelper.getSignificantDigitsType().
    See getSignificantDigitsType().
  - getCheckCompatibility
```
public boolean getCheckCompatibility()
```
    Indicates whether check compatibility with earlier versions when saving workbook.
    Remarks
    The default value is true. Only for Excel97-2003 xls or xlt files.
  - setCheckCompatibility
```
public void setCheckCompatibility(boolean value)
```
    Indicates whether check compatibility with earlier versions when saving workbook.
    Remarks
    The default value is true. Only for Excel97-2003 xls or xlt files.
  - getCheckExcelRestriction
```
public boolean getCheckExcelRestriction()
```
    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
```
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.
  - getAutoRecover
```
public boolean getAutoRecover()
```
    Indicates whether the file is marked for auto-recovery.
  - setAutoRecover
```
public void setAutoRecover(boolean value)
```
    Indicates whether the file is marked for auto-recovery.
  - getCrashSave
```
public boolean getCrashSave()
```
    indicates whether the application last saved the workbook file after a crash.
  - setCrashSave
```
public void setCrashSave(boolean value)
```
    indicates whether the application last saved the workbook file after a crash.
  - getDataExtractLoad
```
public boolean getDataExtractLoad()
```
    indicates whether the application last opened the workbook for data recovery.
  - setDataExtractLoad
```
public void setDataExtractLoad(boolean value)
```
    indicates whether the application last opened the workbook for data recovery.
  - getRepairLoad
```
public boolean getRepairLoad()
```
    Indicates whether the application last opened the workbook in safe or repair mode.
  - setRepairLoad
```
public void setRepairLoad(boolean value)
```
    Indicates whether the application last opened the workbook in safe or repair mode.
  - getBuildVersion
```
public java.lang.String getBuildVersion()
```
    Specifies the incremental public release of the application.
  - setBuildVersion
```
public void setBuildVersion(java.lang.String value)
```
    Specifies the incremental public release of the application.
  - getMemorySetting
```
public int getMemorySetting()
```
    Gets 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.
    See MemorySetting.
    
    Remarks
    For more details about memory mode, please see Cells.getMemorySetting().
  - setMemorySetting
```
public void setMemorySetting(int value)
```
    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.
    See MemorySetting.
    
    Remarks
    For more details about memory mode, please see Cells.getMemorySetting().
  - getPaperSize
```
public int getPaperSize()
```
    Gets the default print paper size.
    See PaperSizeType.
    
    Remarks
    If there is no setting about paper size,MS Excel will use default printer's setting.
  - setPaperSize
```
public void setPaperSize(int value)
```
    Sets the default print paper size.
    See PaperSizeType.
    
    Remarks
    If there is no setting about paper size,MS Excel will use default printer's setting.
  - getWarningCallback
```
public IWarningCallback getWarningCallback()
```
    Gets warning callback.
  - setWarningCallback
```
public void setWarningCallback(IWarningCallback value)
```
    Sets warning callback.
  - getMaxRowsOfSharedFormula
```
public int getMaxRowsOfSharedFormula()
```
    Gets the max row number of shared formula.
    Remarks
    If the number is too large, the autofilter works very slow in MS Excel 2013.
  - setMaxRowsOfSharedFormula
```
public void setMaxRowsOfSharedFormula(int value)
```
    Sets the max row number of shared formula.
    Remarks
    If the number is too large, the autofilter works very slow in MS Excel 2013.
  - getCompliance
```
public int getCompliance()
```
    Specifies the OOXML version for the output document. The default value is Ecma376_2006.
    See OoxmlCompliance.
    
    Remarks
    Only for .xlsx files.
  - setCompliance
```
public void setCompliance(int value)
```
    Specifies the OOXML version for the output document. The default value is Ecma376_2006.
    See OoxmlCompliance.
    
    Remarks
    Only for .xlsx files.
  - getQuotePrefixToStyle
```
public boolean getQuotePrefixToStyle()
```
    Indicates whether setting Style.getQuotePrefix() property when entering the string value(which starts with single quote mark ) to the cell
  - setQuotePrefixToStyle
```
public void setQuotePrefixToStyle(boolean value)
```
    Indicates whether setting Style.getQuotePrefix() property when entering the string value(which starts with single quote mark ) to the cell
  - getFormulaSettings
```
public FormulaSettings getFormulaSettings()
```
    Gets the settings for formula-related features.
  - getPropertiesFollowChartPoint
```
public boolean getPropertiesFollowChartPoint()
```
    Indicates whether datapoint properties and datalabels in all charts in this workbook follow their reference.
  - setPropertiesFollowChartPoint
```
public void setPropertiesFollowChartPoint(boolean value)
```
    Indicates whether datapoint properties and datalabels in all charts in this workbook follow their reference.
  - getDiscardImageEditData
```
public boolean getDiscardImageEditData()
```
    Indicates whether discarding editting image data.
  - setDiscardImageEditData
```
public void setDiscardImageEditData(boolean value)
```
    Indicates whether discarding editting image data.
  - getDefaultImageResolution
```
public int getDefaultImageResolution()
```
    Gets default resolution of image.
  - setDefaultImageResolution
```
public void setDefaultImageResolution(int value)
```
    Sets default resolution of image.

Class WorkbookSettings

Method Summary

Methods inherited from class java.lang.Object

Method Detail

dispose

getThemeFont

getStreamProvider

setStreamProvider

getResourceProvider

setResourceProvider

getAuthor

setAuthor

getCheckCustomNumberFormat

setCheckCustomNumberFormat

getEnableMacros

setEnableMacros

getDate1904

setDate1904

getProtectionType

getDisplayDrawingObjects

setDisplayDrawingObjects

getSheetTabBarWidth

setSheetTabBarWidth

getShowTabs

setShowTabs

getFirstVisibleTab

setFirstVisibleTab

isHScrollBarVisible

setHScrollBarVisible

isVScrollBarVisible

setVScrollBarVisible

getShared

setShared

getLanguageCode

setLanguageCode

getRegion

setRegion

getLocale

setLocale

getGlobalizationSettings

setGlobalizationSettings

getNumberDecimalSeparator

setNumberDecimalSeparator

getNumberGroupSeparator

setNumberGroupSeparator

getPassword

setPassword

getWriteProtection

isEncrypted

isProtected

isDefaultEncrypted

setDefaultEncrypted

isMinimized

setMinimized

isHidden

setHidden

getAutoCompressPictures

setAutoCompressPictures

getRemovePersonalInformation

setRemovePersonalInformation

getHidePivotFieldList

setHidePivotFieldList

getMaxUniqueItemsPerField

setMaxUniqueItemsPerField

getUpdateLinksType

setUpdateLinksType

setPageOrientationType

getMaxRow

getMaxColumn

getSmartTagOptions

getDefaultStyleSettings

getWindowLeft

setWindowLeft

getWindowLeftInch

setWindowLeftInch

getWindowLeftCM

setWindowLeftCM

getWindowTop

setWindowTop

getWindowTopInch