Property Getters/Setters Summary | ||
---|---|---|
method | getAuthor() | |
method | setAuthor(value) | |
Gets and sets the author of the file. | ||
method | getAutoCompressPictures() | |
method | setAutoCompressPictures(value) | |
Specifies a boolean value that indicates the application automatically compressed pictures in the workbook. | ||
method | getAutoRecover() | |
method | setAutoRecover(value) | |
Indicates whether the file is marked for auto-recovery. | ||
method | getBuildVersion() | |
method | setBuildVersion(value) | |
Specifies the incremental public release of the application. | ||
method | getCheckCompatibility() | |
method | setCheckCompatibility(value) | |
Indicates whether check compatibility with earlier versions when saving workbook. | ||
method | getCheckCustomNumberFormat() | |
method | setCheckCustomNumberFormat(value) | |
Indicates whether checking custom number format when setting Style.Custom. | ||
method | getCheckExcelRestriction() | |
method | setCheckExcelRestriction(value) | |
Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K such as by Cell.PutValue(string), if this property is true, you will get an Exception. If this property is false, we will accept your input string value as the cell's value so that later you can output the complete string value for other file formats such as CSV. However, if you have set such kind of value that is invalid for excel file format, you should not save the workbook as excel file format later. Otherwise there may be unexpected error for the generated excel file. | ||
method | getCompliance() | |
method | setCompliance(value) | |
Specifies the OOXML version for the output document. The default value is Ecma376_2006. The value of the property is OoxmlCompliance integer constant. | ||
method | getCrashSave() | |
method | setCrashSave(value) | |
indicates whether the application last saved the workbook file after a crash. | ||
method | getDataExtractLoad() | |
method | setDataExtractLoad(value) | |
indicates whether the application last opened the workbook for data recovery. | ||
method | getDate1904() | |
method | setDate1904(value) | |
Gets or sets a value which represents if the workbook uses the 1904 date system. | ||
method | getDefaultStyleSettings() | |
Gets the settings for default values of style-related properties for this workbook.
|
||
method | getDisplayDrawingObjects() | |
method | setDisplayDrawingObjects(value) | |
Indicates whether and how to show objects in the workbook. The value of the property is DisplayDrawingObjects integer constant. | ||
method | getEnableMacros() | |
method | setEnableMacros(value) | |
Enable macros; | ||
method | getFirstVisibleTab() | |
method | setFirstVisibleTab(value) | |
Gets or sets the first visible worksheet tab. | ||
method | getFormulaSettings() | |
Gets the settings for formula-related features.
|
||
method | getGlobalizationSettings() | |
method | setGlobalizationSettings(value) | |
Gets and sets the globalization settings. | ||
method | getHidePivotFieldList() | |
method | setHidePivotFieldList(value) | |
Gets and sets whether hide the field list for the PivotTable. | ||
method | isDefaultEncrypted() | |
method | setDefaultEncrypted(value) | |
Indicates whether encrypting the workbook with default password if Structure and Windows of the workbook are locked. | ||
method | isEncrypted() | |
Gets a value that indicates whether a password is required to open this workbook.
|
||
method | isHidden() | |
method | setHidden(value) | |
Indicates whether this workbook is hidden. | ||
method | isHScrollBarVisible() | |
method | setHScrollBarVisible(value) | |
Gets or sets a value indicating whether the generated spreadsheet will contain a horizontal scroll bar. | ||
method | isMinimized() | |
method | setMinimized(value) | |
Represents whether the generated spreadsheet will be opened Minimized. | ||
method | isProtected() | |
Gets a value that indicates whether the structure or window of the Workbook is protected.
|
||
method | isVScrollBarVisible() | |
method | setVScrollBarVisible(value) | |
Gets or sets a value indicating whether the generated spreadsheet will contain a vertical scroll bar. | ||
method | getLanguageCode() | |
method | setLanguageCode(value) | |
Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file. The value of the property is CountryCode integer constant. | ||
method | getLocale() | |
method | setLocale(value) | |
Gets or sets the Locale used by this workbook. | ||
method | getMaxColumn() | |
Gets the max column index, zero-based.
|
||
method | getMaxRow() | |
Gets the max row index, zero-based.
|
||
method | getMaxRowsOfSharedFormula() | |
method | setMaxRowsOfSharedFormula(value) | |
Gets and sets the max row number of shared formula. | ||
method | getMemorySetting() | |
method | setMemorySetting(value) | |
Gets or sets the memory usage options. The new option will be taken as the default option for newly created worksheets but does not take effect for existing worksheets. The value of the property is MemorySetting integer constant. | ||
method | getNumberDecimalSeparator() | |
method | setNumberDecimalSeparator(value) | |
Gets or sets the decimal separator for formatting/parsing numeric values. Default is the decimal separator of current Region. | ||
method | getNumberGroupSeparator() | |
method | setNumberGroupSeparator(value) | |
Gets or sets the character that separates groups of digits to the left of the decimal in numeric values. Default is the group separator of current Region. | ||
method | getPaperSize() | |
method | setPaperSize(value) | |
Gets and sets the default print paper size. The value of the property is PaperSizeType integer constant. | ||
method | getPassword() | |
method | setPassword(value) | |
Represents Workbook file encryption password. | ||
method | getProtectionType() | |
Gets the protection type of the workbook.
The value of the property is ProtectionType integer constant. |
||
method | getQuotePrefixToStyle() | |
method | setQuotePrefixToStyle(value) | |
Indicates whether setting |
||
method | getRegion() | |
method | setRegion(value) | |
Gets or sets the regional settings for workbook. The value of the property is CountryCode integer constant. | ||
method | getRemovePersonalInformation() | |
method | setRemovePersonalInformation(value) | |
True if personal information can be removed from the specified workbook. | ||
method | getRepairLoad() | |
method | setRepairLoad(value) | |
Indicates whether the application last opened the workbook in safe or repair mode. | ||
method | getResourceProvider() | |
method | setResourceProvider(value) | |
Gets and sets the stream provider for external resource, such as loading image data for picture of type "LinkToFile". | ||
method | getShared() | |
method | setShared(value) | |
Gets or sets a value that indicates whether the Workbook is shared. | ||
method | getSheetTabBarWidth() | |
method | setSheetTabBarWidth(value) | |
Width of worksheet tab bar (in 1/1000 of window width). | ||
method | getShowTabs() | |
method | setShowTabs(value) | |
Get or sets a value whether the Workbook tabs are displayed. | ||
method | getSignificantDigits() | |
method | setSignificantDigits(value) | |
Gets and sets the number of significant digits.
The default value is |
||
method | getStreamProvider() | |
method | setStreamProvider(value) | |
Gets and sets the stream provider for external resource. | ||
method | getUpdateAdjacentCellsBorder() | |
method | setUpdateAdjacentCellsBorder(value) | |
Indicates whether update adjacent cells' border. | ||
method | getUpdateLinksType() | |
method | setUpdateLinksType(value) | |
Gets and sets how updates external links when the workbook is opened. The value of the property is UpdateLinksType integer constant. | ||
method | getWindowHeight() | |
method | setWindowHeight(value) | |
The height of the window, in unit of point. | ||
method | getWindowHeightCM() | |
method | setWindowHeightCM(value) | |
The height of the window, in unit of centimeter. | ||
method | getWindowHeightInch() | |
method | setWindowHeightInch(value) | |
The height of the window, in unit of inch. | ||
method | getWindowLeft() | |
method | setWindowLeft(value) | |
The distance from the left edge of the client area to the left edge of the window, in unit of point. | ||
method | getWindowLeftCM() | |
method | setWindowLeftCM(value) | |
The distance from the left edge of the client area to the left edge of the window. In unit of centimeter. | ||
method | getWindowLeftInch() | |
method | setWindowLeftInch(value) | |
The distance from the left edge of the client area to the left edge of the window. In unit of inch. | ||
method | getWindowTop() | |
method | setWindowTop(value) | |
The distance from the top edge of the client area to the top edge of the window, in unit of point. | ||
method | getWindowTopCM() | |
method | setWindowTopCM(value) | |
The distance from the top edge of the client area to the top edge of the window, in unit of centimeter. | ||
method | getWindowTopInch() | |
method | setWindowTopInch(value) | |
The distance from the top edge of the client area to the top edge of the window, in unit of inch. | ||
method | getWindowWidth() | |
method | setWindowWidth(value) | |
The width of the window, in unit of point. | ||
method | getWindowWidthCM() | |
method | setWindowWidthCM(value) | |
The width of the window, in unit of centimeter. | ||
method | getWindowWidthInch() | |
method | setWindowWidthInch(value) | |
The width of the window, in unit of inch. | ||
method | getWriteProtection() | |
Provides access to the workbook write protection options.
|
Method Summary | ||
---|---|---|
method | dispose() | |
Releases resources.
|
||
method | getThemeFont(type) | |
Gets the default theme font name.
|
||
method | setPageOrientationType(pageOrientationType) | |
Set the type of print orientation for the whole workbook.
|
IStreamProvider getStreamProvider() / setStreamProvider(value)
IStreamProvider getResourceProvider() / setResourceProvider(value)
String getAuthor() / setAuthor(value)
boolean getCheckCustomNumberFormat() / setCheckCustomNumberFormat(value)
boolean getEnableMacros() / setEnableMacros(value)
boolean getDate1904() / setDate1904(value)
int getProtectionType()
int getDisplayDrawingObjects() / setDisplayDrawingObjects(value)
int getSheetTabBarWidth() / setSheetTabBarWidth(value)
boolean getShowTabs() / setShowTabs(value)
Example:
The following code hides the Sheet Tabs and Tab Scrolling Buttons for the spreadsheet.// Hide the spreadsheet tabs. workbook = Workbook() workbook.getSettings().setShowTabs(False)
int getFirstVisibleTab() / setFirstVisibleTab(value)
boolean isHScrollBarVisible() / setHScrollBarVisible(value)
Example:
The following code makes the horizontal scroll bar invisible for the spreadsheet.// Hide the horizontal scroll bar of the Excel file. workbook = Workbook() workbook.getSettings().setHScrollBarVisible(False)
boolean isVScrollBarVisible() / setVScrollBarVisible(value)
Example:
The following code makes the vertical scroll bar invisible for the spreadsheet.// Hide the vertical scroll bar of the Excel file. workbook = Workbook() workbook.getSettings().setVScrollBarVisible(False)
boolean getShared() / setShared(value)
int getLanguageCode() / setLanguageCode(value)
int getRegion() / setRegion(value)
Locale getLocale() / setLocale(value)
GlobalizationSettings getGlobalizationSettings() / setGlobalizationSettings(value)
char getNumberDecimalSeparator() / setNumberDecimalSeparator(value)
char getNumberGroupSeparator() / setNumberGroupSeparator(value)
String getPassword() / setPassword(value)
WriteProtection getWriteProtection()
boolean isEncrypted()
boolean isProtected()
boolean isDefaultEncrypted() / setDefaultEncrypted(value)
boolean isMinimized() / setMinimized(value)
boolean isHidden() / setHidden(value)
boolean getAutoCompressPictures() / setAutoCompressPictures(value)
boolean getRemovePersonalInformation() / setRemovePersonalInformation(value)
boolean getHidePivotFieldList() / setHidePivotFieldList(value)
int getUpdateLinksType() / setUpdateLinksType(value)
int getMaxRow()
int getMaxColumn()
DefaultStyleSettings getDefaultStyleSettings()
float getWindowLeft() / setWindowLeft(value)
float getWindowLeftInch() / setWindowLeftInch(value)
float getWindowLeftCM() / setWindowLeftCM(value)
float getWindowTop() / setWindowTop(value)
float getWindowTopInch() / setWindowTopInch(value)
float getWindowTopCM() / setWindowTopCM(value)
float getWindowWidth() / setWindowWidth(value)
float getWindowWidthInch() / setWindowWidthInch(value)
float getWindowWidthCM() / setWindowWidthCM(value)
float getWindowHeight() / setWindowHeight(value)
float getWindowHeightInch() / setWindowHeightInch(value)
float getWindowHeightCM() / setWindowHeightCM(value)
boolean getUpdateAdjacentCellsBorder() / setUpdateAdjacentCellsBorder(value)
int getSignificantDigits() / setSignificantDigits(value)
boolean getCheckCompatibility() / setCheckCompatibility(value)
boolean getCheckExcelRestriction() / setCheckExcelRestriction(value)
boolean getAutoRecover() / setAutoRecover(value)
boolean getCrashSave() / setCrashSave(value)
boolean getDataExtractLoad() / setDataExtractLoad(value)
boolean getRepairLoad() / setRepairLoad(value)
String getBuildVersion() / setBuildVersion(value)
int getMemorySetting() / setMemorySetting(value)
int getPaperSize() / setPaperSize(value)
int getMaxRowsOfSharedFormula() / setMaxRowsOfSharedFormula(value)
int getCompliance() / setCompliance(value)
boolean getQuotePrefixToStyle() / setQuotePrefixToStyle(value)
FormulaSettings getFormulaSettings()
dispose()
String getThemeFont(type)
type: int
- A setPageOrientationType(pageOrientationType)
pageOrientationType: int
- A