Workbook Class

Workbook class

Represents a root object to create an Excel spreadsheet.

type Workbook struct  {
	ptr unsafe.Pointer
}

Constructors

Method	Description
NewWorkbook	Initializes a new instance of the class.
NewWorkbook_FileFormatType	Initializes a new instance of the class.
NewWorkbook_String	Initializes a new instance of the class and open a file.
NewWorkbook_String_LoadOptions	Initializes a new instance of the class and open a file.

Methods

Method	Description
IsNull	Checks whether the implementation object is nullptr.
GetSettings	Represents the workbook settings.
ParseFormulas	Parses all formulas which have not been parsed when they were loaded from template file or set to a cell.
StartAccessCache	Starts the session that uses caches to access data.
CloseAccessCache	Closes the session that uses caches to access data.
Save_String_SaveFormat	Saves the workbook to the disk.
Save_String	Save the workbook to the disk.
Save_String_SaveOptions	Saves the workbook to the disk.
GetWorksheets	Gets the collection in the spreadsheet.
IsLicensed	Indicates whether license is set.
RemoveUnusedStyles	Remove all unused styles.
CreateStyle	Creates a new style.
CreateBuiltinStyle	Creates built-in style by given type.
CreateCellsColor	Creates a object.
Replace_String_String	Replaces a cell’s value with a new string.
Replace_String_Int	Replaces a cell’s value with a new integer.
Replace_String_Double	Replaces a cell’s value with a new double.
Replace_Bool_Object	Replaces cells’ values with new data.
Replace_Int_Object	Replaces cells’ values with new data.
Replace_String_String_ReplaceOptions	Replaces a cell’s value with a new string.
Copy_Workbook_CopyOptions	Copies another Workbook object.
Copy_Workbook	Copies data from a source Workbook object.
Combine	Combines another Workbook object.
GetStyleInPool	Gets the style in the style pool.All styles in the workbook will be gathered into a pool.There is only a simple reference index in the cells.
GetCountOfStylesInPool	Gets number of the styles in the style pool.
GetNamedStyle	Gets the named style in the style pool.
ChangePalette	Changes the palette for the spreadsheet in the specified index.
IsColorInPalette	Checks if a color is in the palette for the spreadsheet.
CalculateFormula	Calculates the result of formulas.
CalculateFormula_Bool	Calculates the result of formulas.
CalculateFormula_CalculationOptions	Calculating formulas in this workbook.
RefreshDynamicArrayFormulas_Bool	Refreshes dynamic array formulas(spill into new range of neighboring cells according to current data)Other formulas in the workbook will not be calculated recursively even if they were used by dynamic array formulas.
RefreshDynamicArrayFormulas_Bool_CalculationOptions	Refreshes dynamic array formulas(spill into new range of neighboring cells according to current data)
GetDefaultStyle	Gets or sets the default object of the workbook.
SetDefaultStyle	Gets or sets the default object of the workbook.
GetMatchingColor	Find best matching Color in current palette.
IsDigitallySigned	Indicates if this spreadsheet is digitally signed.
SetEncryptionOptions	Set Encryption Options.
Protect	Protects a workbook.
ProtectSharedWorkbook	Protects a shared workbook.
Unprotect	Unprotects a workbook.
UnprotectSharedWorkbook	Unprotects a shared workbook.
IsWorkbookProtectedWithPassword	Indicates whether structure or window is protected with password.
RemoveMacro	Removes VBA/macro from this spreadsheet.
GetVbaProject	Gets the in a spreadsheet.
RemoveDigitalSignature	Removes digital signature from this spreadsheet.
AcceptAllRevisions	Accepts all tracked changes in the workbook.
GetHasMacro	Indicates if this spreadsheet contains macro/VBA.
GetHasRevisions	Gets if the workbook has any tracked changes
GetFileName	Gets and sets the current file name.
SetFileName	Gets and sets the current file name.
GetDataSorter	Gets a DataSorter object to sort data.
GetThemeColor	Gets theme color.
SetThemeColor	Sets the theme color
GetTheme	Gets the theme name.
CopyTheme	Copies the theme from another workbook.
UpdateCustomFunctionDefinition	Updates definition of custom functions.
GetBuiltInDocumentProperties	Returns a collection that represents all the built-in document properties of the spreadsheet.
GetCustomDocumentProperties	Returns a collection that represents all the custom document properties of the spreadsheet.
GetFileFormat	Gets and sets the file format.
SetFileFormat	Gets and sets the file format.
GetInterruptMonitor	Gets and sets the interrupt monitor.
SetInterruptMonitor_AbstractInterruptMonitor	Gets and sets the interrupt monitor.
SetInterruptMonitor_InterruptMonitor	Sets the interrupt monitor.
GetContentTypeProperties	Gets the list of objects in the workbook.
GetCustomXmlParts	Represents a Custom XML Data Storage Part (custom XML data within a package).
GetDataMashup	Gets mashup data.
GetRibbonXml	Gets and sets the XML file that defines the Ribbon UI.
SetRibbonXml	Gets and sets the XML file that defines the Ribbon UI.
GetAbsolutePath	Gets and sets the absolute path of the file.
SetAbsolutePath	Gets and sets the absolute path of the file.
GetDataConnections	Gets the collection.
ImportXml_String_String_Int_Int	Imports/Updates an XML data file into the workbook.
ExportXml_String_String	Export XML data linked by the specified XML map.
SetDigitalSignature	Sets digital signature to an spreadsheet file (Excel2007 and later).
AddDigitalSignature	Adds digital signature to an OOXML spreadsheet file (Excel2007 and later).
GetDigitalSignature	Gets digital signature from file.
RemovePersonalInformation	Removes personal information.
GetDataModel	Gets data model in the workbook.
Dispose	Performs application-defined tasks associated with freeing, releasing, orresetting unmanaged resources.