Excel.Interfaces.WorkbookData interface

描述通过调用 "toJSON ()" 返回的数据的接口。An interface describing the data returned by calling "workbook.toJSON()".

属性

autoSave

指定工作簿是否处于自动保存模式。Specifies whether or not the workbook is in autosave mode. 只读。Read-Only.

[API 集: ExcelApi 1.9][ API set: ExcelApi 1.9 ]

bindings

表示属于工作簿的绑定的集合。Represents a collection of bindings that are part of the workbook. 只读。Read-only.

[API 集: ExcelApi 1.1][ API set: ExcelApi 1.1 ]

calculationEngineVersion

返回有关 Excel 计算引擎的版本号。Returns a number about the version of Excel Calculation Engine. 只读。Read-Only.

[API 集: ExcelApi 1.9][ API set: ExcelApi 1.9 ]

chartDataPointTrack

如果工作簿中的所有图表都跟踪它们所附加的实际数据点,则为 True。True if all charts in the workbook are tracking the actual data points to which they are attached. 假如果图表跟踪数据点的索引。False if the charts track the index of the data points.

[API 集: ExcelApi 1.9][ API set: ExcelApi 1.9 ]

comments

表示与工作簿关联的批注集合。Represents a collection of Comments associated with the workbook. 只读。Read-only.

[API 集: EXCELAPI BETA (仅限预览)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

customXmlParts

表示此工作簿包含的自定义 XML 部件的集合。Represents the collection of custom XML parts contained by this workbook. 只读。Read-only.

[API 集: ExcelApi 1.5][ API set: ExcelApi 1.5 ]

isDirty

指定自上次保存以来是否对指定的工作簿进行任何更改。Specifies whether or not changes have been made since the workbook was last saved. 如果要关闭修改过的工作簿而不保存或提示保存它, 则可以将该属性设置为 true。You can set this property to true if you want to close a modified workbook without either saving it or being prompted to save it.

[API 集: ExcelApi 1.9][ API set: ExcelApi 1.9 ]

name

获取工作簿名称。Gets the workbook name. 只读。Read-only.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

names

表示工作簿范围内的已命名项目(称为区域和常量)的集合。Represents a collection of workbook scoped named items (named ranges and constants). 只读。Read-only.

[API 集: ExcelApi 1.1][ API set: ExcelApi 1.1 ]

pivotTables

表示一组与 workbook 相关联的 PivotTable 对象。Represents a collection of PivotTables associated with the workbook. 只读。Read-only.

[API 集: ExcelApi 1.3][ API set: ExcelApi 1.3 ]

pivotTableStyles

表示一组与工作簿相关联的 PivotTableStyles。Represents a collection of PivotTableStyles associated with the workbook. 只读。Read-only.

[API 集: EXCELAPI BETA (仅限预览)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

previouslySaved

指定工作簿是否已在本地或在线保存。Specifies whether or not the workbook has ever been saved locally or online. 只读。Read-Only.

[API 集: ExcelApi 1.9][ API set: ExcelApi 1.9 ]

properties

获取工作簿属性。Gets the workbook properties. 只读。Read-only.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

protection

返回工作簿的工作簿保护对象。Returns workbook protection object for a workbook. 只读。Read-only.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

readOnly

如果在只读模式下打开工作簿,则为 True。True if the workbook is open in Read-only mode. 只读。Read-only.

[API 集: ExcelApi 1.8][ API set: ExcelApi 1.8 ]

settings

表示一组与 workbook 相关联的 setting 对象。Represents a collection of Settings associated with the workbook. 只读。Read-only.

[API 集: ExcelApi 1.4][ API set: ExcelApi 1.4 ]

slicers

表示与工作簿关联的切片器集合。Represents a collection of Slicers associated with the workbook. 只读。Read-only.

[API 集: EXCELAPI BETA (仅限预览)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

slicerStyles

表示一组与工作簿相关联的 SlicerStyles。Represents a collection of SlicerStyles associated with the workbook. 只读。Read-only.

[API 集: EXCELAPI BETA (仅限预览)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

styles

表示与工作簿关联的样式的集合。Represents a collection of styles associated with the workbook. 只读。Read-only.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

tables

表示与工作簿关联的表的集合。Represents a collection of tables associated with the workbook. 只读。Read-only.

[API 集: ExcelApi 1.1][ API set: ExcelApi 1.1 ]

tableStyles

表示一组与工作簿相关联的 TableStyles。Represents a collection of TableStyles associated with the workbook. 只读。Read-only.

[API 集: EXCELAPI BETA (仅限预览)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

timelineStyles

表示一组与工作簿相关联的 TimelineStyles。Represents a collection of TimelineStyles associated with the workbook. 只读。Read-only.

[API 集: EXCELAPI BETA (仅限预览)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

use1904DateSystem

如果工作簿使用 1904 日期系统,则为 True。True if the workbook uses the 1904 date system.

[API 集: EXCELAPI BETA (仅限预览)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

usePrecisionAsDisplayed

如果此工作簿中的计算仅使用显示的数字精度来完成,则为 True。True if calculations in this workbook will be done using only the precision of the numbers as they're displayed. 将此属性从 false 切换到 true 时, 数据将永久丢失精度。Data will permanently lose accuracy when switching this property from false to true.

[API 集: ExcelApi 1.9][ API set: ExcelApi 1.9 ]

worksheets

表示与工作簿关联的工作表的集合。Represents a collection of worksheets associated with the workbook. 只读。Read-only.

[API 集: ExcelApi 1.1][ API set: ExcelApi 1.1 ]

属性详细信息

autoSave

指定工作簿是否处于自动保存模式。Specifies whether or not the workbook is in autosave mode. 只读。Read-Only.

[API 集: ExcelApi 1.9][ API set: ExcelApi 1.9 ]

autoSave?: boolean;

属性值

boolean

bindings

表示属于工作簿的绑定的集合。Represents a collection of bindings that are part of the workbook. 只读。Read-only.

[API 集: ExcelApi 1.1][ API set: ExcelApi 1.1 ]

bindings?: Excel.Interfaces.BindingData[];

属性值

Excel.Interfaces.BindingData[]

calculationEngineVersion

返回有关 Excel 计算引擎的版本号。Returns a number about the version of Excel Calculation Engine. 只读。Read-Only.

[API 集: ExcelApi 1.9][ API set: ExcelApi 1.9 ]

calculationEngineVersion?: number;

属性值

number

chartDataPointTrack

如果工作簿中的所有图表都跟踪它们所附加的实际数据点,则为 True。True if all charts in the workbook are tracking the actual data points to which they are attached. 假如果图表跟踪数据点的索引。False if the charts track the index of the data points.

[API 集: ExcelApi 1.9][ API set: ExcelApi 1.9 ]

chartDataPointTrack?: boolean;

属性值

boolean

comments

备注

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

表示与工作簿关联的批注集合。Represents a collection of Comments associated with the workbook. 只读。Read-only.

[API 集: EXCELAPI BETA (仅限预览)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

comments?: Excel.Interfaces.CommentData[];

属性值

Excel.Interfaces.CommentData[]

customXmlParts

表示此工作簿包含的自定义 XML 部件的集合。Represents the collection of custom XML parts contained by this workbook. 只读。Read-only.

[API 集: ExcelApi 1.5][ API set: ExcelApi 1.5 ]

customXmlParts?: Excel.Interfaces.CustomXmlPartData[];

属性值

Excel.Interfaces.CustomXmlPartData[]

isDirty

指定自上次保存以来是否对指定的工作簿进行任何更改。Specifies whether or not changes have been made since the workbook was last saved. 如果要关闭修改过的工作簿而不保存或提示保存它, 则可以将该属性设置为 true。You can set this property to true if you want to close a modified workbook without either saving it or being prompted to save it.

[API 集: ExcelApi 1.9][ API set: ExcelApi 1.9 ]

isDirty?: boolean;

属性值

boolean

name

获取工作簿名称。Gets the workbook name. 只读。Read-only.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

name?: string;

属性值

string

names

表示工作簿范围内的已命名项目(称为区域和常量)的集合。Represents a collection of workbook scoped named items (named ranges and constants). 只读。Read-only.

[API 集: ExcelApi 1.1][ API set: ExcelApi 1.1 ]

names?: Excel.Interfaces.NamedItemData[];

属性值

Excel.Interfaces.NamedItemData[]

pivotTables

表示一组与 workbook 相关联的 PivotTable 对象。Represents a collection of PivotTables associated with the workbook. 只读。Read-only.

[API 集: ExcelApi 1.3][ API set: ExcelApi 1.3 ]

pivotTables?: Excel.Interfaces.PivotTableData[];

属性值

Excel.Interfaces.PivotTableData[]

pivotTableStyles

备注

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

表示一组与工作簿相关联的 PivotTableStyles。Represents a collection of PivotTableStyles associated with the workbook. 只读。Read-only.

[API 集: EXCELAPI BETA (仅限预览)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

pivotTableStyles?: Excel.Interfaces.PivotTableStyleData[];

属性值

Excel.Interfaces.PivotTableStyleData[]

previouslySaved

指定工作簿是否已在本地或在线保存。Specifies whether or not the workbook has ever been saved locally or online. 只读。Read-Only.

[API 集: ExcelApi 1.9][ API set: ExcelApi 1.9 ]

previouslySaved?: boolean;

属性值

boolean

properties

获取工作簿属性。Gets the workbook properties. 只读。Read-only.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

properties?: Excel.Interfaces.DocumentPropertiesData;

属性值

protection

返回工作簿的工作簿保护对象。Returns workbook protection object for a workbook. 只读。Read-only.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

protection?: Excel.Interfaces.WorkbookProtectionData;

属性值

readOnly

如果在只读模式下打开工作簿,则为 True。True if the workbook is open in Read-only mode. 只读。Read-only.

[API 集: ExcelApi 1.8][ API set: ExcelApi 1.8 ]

readOnly?: boolean;

属性值

boolean

settings

表示一组与 workbook 相关联的 setting 对象。Represents a collection of Settings associated with the workbook. 只读。Read-only.

[API 集: ExcelApi 1.4][ API set: ExcelApi 1.4 ]

settings?: Excel.Interfaces.SettingData[];

属性值

Excel.Interfaces.SettingData[]

slicers

备注

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

表示与工作簿关联的切片器集合。Represents a collection of Slicers associated with the workbook. 只读。Read-only.

[API 集: EXCELAPI BETA (仅限预览)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

slicers?: Excel.Interfaces.SlicerData[];

属性值

Excel.Interfaces.SlicerData[]

slicerStyles

备注

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

表示一组与工作簿相关联的 SlicerStyles。Represents a collection of SlicerStyles associated with the workbook. 只读。Read-only.

[API 集: EXCELAPI BETA (仅限预览)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

slicerStyles?: Excel.Interfaces.SlicerStyleData[];

属性值

Excel.Interfaces.SlicerStyleData[]

styles

表示与工作簿关联的样式的集合。Represents a collection of styles associated with the workbook. 只读。Read-only.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

styles?: Excel.Interfaces.StyleData[];

属性值

Excel.Interfaces.StyleData[]

tables

表示与工作簿关联的表的集合。Represents a collection of tables associated with the workbook. 只读。Read-only.

[API 集: ExcelApi 1.1][ API set: ExcelApi 1.1 ]

tables?: Excel.Interfaces.TableData[];

属性值

Excel.Interfaces.TableData[]

tableStyles

备注

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

表示一组与工作簿相关联的 TableStyles。Represents a collection of TableStyles associated with the workbook. 只读。Read-only.

[API 集: EXCELAPI BETA (仅限预览)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

tableStyles?: Excel.Interfaces.TableStyleData[];

属性值

Excel.Interfaces.TableStyleData[]

timelineStyles

备注

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

表示一组与工作簿相关联的 TimelineStyles。Represents a collection of TimelineStyles associated with the workbook. 只读。Read-only.

[API 集: EXCELAPI BETA (仅限预览)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

timelineStyles?: Excel.Interfaces.TimelineStyleData[];

属性值

Excel.Interfaces.TimelineStyleData[]

use1904DateSystem

备注

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

如果工作簿使用 1904 日期系统,则为 True。True if the workbook uses the 1904 date system.

[API 集: EXCELAPI BETA (仅限预览)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

use1904DateSystem?: boolean;

属性值

boolean

usePrecisionAsDisplayed

如果此工作簿中的计算仅使用显示的数字精度来完成,则为 True。True if calculations in this workbook will be done using only the precision of the numbers as they're displayed. 将此属性从 false 切换到 true 时, 数据将永久丢失精度。Data will permanently lose accuracy when switching this property from false to true.

[API 集: ExcelApi 1.9][ API set: ExcelApi 1.9 ]

usePrecisionAsDisplayed?: boolean;

属性值

boolean

worksheets

表示与工作簿关联的工作表的集合。Represents a collection of worksheets associated with the workbook. 只读。Read-only.

[API 集: ExcelApi 1.1][ API set: ExcelApi 1.1 ]

worksheets?: Excel.Interfaces.WorksheetData[];

属性值

Excel.Interfaces.WorksheetData[]