GrapeCity.Documents.Excel.IWorkbook

IWorkbook Interface

表示一个 IWorkbook 对象。

Namespace: GrapeCity.Documents.Excel

Assembly: GcDocs.Excel.dll

Syntax

public interface IWorkbook

Properties

Name	Description
ActiveSheet	返回一个对象，该对象表示活动工作簿（位于顶部的工作簿）或指定窗口或工作簿中的活动工作表。如果没有活动的工作表，则返回 null（只读）。
AllowDynamicArray	获取或设置是否允许动态数组公式。
AutoParse	确定在将范围值设置为字符串值时是否自动解析。
AutoRoundValue	确定在获取值时是否将数字四舍五入到15位有效数字。
BookView	返回一个对象，该对象表示此工作簿的视图设置（只读）。
BuiltInDocumentProperties	获取代表工作簿所有内置文档属性的集合。
Culture	[仅初始化] 获取或设置工作簿的区域性。 该区域性必须包含国家和语言。
CustomDocumentProperties	获取代表工作簿所有自定义文档属性的集合。
CustomViews	获取工作簿的自定义视图。
DefaultTableStyle	指定从ITableStyleCollection 集合中用作默认 TableStyle 的表样式名称（可读写）。
DeferUpdateDirtyState	获取或设置当更改单元格的值时是否立即更新公式单元格的脏状态。
EnableCalculation	获取或设置计算引擎是否有效。
FullName	返回工作簿的名称，包括其在磁盘上的路径。
GraphicsInfo	提供图形信息。 如果此属性没有值， 工作簿将使用内置的图形信息。
Name	获取或设置代表工作簿名称的字符串值。
Names	返回代表工作簿指定名称的INames 集合。这是一个只读的INames 对象。
Options	返回一个IExcelOptions 对象，该对象表示用于控制工作簿行为的某些设置。
Path	获取或设置一个字符串，该字符串表示此工作簿对象所代表的工作簿文件的路径。
PivotCaches	返回IPivotCaches 集合，该集合表示指定工作簿中所有的IPivotTable 缓存（只读）。
ProtectStructure	如果工作簿中工作表的顺序受到保护，则为 True。只读布尔值。
ProtectWindows	如果工作簿的窗口受到保护，则为 True。只读布尔值。
ReferenceStyle	获取或设置引用样式。
ResetAdjacentRangeBorder	确定在为范围设置边框时是否重置相邻范围的边框。此属性的默认值为 true。
SelectedSheets	返回一个IWorksheets 集合， 该集合代表指定工作簿中所有选中的工作表。
SheetTabs	返回一个ISheetTabs 集合，该集合代表指定工作簿中的所有工作表选项卡。
ShowPivotTableFieldList	获取或设置一个值，指示是否可以显示数据透视表字段列表。默认为true。
Signatures	获取与文档附着的数字签名对应的签名对象集合。
SlicerCaches	获取与工作簿关联的ISlicerCaches 对象。
Styles	返回IStyleCollection 集合，该集合表示指定工作簿中的所有样式（只读）。
TableStyles	返回当前工作簿的ITableStyleCollection 集合对象，该对象引用当前工作簿中使用的样式（只读）。
Theme	获取或设置应用于当前工作簿的主题。
Worksheets	返回一个IWorksheets 集合，该集合代表指定工作簿中的所有工作表。这是一个只读的 Sheets 对象。
WriteProtection	提供访问工作簿写保护选项的权限。

Methods

Name	Description
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文档的名称。
GetUsedFonts()	获取工作簿上使用的所有字体信息。
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文件。
ToJson(SerializationOptions)	从工作簿生成一个 JSON 字符串。
ToJson(Stream, SerializationOptions)	从工作簿生成一个JSON流。
ToSjsJson()	从工作簿生成一个JSON字符串。它将SJS文件中的所有JSON文件集成到一个字符串中。
ToSjsJson(SjsSaveOptions)	从工作簿生成一个JSON字符串。它将SJS文件中的所有JSON文件集成到一个字符串中。
ToSjsJson(Stream)	将SJS文件中的所有JSON文件集成到一个字符串中，然后将该字符串放入流中。
ToSjsJson(Stream, SjsSaveOptions)	将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	当工作表上的选择发生变化时发生。