table

A table in a story.

table elements

Name	Refer to By
buttons	by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID
cells	by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID
columns	by numeric index, as a range of elements, before/after another element, satisfying a test
form fields	by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID
graphic lines	by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID
groups	by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID
ovals	by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID
page items	by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID
polygons	by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID
rectangles	by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID
rows	by numeric index, as a range of elements, before/after another element, satisfying a test
text frames	by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID

table properties

Property	Type	Access	Description
all graphics	list of graphics	read	All graphics contained by the object.
all page items	list of page items	read	All page items contained by the object.
alternating fills	alternating fills types enumeration	r/w	What alternating fills pattern we use.
associated XML element	XML item	read	The XML element associated with the object.
body row count	integer (1 – 10000)	r/w	Number of table body rows.
bottom border stroke color	swatch	r/w	The color of the table’s bottom border.
bottom border stroke gap color	swatch	r/w	The gap color of the table’s bottom border.
bottom border stroke gap overprint	boolean	r/w	Whether to overprint the gap of the table’s bottom border.
bottom border stroke gap tint	fixed	r/w	The gap tint of the gap color of the table’s bottom border.
bottom border stroke overprint	boolean	r/w	Whether to overprint the table’s bottom border.
bottom border stroke tint	fixed	r/w	The tint of the color of the table’s bottom border.
bottom border stroke type	stroke style	r/w	The stroke type of the table’s bottom border.
bottom border stroke weight	number or string	r/w	The stroke weight of the table’s bottom border.
break footers	header footer break types enumeration	r/w	Where to put the footers.
break headers	header footer break types enumeration	r/w	Where to put the headers.
class	integer	read	The class descriptor type.
column count	integer (1 – 100)	r/w	The number of columns.
column fills priority	boolean	r/w	Whether to disaply column alternating fills or row alternating fills.
contents	list of strings or auto page number/next page number/previous page number/section marker/bullet character/copyright symbol/degree symbol/ellipsis character/forced line break/paragraph symbol/registered trademark/section symbol/trademark symbol/right indent tab/indent here tab/Em dash/En dash/discretionary hyphen/nonbreaking hyphen/end nested style/double left quote/double right quote/single left quote/single right quote/Em space/En space/ﬂush space/hair space/nonbreaking space/thin space/figure space/punctuation space/column break/frame break/page break/odd page break/	r/w	The text contents.
end column fill color	swatch	r/w	The fill color of columns in the second alternating fill group.
end column fill count	integer	r/w	The number of columns in the second alternating fills group.
end column fill overprint	boolean	r/w	Whether to overprint the columns in the second alternating fills group.
end column fill tint	fixed	r/w	The tint of the color of columns in the second alternating fills group.
end column line style	stroke style	r/w	The stroke type of columns in the second alternating strokes group.
end column stroke color	swatch	r/w	The stroke color of columns in the second alternating strokes group.
end column stroke count	integer	r/w	The number of columns in the second alternating strokes group.
end column stroke gap color	swatch	r/w	The stroke gap color of columns in the second alternating strokes group.
end column stroke gap overprint	boolean	r/w	Whether to overprint the gap of the columns in the second alternating strokes group.
end column stroke gap tint	fixed	r/w	The gap tint of the gap color of columns in the second alternating strokes group.
end column stroke overprint	boolean	r/w	Whether to overprint the columns in the second alternating strokes group.
end column stroke tint	fixed	r/w	The tint of the color of columns in the second alternating strokes group.
end column stroke weight	number or string	r/w	The stroke weight of columns in the second alternating strokes group.
end row fill color	swatch	r/w	The fill color of rows in the second alternating fills group.
end row fill count	integer	r/w	The number of rows in the second alternating fills group.
end row fill overprint	boolean	r/w	Whether to overprint the rows in the second alternating fills group.
end row fill tint	fixed	r/w	The tint of the color of rows in the second alternating fills group.
end row stroke color	swatch	r/w	The stroke color of rows in the second alternating strokes group.
end row stroke count	integer	r/w	The number of rows in the second alternating strokes group.
end row stroke gap color	swatch	r/w	The stroke gap color of rows in the second alternating strokes group.
end row stroke gap overprint	boolean	r/w	Whether to overprint the gap of the rows in the second alternating strokes group.
end row stroke gap tint	fixed	r/w	The gap tint of the gap color of rows in the second alternating strokes group.
end row stroke overprint	boolean	r/w	Whether to overprint the rows in the second alternating strokes group.
end row stroke tint	fixed	r/w	The tint of the color of rows in the second alternating strokes group.
end row stroke type	stroke style	r/w	The stroke type of rows in the second alternating strokes group.
end row stroke weight	number or string	r/w	The stroke weight of rows in the second alternating strokes group.
footer row count	integer (0 – 25)	r/w	Number of table footer rows.
header row count	integer (0 – 25)	r/w	Number of table header rows.
height	number or string	r/w	The height of the object.
id	integer	read	A unique number identifying the object.
index	integer	read	Index of the object within its parent object.
label	string	r/w	A label that can be set to any string.
left border stroke color	swatch	r/w	The color of the table’s left border.
left border stroke gap color	swatch	r/w	The gap color of the table’s left border.
left border stroke gap overprint	boolean	r/w	Whether to overprint the gap of the table’s left border.
left border stroke gap tint	fixed	r/w	The gap tint of the gap color of the table’s left border.
left border stroke overprint	boolean	r/w	Whether to overprint the table’s left border.
left border stroke tint	fixed	r/w	The tint of the color of the table’s left border.
left border stroke type	stroke style	r/w	The stroke type of the table’s left border.
left border stroke weight	number or string	r/w	The stroke weight of the table’s left border.
object reference	object	read	An object reference for this object.
parent	object	read	The parent of the object.
properties	record	r/w	Property that allows setting of several properties at the same time.
right border stroke color	swatch	r/w	The color of the table’s right border.
right border stroke gap color	swatch	r/w	The gap color of the table’s right border.
right border stroke gap overprint	boolean	r/w	Whether to overprint the gap of the table’s right border.
right border stroke gap tint	fixed	r/w	The gap tint of the color of the table’s right border.
right border stroke overprint	boolean	r/w	Whether to overprint the table’s right border.
right border stroke tint	fixed	r/w	The tint of the color of the table’s right border.
right border stroke type	stroke style	r/w	The stroke type of the table’s right border.
right border stroke weight	number or string	r/w	The stroke weight of the table’s right border.
skip first alternating fill columns	integer	r/w	The number of first columns to skip when alternating fills.
skip first alternating fill rows	integer	r/w	The number of first rows to skip when alternating fills.
skip first alternating stroke columns	integer	r/w	The number of first columns to skip when alternating strokes.
skip first alternating stroke rows	integer	r/w	The number of first rows to skip when alternating strokes.
skip first header	boolean	r/w	Whether to skip the first occurrence of the headers.
skip last alternating fill columns	integer	r/w	The number of last columns to skip when alternating fills.
skip last alternating fill rows	integer	r/w	The number of last rows to skip when alternating fills.
skip last alternating stroke columns	integer	r/w	The number of last columns to skip when alternating strokes.
skip last alternating stroke rows	integer	r/w	The number of last rows to skip when alternating strokes.
skip last footer	boolean	r/w	Whether to skip the last occurrence of the footers.
space after	number or string	r/w	Paragraph space after.
space before	number or string	r/w	Paragraph space before.
start column fill color	swatch	r/w	The fill color of columns in the first alternating fills group.
start column fill count	integer	r/w	The number of columns in the first alternating fills group.
start column fill overprint	boolean	r/w	Whether to overprint the columns in the first alternating fills group.
start column fill tint	fixed	r/w	The tint of the color of columns in the first alternating fills group.
start column stroke color	swatch	r/w	The stroke color of columns in the first alternating strokes group.
start column stroke count	integer	r/w	The number of columns in the first alternating strokes group.
start column stroke gap color	swatch	r/w	The stroke gap color of columns in the first alternating strokes group.
start column stroke gap overprint	boolean	r/w	Whether to overprint the gap of the columns in the first alternating strokes group.
start column stroke gap tint	fixed	r/w	The gap tint of the gap color of columns in the first alternating strokes group.
start column stroke overprint	boolean	r/w	Whether to overprint the columns in the first alternating strokes group.
start column stroke tint	fixed	r/w	The tint of the color of columns in the first alternating strokes group.
start column stroke type	stroke style	r/w	The stroke type of columns in the first alternating strokes group.
start column stroke weight	number or string	r/w	The stroke weight of columns in the first alternating strokes group.
start row fill color	swatch	r/w	The fill color of rows in the first alternating fills group.
start row fill count	integer	r/w	The number of rows in the first alternating fills group.
start row fill overprint	boolean	r/w	Whether to overprint the rows in the first alternating fills group.
start row fill tint	fixed	r/w	The tint of the color of rows in the first alternating fills group.
start row stroke color	swatch	r/w	The stroke color of rows in the first alternating strokes group.
start row stroke count	integer	r/w	The number of rows in the first alternating strokes group.
start row stroke gap color	swatch	r/w	The stroke gap color of rows in the first alternating strokes group.
start row stroke gap overprint	boolean	r/w	Whether to overprint the gap of the rows in the first alternating strokes group.
start row stroke gap tint	fixed	r/w	The gap tint of the gap color of rows in the first alternating strokes group.
start row stroke overprint	boolean	r/w	Whether to overprint the rows in the first alternating strokes group.
start row stroke tint	fixed	r/w	The tint of the color of rows in the first alternating strokes group.
start row stroke type	stroke style	r/w	The stroke type of rows in the first alternating strokes group.
start row stroke weight	number or string	r/w	The stroke weight of rows in the first alternating strokes group.
story offset	integer	read	The location of the object from the beginning of the story.
stroke order	stroke order types enumeration	r/w	Whether to draw rows on top, columns on top, best joins, or InDesign 2.0 compatibility.
top border stroke color	swatch	r/w	The color of the table’s top border.
top border stroke gap color	swatch	r/w	The gap color of the table’s top border.
top border stroke gap overprint	boolean	r/w	Whether to overprint the gap of the table’s top border.
top border stroke gap tint	fixed	r/w	The gap tint of the gap color of the table’s top border.
top border stroke overprint	boolean	r/w	Whether to overprint the table’s top border.
top border stroke tint	fixed	r/w	The tint of the color of the table’s top border.
top border stroke type	stroke style	r/w	The stroke type of the table’s top border.
top border stroke weight	number or string	r/w	The stroke weight of the top border of the table.
width	number or string	r/w	The width of the object.

table methods

Method	Returns	Description
convert bullets and numbering to text	Nothing	Converts bullets and numbering to text.
convert to text	text	Convert to text.
create outlines	list of page items	Create outlines from the text.
delete	Nothing	Delete the object.
extract label	string	Gets the content of the label associated with the specified key (name).
insert label	Nothing	Sets the content of the label associated with the specified key (name), creating the label if it does not already exist.
recompose	Nothing	Recomposes the text in the object.
search	list of texts	Searches for text and returns a list of text objects matching the search string and/or formatting specified by the find preferences. Search can also replace the text and/or formatting. This command corresponds to InDesign’s Find/Change feature.
select	Nothing	Selects the object.
unmerge	list of cells	Unmerge the cells.

Leave a Comment

Previous post: tagged text export preference

Next post: tab stop