Workbook Class |
Inheritance HierarchyNamespace: Spire.Xls
Assembly: Spire.XLS (in Spire.XLS.dll) Version: 11.9.3.0 (11.9.3.5040)
SyntaxThe Workbook type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | ActiveSheet |
Returns an object that represents the active sheet (the sheet
on top) in the active workbook or in the specified window or
workbook. Returns Nothing if no sheet is active. Read-only.
|
| ActiveSheetIndex |
Gets or sets index of the active worksheet.
|
| AddInFunctions |
Returns collection of add-in functions.
|
| Allow3DRangesInDataValidation | |
| CalculationMode |
Get or set calculation mode.
|
| Charts |
Returns a Sheets collection that represents all the chart sheets in the specified workbook. Read-only.
|
| Chartsheets | |
| CheckComptiliblity | |
| CodeName |
Name which used by macros to access to workbook items.
|
| Colors |
Returns colors in the palette for the workbook. The palette has 56 entries, each represented by an RGB value. Read/write Object.
|
| ConverterSetting | |
| CustomDocumentProperties | |
| CustomFontFileDirectory |
Sets the custom directory of font files.
|
| CustomFontFilePaths |
Returns or sets the custom path of font files.
|
| CustomTableStyles | |
| DataConns | |
| DataSorter |
Gets Data sorter to sort the data..
|
| Date1904 |
True if the workbook uses the 1904 date system. Read/write Boolean.
|
| DefaultFontName |
Returns or sets the name of the default font.
|
| DefaultFontSize |
Returns or sets the default font size.
|
| DisableMacrosStart |
Allows users to disable load of macros from document.
|
| DocumentProperties |
Returns a BuiltInDocumentProperties collection that represents all the built-in document properties for the specified workbook. Read-only.
|
| ExternalLinks | |
| FileName |
Gets file name.
|
| HasMacros |
Indicates whether contains VBA macros.
|
| HasTrackedChanges |
Indicates whether the workbook has any tracked changes
|
| IsCellProtection |
Indicates whether cells are protected.
|
| IsDigitallySigned |
Indicates whether this spreadsheet is digitally signed.
|
| IsHideWindow |
Hide window
|
| IsHScrollBarVisible |
Returns or sets whether show horizontal scroll bar.
|
| IsRightToLeft |
Indicates whether worksheet is displayed right to left.
|
| IsSaved |
Indicates whether workbook changes have been saved.
|
| IsVScrollBarVisible |
Returns or sets whether show vertical scroll bar.
|
| IsWindowProtection |
Indicates window is protected.
|
| MarkerDesigner | |
| MaxColumnCount | |
| MaxDigitWidth | |
| MaxRowCount | |
| MaxRowsOfSharedFormula | |
| NameRanges | |
| OpenPassword |
Returns or sets password to encrypt document.
|
| OptimizeImport |
Indicates whether to optimize Import data. This option will
take effect only on Import methods that are available with the worksheet
WARNING: Setting this property to True can decrease memory significantly,
but will increase the performance of data import .
|
| PivotCaches | |
| PrintDialog | |
| PrintDocument |
Gets the PrintDocument
|
| ReadOnly |
Indicates whether the workbook has been opened as Read-only.
|
| SelectedTab |
Gets or sets tab index of selected.
|
| SheetTabBarWidth |
Returns or sets the width of worksheet tab bar. 1/1000 of window width.
|
| ShowTabs |
Get or sets a value whether the Workbook tabs are displayed.
|
| Styles |
Returns a Styles collection that represents all the styles in the specified workbook. Read-only.
|
| UseStorageMode |
User Compound storage mode
|
| Version | |
| Worksheets |
Returns a Sheets collection that represents all the worksheets in the specified workbook. Read-only Sheets object.
|
| WriteProtection |
Returns options of the workbook write protection.
|
Methods| Name | Description | |
|---|---|---|
 | AcceptAllTrackedChanges |
Accept all tracked changes in the workbook.
|
| AddDigitalSignature |
Add a DigitalSignature.
|
| AddPivotTableStyle | |
| CaculateFormulaValue |
Computes the string formula
|
| CalculateAllValue |
Caculate all formula for the workbook
|
| ChangePaletteColor |
Changes the palette for the spreadsheet in the specified index.
|
| ColumnWidthToPixels |
onverts column width in characters into column width in pixels.
|
| ContainsFont |
Indicates whether the workbook contains specified font.
|
| CopyTheme |
Copy the theme from source workbook
|
| CopyThemeColor |
Copy the theme color from source workbook
|
| CopyToClipboard |
Copies whole workbook to the clipboard.
|
| CopyToClipboard(Worksheet) |
Copies the selected worksheet to clipboard.
|
| CreateEmptySheet |
Create a new worksheet.
|
| CreateEmptySheet(String) |
Create a new worksheet.
|
| CreateEmptySheets(Int32) |
Create workbook with specified number of worksheets.
|
| CreateEmptySheets(String) |
Create workbook with specified names of worksheets.
|
| CreateFont |
Creates a font object and add it to the workbook.
|
| CreateFont(Font) | |
| CreatePivotStyle | |
| Dispose | Releases all resources used by the Workbook |
| Equals | (Inherited from Object.) |
| FindAllBool |
Finds the cell with the input bool.
|
| FindAllDateTime |
Finds the cell with the input datetime.
|
| FindAllNumber |
Finds the cell with the input double.
|
| FindAllString |
Finds the cell with the input string.
|
| FindAllTimeSpan |
Finds the cell with the input time span.
|
| FindBool |
Finds the cell with the input bool.
|
| FindDateTime |
Finds the cell with the input datetime.
|
| FindNumber |
Finds the cell with the input number.
|
| FindString |
Finds the cell with the input string.
|
| FindTimeSpan |
Finds the cell with the input time span.
|
| GetChartSheetByName | |
| GetCustomFontParsedResult |
Get result that parse the custom path of font files
|
| GetDigitalSignatures |
Get collection of DigitalSignature in this file.
|
| GetHashCode | (Inherited from Object.) |
| GetMatchingColor(Color) |
Find best matching Color in workbook palette.
|
| GetMatchingColor(Int32, Int32, Int32) |
Find best matching Color in workbook palette.
|
| GetOleSize |
get the size of the visible range of cells when this workbook is displyed as an embedded obect in another document;
|
| GetPaletteColor |
Gets excel color from workbook palette.
|
| GetSafeSheetName(String) | |
| GetSafeSheetName(String, Char) | |
| GetSplitPageInfo | |
| GetSplitPageTable | |
| GetThemeColor |
Gets theme color.
|
| GetType | (Inherited from Object.) |
| InitCalcEngine |
Initilize Calc engine
|
 | IsPasswordProtected |
check file is password protect
|
| LoadFromFile(String) |
Loads a file and imports its data.
|
| LoadFromFile(String, ExcelVersion) |
Loads a file and imports its data.
|
| LoadFromFile(String, Boolean) |
Loads a file and imports its data.
|
| LoadFromFile(String, String) |
Loads text files stream with user defined separator.
|
| LoadFromFile(String, String, Int32, Int32) |
Loads text files with user defined separator.
|
| LoadFromFile(String, String, Int32, Int32, ExcelVersion) |
Loads text files with user defined separator.
|
| LoadFromFile(String, String, Int32, Int32, ExcelVersion, Encoding) |
Loads text files with user defined separator.
|
| LoadFromHtml(Stream) |
Loads a html file and imports its data.
|
| LoadFromHtml(String) |
Loads a html file and imports its data.
|
| LoadFromMHtml(Stream) |
Loads a Mhtml file and imports its data.
|
| LoadFromMHtml(String) |
Loads a Mhtml file and imports its data.
|
| LoadFromStream(Stream) |
Load workbook from the stream.
|
| LoadFromStream(Stream, ExcelVersion) |
Load workbook from the stream.
|
| LoadFromStream(Stream, Boolean) |
Load workbook from the stream.
|
| LoadFromStream(Stream, String, Int32, Int32) |
Loads text files stream with user defined separator.max row 60000.
|
| LoadFromStream(Stream, String, Int32, Int32, ExcelVersion) |
Loads text files stream with user defined separator. Version2007 support 60000+ row
|
| LoadFromXml(Stream) |
Loads a xml file and imports its data.
|
| LoadFromXml(String) |
Loads a xml file and imports its data.
|
| LoadTemplateFromFile(String) |
Load workbook from the excel template.
|
| LoadTemplateFromFile(String, Boolean) |
Load workbook from the excel template.
|
| PasteFromClipboard |
Copies workbook and all its worksheets from the clipboard.
|
| PixelsToColumnWidth |
Converts column width in pixels into column width in characters.
|
| Protect(String) |
protect file also protect workbook window and structure.
|
| Protect(String, Boolean, Boolean) |
protect file,also Indicates whether protect workbook window and structure or not
|
| ProtectWorkbook |
Sets protection for workbook.
|
| RejectAllTrackedChanges |
Reject all tracked changes in the workbook.
|
| RemoveAllDigitalSignatures |
Remove all DigitalSignature in this file.
|
| Replace(String, DateTime) |
Replaces cell's value by specified value.
|
| Replace(String, Double) |
Replaces cell's value by specified value..
|
| Replace(String, String) |
Replaces cell's value by specified value.
|
| Replace(String, DataColumn, Boolean) |
Replaces cell's value from data column values.
|
| Replace(String, DataTable, Boolean) |
Replaces cell's value from data table values.
|
| Replace(String, Double, Boolean) |
Replaces cell's value from array.
|
| Replace(String, Int32, Boolean) |
Replaces cell's value from array.
|
| Replace(String, String, Boolean) |
Replaces cell's value from array.
|
| ResetPalette |
Resets the color palette to the default colors.
|
| Save |
Saves changes to the specified workbook
|
| SaveAsImage(Single, Single) | |
| SaveAsImage(Int32, Single, Single) |
Save workbook to image.
|
| SaveAsTemplate(String) |
Save workbook as template to file.
|
| SaveAsTemplate(String, HttpResponse) |
Save workbook as template to response.
|
| SaveAsXml(Stream) |
Save workbook as XML format to stream.
|
| SaveAsXml(String) |
Save workbook to an XML data file.
|
| SaveChartAsEmfImage(Worksheet) | Obsolete.
Save chart to vector images.
|
| SaveChartAsEmfImage(Worksheet, Int32) | Obsolete.
Save chart to vector image.
|
| SaveChartAsEmfImage(Worksheet, Int32, Stream) |
Save chart to vector image.
|
| SaveChartAsImage(ChartSheet) |
Save chart to image.
|
| SaveChartAsImage(Worksheet) |
Save chart to images.
|
| SaveChartAsImage(Worksheet, Int32) |
Save chart to image.
|
| SaveToFile(String) |
Saves changes to the workbook in a different file
|
| SaveToFile(String, ExcelVersion) |
Saves changes to the workbook in a different file
|
| SaveToFile(String, FileFormat) |
Saves changes to the workbook in a different file
|
| SaveToFile(String, TextSaveOptions) |
Saves changes to the workbook in a different file
|
| SaveToFile(String, String) |
Saves changes to the workbook in a different file
|
| SaveToFile(String, FileFormat, Boolean) |
Saves changes to the workbook in a different file
|
| SaveToHtml(String) | |
| SaveToHtml(String, Boolean) |
Saves the workbook to html
|
| SaveToHttpResponse(String, HttpResponse) |
Save workbook to the http response.
|
| SaveToHttpResponse(String, HttpResponse, HttpContentType) |
Save workbook to the http response.
|
| SaveToHttpResponse(String, HttpResponse, Boolean) |
Save workbook to the http response.
|
| SaveToHttpResponse(String, HttpResponse, HttpContentType, FileFormat) |
Save workbook to the http response.
|
| SaveToStream(Stream) |
Save workbook the stream
|
| SaveToStream(Stream, FileFormat) |
Save workbook to stream.
|
| SaveToStream(Stream, String) |
Save workbook the stream.
|
| SetMaxDigitWidth | |
| SetOleSize |
set the size of the visible range of cells when this workbook is displyed as an embedded obect in another document;
|
| SetThemeColor |
Sets the theme color
|
| SetWriteProtectionPassword |
Sets write protection password.
|
| ToString | (Inherited from Object.) |
| UnProtect |
unprotect file
also upprotect workbook window and structure
|
| UnProtect(String) |
unprotect file
also upprotect workbook window and structure
|
| UnProtectWorkbook |
unprotect workbook window and structure
|
See Also
