WorkbookSettings Class

WorkbookSettings class

Represents all settings of the workbook.

type WorkbookSettings struct  {
	ptr unsafe.Pointer
}

Constructors

Method	Description

Methods

Method	Description
IsNull	Checks whether the implementation object is nullptr.
Dispose	Releases resources.
GetThemeFont	Gets the default theme font name.
GetAuthor	Gets and sets the author of the file.
SetAuthor	Gets and sets the author of the file.
GetCheckCustomNumberFormat	Indicates whether checking custom number format when setting Style.Custom.
SetCheckCustomNumberFormat	Indicates whether checking custom number format when setting Style.Custom.
GetEnableMacros	Enable macros;
SetEnableMacros	Enable macros;
GetDate1904	Gets or sets a value which represents if the workbook uses the 1904 date system.
SetDate1904	Gets or sets a value which represents if the workbook uses the 1904 date system.
GetProtectionType	Gets the protection type of the workbook.
GetDisplayDrawingObjects	Indicates whether and how to show objects in the workbook.
SetDisplayDrawingObjects	Indicates whether and how to show objects in the workbook.
GetSheetTabBarWidth	Width of worksheet tab bar (in 1/1000 of window width).
SetSheetTabBarWidth	Width of worksheet tab bar (in 1/1000 of window width).
GetShowTabs	Get or sets a value whether the Workbook tabs are displayed.
SetShowTabs	Get or sets a value whether the Workbook tabs are displayed.
GetFirstVisibleTab	Gets or sets the first visible worksheet tab.
SetFirstVisibleTab	Gets or sets the first visible worksheet tab.
IsHScrollBarVisible	Gets or sets a value indicating whether the generated spreadsheet will contain a horizontal scroll bar.
SetIsHScrollBarVisible	Gets or sets a value indicating whether the generated spreadsheet will contain a horizontal scroll bar.
IsVScrollBarVisible	Gets or sets a value indicating whether the generated spreadsheet will contain a vertical scroll bar.
SetIsVScrollBarVisible	Gets or sets a value indicating whether the generated spreadsheet will contain a vertical scroll bar.
GetShared	Gets or sets a value that indicates whether the Workbook is shared.
SetShared	Gets or sets a value that indicates whether the Workbook is shared.
GetLanguageCode	Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
SetLanguageCode	Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
GetRegion	Gets or sets the regional settings for workbook.
SetRegion	Gets or sets the regional settings for workbook.
GetGlobalizationSettings	Gets and sets the globalization settings.
SetGlobalizationSettings	Gets and sets the globalization settings.
GetNumberDecimalSeparator	Gets or sets the decimal separator for formatting/parsing numeric values. Default is the decimal separator of current Region.
SetNumberDecimalSeparator	Gets or sets the decimal separator for formatting/parsing numeric values. Default is the decimal separator of current Region.
GetNumberGroupSeparator	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.
SetNumberGroupSeparator	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.
GetPassword	Represents Workbook file encryption password.
SetPassword	Represents Workbook file encryption password.
GetWriteProtection	Provides access to the workbook write protection options.
IsEncrypted	Gets a value that indicates whether a password is required to open this workbook.
IsProtected	Gets a value that indicates whether the structure or window of the Workbook is protected.
IsDefaultEncrypted	Indicates whether encrypting the workbook with default password if Structure and Windows of the workbook are locked.
SetIsDefaultEncrypted	Indicates whether encrypting the workbook with default password if Structure and Windows of the workbook are locked.
IsMinimized	Represents whether the generated spreadsheet will be opened Minimized.
SetIsMinimized	Represents whether the generated spreadsheet will be opened Minimized.
IsHidden	Indicates whether this workbook is hidden.
SetIsHidden	Indicates whether this workbook is hidden.
GetAutoCompressPictures	Specifies a boolean value that indicates the application automatically compressed pictures in the workbook.
SetAutoCompressPictures	Specifies a boolean value that indicates the application automatically compressed pictures in the workbook.
GetRemovePersonalInformation	True if personal information can be removed from the specified workbook.
SetRemovePersonalInformation	True if personal information can be removed from the specified workbook.
GetHidePivotFieldList	Gets and sets whether hide the field list for the PivotTable.
SetHidePivotFieldList	Gets and sets whether hide the field list for the PivotTable.
GetUpdateLinksType	Gets and sets how updates external links when the workbook is opened.
SetUpdateLinksType	Gets and sets how updates external links when the workbook is opened.
SetPageOrientationType	Set the type of print orientation for the whole workbook.
GetMaxRow	Gets the max row index, zero-based.
GetMaxColumn	Gets the max column index, zero-based.
GetDefaultStyleSettings	Gets the settings for default values of style-related properties for this workbook.
GetWindowLeft	The distance from the left edge of the client area to the left edge of the window, in unit of point.
SetWindowLeft	The distance from the left edge of the client area to the left edge of the window, in unit of point.
GetWindowLeftInch	The distance from the left edge of the client area to the left edge of the window.In unit of inch.
SetWindowLeftInch	The distance from the left edge of the client area to the left edge of the window.In unit of inch.
GetWindowLeftCM	The distance from the left edge of the client area to the left edge of the window.In unit of centimeter.
SetWindowLeftCM	The distance from the left edge of the client area to the left edge of the window.In unit of centimeter.
GetWindowTop	The distance from the top edge of the client area to the top edge of the window, in unit of point.
SetWindowTop	The distance from the top edge of the client area to the top edge of the window, in unit of point.
GetWindowTopInch	The distance from the top edge of the client area to the top edge of the window, in unit of inch.
SetWindowTopInch	The distance from the top edge of the client area to the top edge of the window, in unit of inch.
GetWindowTopCM	The distance from the top edge of the client area to the top edge of the window, in unit of centimeter.
SetWindowTopCM	The distance from the top edge of the client area to the top edge of the window, in unit of centimeter.
GetWindowWidth	The width of the window, in unit of point.
SetWindowWidth	The width of the window, in unit of point.
GetWindowWidthInch	The width of the window, in unit of inch.
SetWindowWidthInch	The width of the window, in unit of inch.
GetWindowWidthCM	The width of the window, in unit of centimeter.
SetWindowWidthCM	The width of the window, in unit of centimeter.
GetWindowHeight	The height of the window, in unit of point.
SetWindowHeight	The height of the window, in unit of point.
GetWindowHeightInch	The height of the window, in unit of inch.
SetWindowHeightInch	The height of the window, in unit of inch.
GetWindowHeightCM	The height of the window, in unit of centimeter.
SetWindowHeightCM	The height of the window, in unit of centimeter.
GetUpdateAdjacentCellsBorder	Indicates whether update adjacent cells’ border.
SetUpdateAdjacentCellsBorder	Indicates whether update adjacent cells’ border.
GetSignificantDigits	Gets and sets the number of significant digits.The default value is .
SetSignificantDigits	Gets and sets the number of significant digits.The default value is .
GetCheckCompatibility	Indicates whether check compatibility with earlier versions when saving workbook.
SetCheckCompatibility	Indicates whether check compatibility with earlier versions when saving workbook.
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 lateryou 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	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 lateryou 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	Indicates whether the file is marked for auto-recovery.
SetAutoRecover	Indicates whether the file is marked for auto-recovery.
GetCrashSave	indicates whether the application last saved the workbook file after a crash.
SetCrashSave	indicates whether the application last saved the workbook file after a crash.
GetDataExtractLoad	indicates whether the application last opened the workbook for data recovery.
SetDataExtractLoad	indicates whether the application last opened the workbook for data recovery.
GetRepairLoad	Indicates whether the application last opened the workbook in safe or repair mode.
SetRepairLoad	Indicates whether the application last opened the workbook in safe or repair mode.
GetBuildVersion	Specifies the incremental public release of the application.
SetBuildVersion	Specifies the incremental public release of the application.
GetMemorySetting	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.
SetMemorySetting	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.
GetPaperSize	Gets and sets the default print paper size.
SetPaperSize	Gets and sets the default print paper size.
GetMaxRowsOfSharedFormula	Gets and sets the max row number of shared formula.
SetMaxRowsOfSharedFormula	Gets and sets the max row number of shared formula.
GetCompliance	Specifies the OOXML version for the output document. The default value is Ecma376_2006.
SetCompliance	Specifies the OOXML version for the output document. The default value is Ecma376_2006.
GetQuotePrefixToStyle	Indicates whether setting property when entering the string value(which starts with single quote mark ) to the cell
SetQuotePrefixToStyle	Indicates whether setting property when entering the string value(which starts with single quote mark ) to the cell
GetFormulaSettings	Gets the settings for formula-related features.
GetPropertiesFollowChartPoint	Indicates whether datapoint properties and datalabels in all charts in this workbook follow their reference.
SetPropertiesFollowChartPoint	Indicates whether datapoint properties and datalabels in all charts in this workbook follow their reference.
GetDiscardImageEditData	Indicates whether discarding editting image data.
SetDiscardImageEditData	Indicates whether discarding editting image data.
GetDefaultImageResolution	Gets and sets default resolution of image.
SetDefaultImageResolution	Gets and sets default resolution of image.