跳到主要内容

ApiListObject

表示 ApiListObject 类。

备注

此功能仅在 ONLYOFFICE Docs 付费版本中可用。

属性​

名称类型描述
Activeboolean指示活动单元格是否在表格范围内。
AlternativeTextstring返回或设置表格的替代文本。
AutoFilterApiAutoFilter | null返回表格的 AutoFilter 对象，或 null。
Commentstring返回或设置表格的批注（摘要替代文本）。
DataBodyRangeApiRange | null返回数据行的范围。
DisplayNamestring返回或设置表格的显示名称。
HeaderRowRangeApiRange | null返回标题行的范围。
Namestring返回或设置表格的显示名称。
ParentApiWorksheet返回父工作表。
RangeApiRange | null返回表格的范围。
ShowAutoFilterboolean返回或设置是否存在自动筛选。
ShowAutoFilterDropDownboolean返回或设置是否显示自动筛选下拉箭头。
ShowHeadersboolean返回或设置是否显示标题行。
ShowTableStyleColumnStripesboolean返回或设置是否应用列条带。
ShowTableStyleFirstColumnboolean返回或设置是否应用第一列样式。
ShowTableStyleLastColumnboolean返回或设置是否应用最后一列样式。
ShowTableStyleRowStripesboolean返回或设置是否应用行条带。
ShowTotalsboolean返回或设置是否显示汇总行。
SortApiSort返回与表格关联的 Sort 对象。
SourceTypeXlListObjectSourceType返回表格的数据源类型。
Summarystring返回或设置表格的描述。
TableStylestring返回或设置表格样式的名称。
TotalsRowRangeApiRange | null返回汇总行的范围；如果未显示则为 null。

方法​

方法返回值描述
AddListColumnApiListColumn | null在表格中指定的从 1 开始的位置添加新列。
AddListRowApiListRow | null在表格中指定的从 1 开始的位置添加新数据行。
Delete无删除 ListObject 对象并清除单元格格式。
GetActiveboolean返回一个布尔值，指示 ListObject 是否处于活动状态，
GetAlternativeTextstring返回表格的替代文本。
GetAutoFilterApiAutoFilter | null返回表示应用于表格的自动筛选的 ApiAutoFilter 对象。
GetCommentstring返回表格的批注（摘要替代文本）。
GetDataBodyRangeApiRange | null返回表格中数据行的范围，不包括标题行和汇总行。
GetDisplayNamestring返回表格的显示名称。
GetHeaderRowRangeApiRange | null返回表格标题行的范围。
GetListColumnsApiListColumn[]返回表格中所有列的数组。
GetListRowsApiListRow[]返回表格中所有数据行的数组，不包括标题行和汇总行。
GetNamestring返回表格的显示名称。
GetParentApiWorksheet返回作为表格父级的 ApiWorksheet 对象。
GetRangeApiRange | null返回表示表格范围的 ApiRange 对象。
GetShowAutoFilterboolean返回表格标题行上是否显示自动筛选下拉按钮。
GetShowAutoFilterDropDownboolean返回表格标题行上是否显示自动筛选下拉箭头。
GetShowHeadersboolean返回表格是否显示标题行。
GetShowTableStyleColumnStripesboolean返回是否对表格应用了条带列格式。
GetShowTableStyleFirstColumnboolean返回是否对表格应用了第一列格式。
GetShowTableStyleLastColumnboolean返回是否对表格应用了最后一列格式。
GetShowTableStyleRowStripesboolean返回是否对表格应用了条带行格式。
GetShowTotalsboolean返回表格是否显示汇总行。
GetSortApiSort返回此列表对象的 Sort 对象。
GetSourceTypestring返回表格的源类型。对于基于范围的表格，始终返回 “xlSrcRange”。
GetSummarystring返回表格的摘要描述（替代文本摘要）。
GetTableStylestring返回应用于表格的表格样式名称。
GetTotalsRowRangeApiRange | null返回表格汇总行的范围。
Resize无将 ListObject 调整为新范围。不插入或移动单元格。
SetAlternativeText无设置表格的替代文本。
SetComment无设置表格的批注（摘要替代文本）。
SetDisplayNameboolean设置表格的显示名称。
SetNameboolean设置表格的名称。等同于 SetDisplayName。
SetShowAutoFilter无设置表格上是否存在自动筛选。
SetShowAutoFilterDropDown无设置表格标题行上是否显示自动筛选下拉箭头。
SetShowHeaders无设置表格是否显示标题行。
SetShowTableStyleColumnStripes无设置是否对表格应用条带列格式。
SetShowTableStyleFirstColumn无设置是否对表格应用第一列格式。
SetShowTableStyleLastColumn无设置是否对表格应用最后一列格式。
SetShowTableStyleRowStripes无设置是否对表格应用条带行格式。
SetShowTotals无设置表格是否显示汇总行。
SetSummary无设置表格的摘要描述（替代文本摘要）。
SetTableStyle无按名称设置表格样式。
Unlist无从 ListObject 中移除列表功能并将其转换为常规数据范围。