GrapeCity.Documents.Excel.Workbook

Workbook Class

表示一个工作簿。

Inheritance

object

Workbook

Implements

IWorkbook

Namespace: GrapeCity.Documents.Excel

Assembly: GcDocs.Excel.dll

Syntax

public sealed class Workbook : IWorkbook

Constructors

Name	Description
Workbook()	创建工作簿。
Workbook(WorkbookOptions)	创建工作簿。
Workbook(string)	创建工作簿。
Workbook(string, WorkbookOptions)	创建工作簿。

Properties

Name	Description
AIModelRequestHandler	获取或设置 IAIModelRequestHandler 的单例实例， 该实例用于处理外部模型操作的请求。 此处理程序负责处理应用程序中所有工作簿的与模型相关的请求。 设置此属性会影响所有现有及未来的工作簿实例。
ActiveSheet	获取活动工作表。
AllowDynamicArray	此API已过时，请使用Formula2来获取或设置动态数组公式。
Author	获取或设置作者。
AutoParse	确定在将范围值设置为字符串值时是否自动解析。
AutoRoundValue	确定在获取值时是否将数字四舍五入到15位有效数字。
BookView	返回一个表示此工作簿视图设置的对象（只读）。
BuiltInDocumentProperties	获取代表工作簿所有内置文档属性的集合。
Culture	[仅初始化] 获取或设置工作簿的文化信息。 文化信息必须包含国家和语言。
CustomDocumentProperties	获取代表工作簿所有自定义文档属性的集合。
CustomViews	获取工作簿的自定义视图。
DefaultTableStyle	指定作为默认 TableStyle 使用的表格样式。
DeferUpdateDirtyState	获取或设置当更改单元格的值时是否立即更新公式单元格的脏状态。
EnableCalculation	指定计算引擎是否正在工作。
FontsFolderPath	获取或设置字体文件所在的目录。 这些字体用于PDF、HTML和Image导出中的渲染和测量，以及AutoFit功能。
FullName	返回工作簿的名称，包括其在磁盘上的路径。
GraphicsInfo	提供图形信息。如果此属性没有值，工作簿将使用内置的图形信息。
IconSets	根据IconSets集合中的单元格图标筛选工作簿中的数据。此属性为只读。
LoggerFactory	获取或设置所有工作簿共享的日志工厂。
Name	获取或设置代表工作簿名称的字符串值。
Names	返回代表工作簿指定名称的INames 集合。 Names 对象是只读的。
Options	返回一个IExcelOptions 对象，该对象表示用于控制工作簿行为的某些设置。
Path	获取或设置一个字符串，该字符串表示此工作簿对象所代表的工作簿文件的路径。
PivotCaches	获取一个表示指定工作簿中所有PivotTable缓存的PivotCaches集合。
ProtectStructure	如果工作簿中工作表的顺序受到保护，则为 True。只读布尔值。
ProtectWindows	如果工作簿的窗口受到保护，则为 True。只读布尔值。
ReferenceStyle	获取或设置引用样式。
ResetAdjacentRangeBorder	确定在为范围设置边框时是否重置相邻范围的边框。此属性的默认值为 true。
SelectedSheets	返回一个IWorksheets 集合， 该集合表示指定工作簿中所有选中的工作表。
SheetTabs	获取工作簿中包含的工作表选项卡集合。
ShowPivotTableFieldList	获取或设置一个值，指示是否可以显示数据透视表字段列表。默认为true。
Signatures	获取与文档附着的数字签名对应的签名对象集合。
SlicerCaches	获取与工作簿关联的ISlicerCaches 对象。
Styles	提供访问当前工作簿中的单元格样式集合的方法。
TableStyles	获取当前工作簿中使用的表格样式。
TagJsonSerializer	获取或设置自定义类型的json序列化器/反序列化器。
Theme	返回一个 ITheme 实例，该实例提供了访问与工作簿关联的主题的功能。
ValueJsonSerializer	获取或设置用于自定义单元格值的json序列化器/反序列化器。
WebRequestHandler	获取或设置将用于处理网络请求的 IWebRequestHandler 实现的单例实例。 此属性为应用程序提供了一种集中访问和设置网络请求处理程序的方式。
Worksheets	获取工作簿中包含的工作表集合。
WriteProtection	返回一个WriteProtection 对象，该对象提供对工作簿写保护选项的访问。

Methods

Name	Description
AddCustomFunction(CustomFunction, bool)	向函数集中添加自定义函数。
AddDataSource(string, object)	为模板添加数据源。
Calculate()	根据需要计算工作簿中的公式。
ConvertBarcodeToPicture(ImageType)	将计算出的条形码转换为图片，并将它们放置在各自的位置上。 原始条形码公式将被清除。 不支持EMF 和WMF 图像类型。
Dirty()	指定当下一次计算发生时，工作簿中的所有公式将被重新计算。
FromJson(Stream, DeserializationOptions)	从JSON流生成工作簿。
FromJson(string, DeserializationOptions)	从JSON字符串生成工作簿。
FromSjsJson(Stream)	从包含 .sjs 文件格式的内容的 JSON 流生成工作簿。
FromSjsJson(Stream, SjsOpenOptions)	从包含.sjs文件格式的内容的JSON流生成工作簿。
FromSjsJson(string)	从包含 .sjs 文件格式的内容的 JSON 字符串生成工作簿。
FromSjsJson(string, SjsOpenOptions)	从包含 .sjs 文件格式的内容的 JSON 字符串生成工作簿。
GenerateReport()	处理模板并返回报告工作簿的实例。
GenerateReport(params IWorksheet[])	处理模板并返回报告工作簿的实例。
GetExcelLinkSources()	返回链接的Excel文档的名称。
GetNames(Stream)	获取所有将被用作 ImportData 方法参数源的表格名和表名。 如果名称是表名，则在工作表名之前加上限定符，例如 "Sheet1!Table1"。
GetNames(string)	获取所有将被用作 ImportData 参数源的表名和工作表名。 如果名称是表名，则在工作表名之前加上限定符，例如 "Sheet1!Table1"。
GetUsedFonts()	获取工作簿上所有使用的字体信息。
ImportData(Stream, string)	导入指定文件源的所有数据。
ImportData(Stream, string, int, int, int, int)	从文件流中导入指定范围的数据。
ImportData(string, string)	导入指定文件源的所有数据。
ImportData(string, string, int, int, int, int)	从文件导入指定范围的数据。
IsEncryptedFile(Stream)	指定文件是否受密码保护。
IsEncryptedFile(string)	指定文件是否受密码保护。
Open(Stream)	打开文件流。
Open(Stream, OpenFileFormat)	使用指定的文件格式打开流。
Open(Stream, OpenOptionsBase)	使用指定的选项打开流。
Open(Stream, string, OpenOptions)	打开指定的 Excel 文件流。
Open(string)	使用默认选项打开文件。 文件类型从文件扩展名推断。
Open(string, DeserializationOptions)	打开 JSON 文件。
Open(string, OpenFileFormat)	使用指定的文件格式打开文件。
Open(string, OpenOptionsBase)	使用指定选项打开文件。
Open(string, string, OpenOptions)	打开指定的Excel文件
PrintOut(PrintOutOptions)	打印工作簿。
ProcessTemplate()	开始使用全局选项处理模板。
ProcessTemplate(CancellationToken)	使用全局选项和取消支持开始处理模板。
Protect(bool, bool)	保护工作簿，使其不能被修改。
Protect(string, bool, bool)	保护工作簿，使其不能被修改。
Save(Stream)	将工作簿保存到流中。
Save(Stream, SaveFileFormat)	使用指定的文件格式将工作簿保存到流中。
Save(Stream, SaveOptionsBase)	使用指定的选项将工作簿保存到流中。
Save(Stream, string, SaveOptions)	将工作簿保存到指定的 Excel 文件流。
Save(string)	将工作簿保存到磁盘。
Save(string, SaveFileFormat)	使用指定的文件格式将工作簿保存到文件。
Save(string, SaveOptionsBase)	使用指定的选项将工作簿保存到文件。
Save(string, string, SaveOptions)	将数据保存到指定的Excel文件。
SetLicenseKey(string)	设置 Documents for Excel 的许可证密钥。
ToJson(SerializationOptions)	从工作簿生成一个 JSON 字符串。
ToJson(Stream, SerializationOptions)	从工作簿生成一个JSON流。
ToSjsJson()	从工作簿生成一个JSON字符串。它将SpreadJS .sjs文件中的所有JSON文件集成到一个字符串中。
ToSjsJson(SjsSaveOptions)	从工作簿生成一个JSON字符串。它将SpreadJS .sjs文件中的所有JSON文件集成到一个字符串中。
ToSjsJson(Stream)	将SpreadJS .sjs文件中的所有JSON文件集成到一个字符串中，然后将该字符串放入流中。
ToSjsJson(Stream, SjsSaveOptions)	将SpreadJS .sjs文件中的所有JSON文件集成到一个字符串中，然后将该字符串放入流中。
Unprotect(string)	移除工作簿的保护。
UpdateExcelLink(string)	更新Excel链接。
UpdateExcelLink(string, IWorkbook)	更新 Excel 链接。
UpdateExcelLinks()	更新所有Excel链接。
WaitForCalculationToFinish()	等待所有计算完成，包括异步计算。 该方法将阻塞当前线程，直到所有计算完成。 用户可以调用此方法以确保在进行任何依赖于计算结果的其他操作之前， 所有必要的计算都已经执行完毕。

Events

Name	Description
AfterSave	工作簿保存之后发生。
BeforeSave	在工作簿保存之前发生。
NewSheet	当工作簿中创建新工作表时发生。
Opened	当工作簿被打开时发生。
SheetActivate	当工作表被激活时发生。
SheetBeforeDelete	在删除工作表之前发生。
SheetChange	当工作表的单元格内容发生变化时发生。
SheetDeactivate	当工作表被停用时发生。
SheetSelectionChange	当工作表上的选择变更时发生。