ApiTable

Represents the ApiTable class.

Methods

Method	Returns	Description
AddCaption	boolean	Adds a caption paragraph after (or before) the current table.\ 💡 Please note that the current table must be in the document (not in the footer/header).\ And if the current table is placed in a shape, then a caption is added after (or before) the parent shape.
AddColumn	None	Adds a new column to the current table.
AddColumns	None	Adds the new columns to the current table.
AddComment	ApiComment	Adds a comment to all contents of the current table.\ 💡 Please note that this table must be in the document.
AddElement	None	Adds a paragraph or a table or a blockLvl content control using its position in the cell.
AddRow	ApiTableRow	Adds a new row to the current table.
AddRows	ApiTable	Adds the new rows to the current table.
Clear	boolean	Clears the content from the table.
Copy	ApiTable	Creates a copy of the current table.
Delete	boolean	Deletes the current table.
GetCell	ApiTableCell | null	Returns a cell by its position.
GetClassType	"table"	Returns a type of the ApiTable class.
GetClassType	"tablePr"	Returns a type of the ApiTablePr class.
GetParentContentControl	ApiBlockLvlSdt | null	Returns a content control that contains the current table.
GetParentTable	ApiTable | null	Returns a table that contains the current table.
GetParentTableCell	ApiTableCell | null	Returns a table cell that contains the current table.
GetPosInParent	Number	Returns the table position within its parent element.
GetRange	ApiRange	Returns a Range object that represents the part of the document contained in the specified table.
GetRow	ApiTableRow | null	Returns a table row by its position in the table.
GetRowsCount	number	Returns a number of rows in the current table.
GetTableDescription	string	Returns the table description.
GetTableTitle	string	Returns the table title (caption).
GetTables	ApiTable[]	Returns an array of tables that represents all the tables nested within the specified table.
InsertInContentControl	ApiTable | ApiBlockLvlSdt	Wraps the current table object with a content control.
MergeCells	ApiTableCell	Merges an array of cells. If the merge is done successfully, it will return the resulting merged cell, otherwise the result will be "null".\ 💡 The number of cells in any row and the number of rows in the current table may be changed.
RemoveColumn	boolean	Removes a table column with a specified cell.
RemoveRow	boolean	Removes a table row with a specified cell.
ReplaceByElement	boolean	Replaces the current table with a new element.
Search	ApiRange[]	Searches for a scope of a table object. The search results are a collection of ApiRange objects.
Select	boolean	Selects the current table.
SetBackgroundColor	boolean	Sets the background color to all cells in the current table.
SetCellSpacing	None	Specifies the default table cell spacing (the spacing between adjacent cells and the edges of the table).
SetHAlign	boolean	Sets the horizontal alignment to the table.
SetJc	None	Specifies the alignment of the current table with respect to the text margins in the current section.
SetPaddings	boolean	Sets the table paddings.\ If table is inline, then only left padding is applied.
SetShd	None	Specifies the shading which is applied to the extents of the current table.
SetStyle	boolean	Sets a style to the current table.
SetStyleColBandSize	None	Specifies a number of columns which will comprise each table column band for this table style.
SetStyleRowBandSize	None	Specifies a number of rows which will comprise each table row band for this table style.
SetTableBorderBottom	None	Sets the border which will be displayed at the bottom of the current table.
SetTableBorderInsideH	None	Specifies the border which will be displayed on all horizontal table cell borders which are not on the outmost edge\ of the parent table (all horizontal borders which are not the topmost or bottommost borders).
SetTableBorderInsideV	None	Specifies the border which will be displayed on all vertical table cell borders which are not on the outmost edge\ of the parent table (all vertical borders which are not the leftmost or rightmost borders).
SetTableBorderLeft	None	Sets the border which will be displayed on the left of the current table.
SetTableBorderRight	None	Sets the border which will be displayed on the right of the current table.
SetTableBorderTop	None	Sets the border which will be displayed at the top of the current table.
SetTableCellMarginBottom	None	Specifies an amount of space which will be left between the bottom extent of the cell contents and the border\ of all table cells within the parent table (or table row).
SetTableCellMarginLeft	None	Specifies an amount of space which will be left between the left extent of the cell contents and the left\ border of all table cells within the parent table (or table row).
SetTableCellMarginRight	None	Specifies an amount of space which will be left between the right extent of the cell contents and the right\ border of all table cells within the parent table (or table row).
SetTableCellMarginTop	None	Specifies an amount of space which will be left between the top extent of the cell contents and the top border\ of all table cells within the parent table (or table row).
SetTableDescription	boolean	Sets the table description.
SetTableInd	None	Specifies the indentation which will be added before the leading edge of the current table in the document\ (the left edge in the left-to-right table, and the right edge in the right-to-left table).
SetTableLayout	None	Specifies the algorithm which will be used to lay out the contents of the current table within the document.
SetTableLook	None	Specifies the conditional formatting components of the referenced table style (if one exists) \ which will be applied to the set of table rows with the current table-level property exceptions. A table style \ can specify up to six different optional conditional formats, for example, different formatting for the first column, \ which then can be applied or omitted from individual table rows in the parent table.\ \ The default setting is to apply the row and column band formatting, but not the first row, last row, first \ column, or last column formatting.
SetTableTitle	boolean	Sets the table title (caption).
SetTextPr	boolean	Applies the text settings to the entire contents of the table.
SetVAlign	boolean	Sets the vertical alignment to the table.
SetWidth	None	Sets the preferred width to the current table.\ 💡 Tables are created with the ApiTable#SetWidth method properties set by default, which always override the ApiTablePr#SetWidth method properties. That is why there is no use to try and apply ApiTablePr#SetWidth. We recommend you to use the ApiTablePr#SetWidth method instead.
SetWrappingStyle	boolean	Sets the table wrapping style.
Split	ApiTable | null	Splits the cell into a given number of rows and columns.
ToJSON	JSON	Converts the ApiTable object into the JSON object.
ToJSON	JSON	Converts the ApiTablePr object into the JSON object.