Workbook类提供了在代码中创建、加载、编辑、保存和打印电子表格文档的方法。
下面的示例显示了如何创建工作簿实例。
Vb.Net |
'创建一个workbook工作簿 Dim workbook As New DevExpress.Spreadsheet.Workbook() |
C# |
//创建一个workbook工作簿 DevExpress.Spreadsheet.Workbook workbook = new DevExpress.Spreadsheet.Workbook(); |
性能优化提示:
当对文档应用多个修改时,将代码放在workbook.BeginUpdate和workbook.EndUpdate代码段之间可提高性能。
处理完文档后,调用workbook.Dispose方法释放对象使用的所有资源。此操作可帮助您避免内存泄漏并提高系统性能。您也可以在using语句(Visual
Basic中的Using块)中修改工作簿。
工作簿由存储在 Workbook.Worksheets 集合中的一个或多个工作表组成。创建工作簿时,它包含一个空工作表。使用 WorksheetCollection 成员可以添加新工作表、删除现有工作表、重命名工作表、选择活动工作表等。
工作簿还可以包含仅显示图表的图表工作表。使用 Workbook.ChartSheets 属性可以访问和修改图表工作表集合。
Workbook.Sheets 集合将所有工作表(工作表和图表工作表)存储在工作簿中。使用此集合可获取任何类型的工作表。
Workbook.DefinedNames 集合包括当前工作簿的任何工作表中可用的全局定义名称。
您可以在公式中包含函数来执行计算。使用 Workbook.Functions 属性访问 WorkbookFunctions 对象,该对象存储所有内置函数,并允许您通过 WorkbookFunctions.OverrideFunction 方法重写任何函数。
了解如何在公式中使用函数。
您还可以创建自定义函数。若要向工作簿添加自定义函数,请定义一个实现 ICustomFunction 接口的类,并将其实例添加到 Workbook.CustomFunctions 或 Workbook.GlobalCustomFunctions 集合中。
注意
自定义函数不会保存。若要在保存工作簿时将自定义函数定义替换为计算值,请设置“工作簿导出选项”。自定义函数导出模式选项设置为计算值。
工作簿包含用于设置单元格外观格式的样式集合。使用 Workbook.Styles 属性可访问和修改此集合。
了解如何添加新的单元格样式或修改现有样式。
Workbook.TableStyles 集合存储可应用于表和数据透视表的样式。您可以选择内置样式或创建自定义样式。
了解如何将样式应用于表格
了解如何将样式应用于数据透视表。
您可以以 Excel 文件格式在工作簿中嵌入任意 XML 数据。此数据被命名为自定义 XML 部件,并存储在 Workbook.CustomXmlParts 集合中。使用集合的成员可以创建和修改自定义 XML 部件。
下表列出了可以对工作簿执行的操作。
任务 | API 成员/示例 |
创建新文档 | Workbook.CreateNewDocument |
如何:创建新工作簿 | |
加载工作簿 | Workbook.LoadDocument |
DocumentOptions.Import | |
如何:将文档加载到工作簿中 | |
支持的格式 | |
保存工作簿 | Workbook.SaveDocument |
Workbook.ExportToHtml | |
Workbook.ExportToPdf | |
DocumentOptions.Export | |
如何:将文档保存到文件 | |
如何:将工作簿导出为PDF | |
如何:将文档导出为HTML | |
支持的格式 | |
保护工作簿 | Workbook.Protect |
Workbook.Unprotect | |
如何:保护工作簿 | |
加密工作簿 | Workbook.SaveDocument |
DocumentSettings.Encryption | |
如何:打开和保存密码加密文件 | |
打印工作簿 | Workbook.Print |
Sheet.Print | |
Worksheet.PrintOptions | |
Printing | |
跟踪更改历史记录 | Workbook.History |
查看和编辑文档属性 | Workbook.DocumentProperties |
DocumentProperties.Custom | |
如何:指定文档属性 |
文档设置
使用
Workbook.Options 属性可访问各种文档选项。它们包括:
选项名称 | 说明 |
WorkbookOptions.Import |
指定用于导入不同文件格式的文档的选项。 |
WorkbookOptions.Export |
指定用于将文档导出为不同文件格式的选项。 |
WorkbookOptions.Save |
定义保存工作簿时使用的文件名和文件格式。 |
WorkbookOptions.DocumentCapabilities |
允许您禁用以下文档功能:公式、图表、图片、形状和迷你图。 |
WorkbookOptions.Cells |
指定工作表单元格的选项。 |
WorkbookOptions.Copy |
包含允许您控制复制操作的选项。 |
orkbookOptions.Culture |
提供特定于区域性的设置。 |
WorkbookOptions.Events |
提供对WorkbookEventOptions.RaiseOnModificationsViaAPI选项的访问,该选项使您能够通过
API 执行的更改引发事件。 |
WorkbookOptions.CalculationMode |
指定 Workbook 对象的计算模式 。默认模式为手动。调用 Workbook.Calculate、 Worksheet.Calculate或CellRange.Calculate方法来计算文档中的公式。 |
WorkbookOptions.CalculationEngineType |
指定用于在工作簿中执行计算的计算模型。 |
WorkbookOptions.RealTimeData |
提供对实时数据 (RTD) 函数计算选项的访问。 |
WorkbookOptions.Protection |
允许您指定UseStrongPasswordVerifier 和 SpinCount密码保护选项。 |
WorkbookOptions.DataSourceLoading |
提供对SpreadsheetDataSourceLoadingOptions.CustomAssemblyBehavior选项的访问,该选项指定是否在邮件合并期间使用实体框架数据上下文加载自定义程序集。 |
WorkbookOptions.Compatibility |
提供对以下兼容性设置的访问: |
SpreadsheetCompatibilityOptions.EnableLegacyLayoutEngine-
允许您关闭新的布局引擎及其功能。 | |
SpreadsheetCompatibilityOptions.EnableLegacyPdfExport- 启用旧版 PDF
导出引擎。 | |
SpreadsheetCompatibilityOptions.EnableLegacyPrintLayout-
允许您禁用打印布局增强功能。 | |
WorkbookOptions.Localization |
返回工作簿的本地化选项。 |
WorkbookOptions.Layout |
包含工作簿布局选项。使用属性WorkbookLayoutOptions.Dpi指定文档布局生成的分辨率
(DPI)。 |
WorkbookOptions.ZoomMode |
指定是否将设置SheetView.Zoom应用于所有工作表视图还是仅应用于当前视图。 |
其他工作簿设置可从 Workbook.DocumentSettings 属性获得。
选项名称 | 说明 |
DocumentSettings.Calculation |
提供对公式计算选项的访问。 |
DocumentSettings.R1C1ReferenceStyle |
指定工作簿是否应使用 R1C1 引用样式。 |
DocumentSettings.Encryption |
提供对文档加密选项的访问。 |
DocumentSettings.ShowPivotTableFieldList |
指定是否显示 工作簿中数据透视表的字段列表。 |
工作簿扩展
WorkbookExtensions 类定义 Workbook 对象的扩展方法。
选项名称 | 说明 |
WorkbookExtensions.Append |
将指定工作簿中的所有工作表追加到当前工作簿中。 |
了解如何将多个工作簿合并到一个文档中。 | |
WorkbookExtensions.Clone |
创建工作簿的副本。 |
了解如何克隆工作簿。 |