跳到主要内容

ApiTable

表示表格的类。

ApiTable 是 ApiTablePr 的子类。

方法​

下表列出了可用的方法。

方法返回值描述
AddCaptionboolean在当前表格之后（或之前）添加题注段落。
AddColumnboolean向当前表格添加新列。
AddColumnsApiTable向当前表格添加新列。
AddCommentApiComment向当前表格的所有内容添加批注。
AddElementboolean使用在单元格中的位置添加段落、表格或块级内容控件。
AddRowApiTableRow向当前表格添加新行。
AddRowsApiTable向当前表格添加新行。
Clearboolean清除表格中的内容。
CopyApiTable创建当前表格的副本。
Deleteboolean删除当前表格。
GetAllCellsApiTableCell[]返回表格中所有单元格的集合。
GetCellApiTableCell通过位置返回单元格。
GetClassType"table"返回 ApiTable 类的类型。
GetInternalIdstring返回当前表格的内部 ID。
GetParentContentControlApiBlockLvlSdt | null返回包含当前表格的内容控件。
GetParentTableApiTable | null返回包含当前表格的表格。
GetParentTableCellApiTableCell | null返回包含当前表格的表格单元格。
GetPosInParentNumber返回表格在其父元素中的位置。
GetRangeApiRange返回表示指定表格中所包含文档部分的 Range 对象。
GetRowApiTableRow通过在表格中的位置返回表格行。
GetRowsCountnumber返回当前表格中的行数。
GetTableDescriptionstring返回表格说明。
GetTableTitlestring返回表格标题（题注）。
GetTablesApiTable[]返回表示嵌套在指定表格中的所有表格的数组。
InsertInContentControlApiTable | ApiBlockLvlSdt用内容控件包装当前表格对象。
MergeCellsApiTableCell合并单元格数组。
RemoveColumnboolean删除包含指定单元格的表格列。
RemoveRowboolean删除包含指定单元格的表格行。
ReplaceByElementboolean用新元素替换当前表格。
SearchApiRange[]在表格对象的范围内搜索。
Selectboolean选择当前表格。
SetBackgroundColorboolean设置当前表格中所有单元格的背景颜色。
SetCellSpacingboolean指定默认表格单元格间距（相邻单元格之间以及单元格与表格边缘之间的间距）。
SetHAlignboolean设置表格的水平对齐方式。
SetJcboolean指定当前表格相对于当前节中文本边距的对齐方式。
SetPaddingsboolean设置表格内边距。
SetShdboolean指定应用于当前表格范围的底纹。
SetStyleboolean为当前表格设置样式。
SetStyleColBandSizeboolean指定此表格样式中每个表格列带包含的列数。
SetStyleRowBandSizeboolean指定此表格样式中每个表格行带包含的行数。
SetTableBorderAllboolean指定将在所有表格单元格边框上显示的边框。
SetTableBorderBottomboolean设置将在当前表格底部显示的边框。
SetTableBorderInsideHboolean指定将在所有不在父表格最外边缘的水平表格单元格边框上显示的边框（所有非顶部或底部边框的水平边框）。
SetTableBorderInsideVboolean指定将在所有不在父表格最外边缘的垂直表格单元格边框上显示的边框（所有非最左侧或最右侧边框的垂直边框）。
SetTableBorderLeftboolean设置将在当前表格左侧显示的边框。
SetTableBorderRightboolean设置将在当前表格右侧显示的边框。
SetTableBorderTopboolean设置将在当前表格顶部显示的边框。
SetTableCellMarginBottomboolean指定在父表格（或表格行）中所有表格单元格的单元格内容底部范围与边框之间保留的空间量。
SetTableCellMarginLeftboolean指定在父表格（或表格行）中所有表格单元格的单元格内容左侧范围与左边框之间保留的空间量。
SetTableCellMarginRightboolean指定在父表格（或表格行）中所有表格单元格的单元格内容右侧范围与右边框之间保留的空间量。
SetTableCellMarginTopboolean指定在父表格（或表格行）中所有表格单元格的单元格内容顶部范围与上边框之间保留的空间量。
SetTableDescriptionboolean设置表格说明。
SetTableIndboolean指定将在文档中当前表格的前缘之前添加的缩进（从左到右表格中的左边缘，以及从右到左表格中的右边缘）。
SetTableLayoutboolean指定将用于在文档中布局当前表格内容的算法。
SetTableLookboolean指定引用的表格样式（如果存在）的条件格式组件，这些组件将应用于具有当前表格级属性例外的表格行集合。一个表格样式最多可以指定六种不同的可选条件格式，例如，为第一列设置不同的格式，然后可以将其应用于父表格中的各个表格行或从中省略。
SetTableTitleboolean设置表格标题（题注）。
SetTextPrboolean将文本设置应用于表格的全部内容。
SetVAlignboolean设置表格的垂直对齐方式。
SetWidthboolean为当前表格设置首选宽度。
SetWrappingStyleboolean设置表格环绕样式。
SplitApiTable | null将单元格拆分为指定数量的行和列。
ToJSONJSON将 ApiTable 对象转换为 JSON 对象。