Adobe InDesign CS6 Server (8.0) Object Model JS: Table

InDesign Server CS6

previous page next page

Class

Table

A table.

QuickLinks

addEventListener, autoTag, changeGlyph, changeGrep, changeText, changeTransliterate, clearTableStyleOverrides, convertBulletsAndNumberingToText, convertToText, createOutlines, extractLabel, findGlyph, findGrep, findText, findTransliterate, getElements, insertLabel, markup, recompose, remove, removeEventListener, toSource, toSpecifier, unmerge

Hierarchy

Table

Properties

Property	Type	Access	Description
allGraphics	Array of Graphic	readonly	Lists all graphics contained by the Table.
allPageItems	Array of PageItem	readonly	Lists all page items contained by the Table.
alternatingFills	AlternatingFillsTypes: AlternatingFillsTypes.NO_ALTERNATING_PATTERN AlternatingFillsTypes.ALTERNATING_ROWS AlternatingFillsTypes.ALTERNATING_COLUMNS	r/w	The pattern for alternating fills.
appliedTableStyle	String TableStyle	r/w	The table style applied to the table. Can also accept: String.
associatedXMLElement	XMLItem	readonly	The XML element associated with the Table.
bodyRowCount	number (range: 1 - 10000)	r/w	The number of body rows.
bottomBorderStrokeColor	Swatch	r/w	The color, specified as a swatch (color, gradient, tint, or mixed ink), of the bottom border stroke.
bottomBorderStrokeGapColor	Swatch	r/w	The gap color, specified as a swatch (color, gradient, tint, or mixed ink), of the bottom border stroke. Note: Valid only when bottom border stroke type is not solid.
bottomBorderStrokeGapOverprint	bool	r/w	If true, the gap of the bottom border stroke will overprint. Note: Valid only when bottom border stroke type is not solid.
bottomBorderStrokeGapTint	number	r/w	The tint (as a percentage) of the gap color of the bottom border stroke. (Range: 0 to 100) Note: Valid only when bottom border stroke type is not solid.
bottomBorderStrokeOverprint	bool	r/w	If true, the bottom border stroke will overprint.
bottomBorderStrokeTint	number	r/w	The tint (as a percentage) of the bottom border stroke. (Range: 0 to 100)
bottomBorderStrokeType	String StrokeStyle	r/w	The stroke type of the bottom border. Can also accept: String.
bottomBorderStrokeWeight	Measurement Unit (Number or String)	r/w	The stroke weight of the bottom border stroke.
breakFooters	HeaderFooterBreakTypes: HeaderFooterBreakTypes.IN_ALL_TEXT_COLUMNS HeaderFooterBreakTypes.ONCE_PER_TEXT_FRAME HeaderFooterBreakTypes.ONCE_PER_PAGE	r/w	The footer placement.
breakHeaders	HeaderFooterBreakTypes: HeaderFooterBreakTypes.IN_ALL_TEXT_COLUMNS HeaderFooterBreakTypes.ONCE_PER_TEXT_FRAME HeaderFooterBreakTypes.ONCE_PER_PAGE	r/w	The header placement.
buttons	Buttons Button	readonly	A collection of buttons.
cells	Cells Cell	readonly	A collection of table cells.
changes	Changes Change	readonly	A collection of changes.
checkBoxes	CheckBoxes	readonly	A collection of checkboxes.
columnCount	number (range: 1 - 200)	r/w	The number of columns.
columnFillsPriority	bool	r/w	If true, hides alternating row fills. If false, hides alternating column fills.
columns	Columns Column	readonly	A collection of table columns.
comboBoxes	ComboBoxes	readonly	A collection of comboboxes.
contents	Array of SpecialCharacters Strings	r/w	The contents to place in cells, specified as an array whose first item populates the top left cell and whose second item populates the next cell to the right, and so on until each cell in the top row is populated, at which point the next item populates the left-most cell in the second row, and so on. Note: If the array contains fewer strings than the table contains cells, the remaining cells are left blank. Can return: Array of Strings or SpecialCharacters enumerators. Can also accept: Array of Strings, SpecialCharacters enumerators or NothingEnum enumerators.
displayCollapsed	bool	r/w	If true, then the table will show collapsed in story and galley views.
displayOrder	DisplayOrderOptions: DisplayOrderOptions.ORDER_BY_ROWS DisplayOrderOptions.ORDER_BY_COLUMNS	r/w	Specifies the order the table cells will display in when viewing in story and galley views.
endColumnFillColor	Swatch	r/w	The fill color, specified as a swatch (color, gradient, tint, or mixed ink), of columns in the second alternating fill group. Note: Valid when alternating fills are defined for table columns.
endColumnFillCount	number	r/w	The number of columns in the second alternating fills group. Note: Valid when alternating fills are defined for table columns.
endColumnFillOverprint	bool	r/w	If true, the columns in the second alternating fills group will overprint. Note: Valid when alternating fills are defined for table columns.
endColumnFillTint	number	r/w	The tint (as a percentage) of the columns in the second alternating fills group. (Range: 0 to 100) Note: Valid when alternating fills are defined for table columns.
endColumnLineStyle	String StrokeStyle	r/w	The stroke type of columns in the second alternating strokes group. Can also accept: String.
endColumnStrokeColor	Swatch	r/w	The stroke color, specified as a swatch (color, gradient, tint, or mixed ink), of column borders in the second alternating column strokes group. Note: Valid when end column stroke count is 1 or greater.
endColumnStrokeCount	number	r/w	The number of columns in the second alternating column strokes group.
endColumnStrokeGapColor	Swatch	r/w	The stroke gap color, specified as a swatch (color, gradient, tint, or mixed ink), of column borders in the second alternating column strokes group. Note: Valid when end column stroke count is 1 or greater.
endColumnStrokeGapOverprint	bool	r/w	If true, the gap of the column border stroke in the second alternating column strokes group will overprint. Note: Valid when end column stroke count is 1 or greater.
endColumnStrokeGapTint	number	r/w	The tint (as a percentage) of the gap color of column borders in the second alternating column strokes group. (Range: 0 to 100) Note: Valid when end column stroke count is 1 or greater.
endColumnStrokeOverprint	bool	r/w	If true, the column borders in the second alternating column strokes group will overprint. Note: Valid when end column stroke count is 1 or greater.
endColumnStrokeTint	number	r/w	The tint (as a percentage) of column borders in the second alternating column strokes group. (Range: 0 to 100) Note: Valid when end column stroke count is 1 or greater.
endColumnStrokeWeight	Measurement Unit (Number or String)	r/w	The stroke weight of column borders in the second alternating column strokes group. Note: Valid when end column stroke count is 1 or greater.
endRowFillColor	Swatch	r/w	The fill color, specified as a swatch (color, gradient, tint, or mixed ink), of rows in the second alternating fills group. Note: Valid when alternating fills are defined for table rows.
endRowFillCount	number	r/w	The number of rows in the second alternating fills group. Note: Valid when alternating fills are defined for table rows.
endRowFillOverprint	bool	r/w	If true, the rows in the second alternating fills group will overprint. Note: Valid when alternating fills are defined for table rows.
endRowFillTint	number	r/w	The tint (as a percentage) of the rows in the second alternating fills group. (Range: 0 to 100) Note: Valid when alternating fills are defined for table rows.
endRowStrokeColor	Swatch	r/w	The stroke color, specified as a swatch (color, gradient, tint, or mixed ink), of row borders in the second alternating row strokes group. Note: Valid when end row stroke count is 1 or greater.
endRowStrokeCount	number	r/w	The number of rows in the second alternating row strokes group.
endRowStrokeGapColor	Swatch	r/w	The gap color, specified as a swatch (color, gradient, tint, or mixed ink), of row borders in the second alternating rows group. Note: Valid when end row stroke count is 1 or greater.
endRowStrokeGapOverprint	bool	r/w	If true, the gap of the row borders in the second alternating rows group will overprint. Note: Valid when end row stroke count is 1 or greater.
endRowStrokeGapTint	number	r/w	The tint (as a percentage) of the gap color of rows in the second alternating strokes group. (Range: 0 to 100) Note: Valid when end row stroke count is 1 or greater and end row stroke type is not solid.
endRowStrokeOverprint	bool	r/w	If true, the rows in the second alternating rows group will overprint. Note: Valid when end row stroke count is 1 or greater.
endRowStrokeTint	number	r/w	The tint (as a percentage) of the row borders in the second alternating strokes group. (Range: 0 to 100) Note: Valid when end row stroke count is 1 or greater.
endRowStrokeType	String StrokeStyle	r/w	The stroke type of rows in the second alternating strokes group. Can also accept: String.
endRowStrokeWeight	Measurement Unit (Number or String)	r/w	The stroke weight of row borders in the second alternating row strokes group. Note: Valid when end row stroke count is 1 or greater.
epstexts	EPSTexts EPSText	readonly	EPSTexts
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
footerRowCount	number (range: 0 - 25)	r/w	The number of footer rows.
formFields	FormFields FormField	readonly	A collection of form fields.
graphicLines	GraphicLines GraphicLine	readonly	A collection of graphic lines.
groups	Groups Group	readonly	A collection of groups.
headerRowCount	number (range: 0 - 25)	r/w	The number of header rows.
height	Measurement Unit (Number or String)	r/w	The height of the Table. For a table or column, specifies the sum of the row heights.
hiddenTexts	HiddenTexts HiddenText	readonly	A collection of hidden text objects.
id	number	readonly	The unique ID of the Table.
index	number	readonly	The index of the Table within its containing object.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
label	string	r/w	A property that can be set to any string.
leftBorderStrokeColor	Swatch	r/w	The color, specified as a swatch (color, gradient, tint, or mixed ink), of the left border stroke.
leftBorderStrokeGapColor	Swatch	r/w	The gap color, specified as a swatch (color, gradient, tint, or mixed ink), of the left border stroke. Note: Valid only when left border stroke type is not solid.
leftBorderStrokeGapOverprint	bool	r/w	If true, the gap of the left border stroke will overprint. Note: Valid only when left border stroke type is not solid.
leftBorderStrokeGapTint	number	r/w	The tint (as a percentage) of the gap color of the left border stroke. (Range: 0 to 100) Note: Valid only when left border stroke type is not solid.
leftBorderStrokeOverprint	bool	r/w	If true, the left border stroke will overprint.
leftBorderStrokeTint	number	r/w	The tint (as a percentage) of the left border stroke. (Range: 0 to 100)
leftBorderStrokeType	String StrokeStyle	r/w	The stroke type of the left border. Can also accept: String.
leftBorderStrokeWeight	Measurement Unit (Number or String)	r/w	The stroke weight of the left border stroke.
listBoxes	ListBoxes	readonly	A collection of listboxes.
multiStateObjects	MultiStateObjects MultiStateObject	readonly	A collection of multi-state objects.
name	string	r/w	The name of the Table; this is an alias to the Table's label property.
notes	Notes Note	readonly	A collection of notes.
ovals	Ovals Oval	readonly	A collection of ellipses.
pageItems	PageItems PageItem	readonly	The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type.
parent	Cell Character InsertionPoint Line Paragraph Story Text TextColumn TextFrame TextStyleRange Word XMLElement XmlStory	readonly	The parent of the Table (a XMLElement, XmlStory, TextFrame, Text, InsertionPoint, TextStyleRange, Paragraph, TextColumn, Line, Word, Character, Story or Cell).
polygons	Polygons Polygon	readonly	A collection of polygons.
properties	Object	r/w	A property that allows setting of several properties at the same time.
radioButtons	RadioButtons RadioButton	readonly	A collection of radio buttons.
rectangles	Rectangles Rectangle	readonly	A collection of rectangles.
rightBorderStrokeColor	Swatch	r/w	The color, specified as a swatch (color, gradient, tint, or mixed ink), of the right border stroke.
rightBorderStrokeGapColor	Swatch	r/w	The gap color, specified as a swatch (color, gradient, tint, or mixed ink), of the right border stroke. Note: Valid only when right border stroke type is not solid.
rightBorderStrokeGapOverprint	bool	r/w	If true, the gap color of the right border stroke will overprint. Note: Valid only when right border stroke type is not solid.
rightBorderStrokeGapTint	number	r/w	The tint (as a percentage) of the gap color of the right border stroke. (Range: 0 to 100) Note: Valid only when right border stroke type is not solid.
rightBorderStrokeOverprint	bool	r/w	If true, the right border stroke will overprint.
rightBorderStrokeTint	number	r/w	The tint (as a percentage) of the right border stroke. (Range: 0 to 100)
rightBorderStrokeType	String StrokeStyle	r/w	The stroke type of the right border. Can also accept: String.
rightBorderStrokeWeight	Measurement Unit (Number or String)	r/w	The stroke weight of the right border stroke.
rows	Rows Row	readonly	A collection of table rows.
signatureFields	SignatureFields SignatureField	readonly	A collection of signature fields.
skipFirstAlternatingFillColumns	number	r/w	The number of columns on the left side of the table to skip before applying the column fill color. Note: Valid when alternating fills are defined for table columns.
skipFirstAlternatingFillRows	number	r/w	The number of body rows at the beginning of the table to skip before applying the row fill color. Note: Valid when alternating fills are defined for table rows.
skipFirstAlternatingStrokeColumns	number	r/w	The number of columns on the left of the table in which to skip border stroke formatting. Note: Valid when start column stroke count is 1 or greater and/or end column stroke count is 1 or greater.
skipFirstAlternatingStrokeRows	number	r/w	The number of body rows at the beginning of the table in which to skip border stroke formatting. Note: Valid when start row stroke count is 1 or greater and/or end row stroke count is 1 or greater.
skipFirstHeader	bool	r/w	If true, skips the first occurrence of header rows.
skipLastAlternatingFillColumns	number	r/w	The number columns on the right side of the table in which to not apply the column fill color. Note: Valid when alternating fills are defined for table columns.
skipLastAlternatingFillRows	number	r/w	The number of body rows at the end of the table in which to not apply the row fill color. Note: Valid when alternating fills are defined for table rows.
skipLastAlternatingStrokeColumns	number	r/w	The number of columns on the right side of the table in which to skip border stroke formatting. Note: Valid when start column stroke count is 1 or greater and/or end column stroke count is 1 or greater.
skipLastAlternatingStrokeRows	number	r/w	The number of body rows at the end of the table in which to skip border stroke formatting. Note: Valid when start row stroke count is 1 or greater and/or end row stroke count is 1 or greater.
skipLastFooter	bool	r/w	If true, skips the last occurrence of footer rows.
spaceAfter	Measurement Unit (Number or String)	r/w	The space below the table.
spaceBefore	Measurement Unit (Number or String)	r/w	The space above the table.
splineItems	SplineItems SplineItem	readonly	The spline items collection.
startColumnFillColor	Swatch	r/w	The fill color, specified as a swatch (color, gradient, tint, or mixed ink), of columns in the first alternating fills group. Note: Valid when alternating fills are defined for table columns.
startColumnFillCount	number	r/w	The number of columns in the first alternating fills group. Note: Valid when alternating fills are defined for table columns.
startColumnFillOverprint	bool	r/w	If true, the columns in the first alternating fills group will overprint. Note: Valid when alternating fills are defined for table columns.
startColumnFillTint	number	r/w	The tint (as a percentage) of the columns in the first alternating fills group. (Range: 0 to 100) Note: Valid when alternating fills are defined for table columns.
startColumnStrokeColor	Swatch	r/w	The stroke color, specified as a swatch (color, gradient, tint, or mixed ink), of column borders in the first alternating column strokes group.
startColumnStrokeCount	number	r/w	The number of columns in the first alternating column strokes group.
startColumnStrokeGapColor	Swatch	r/w	The stroke gap color, specified as a swatch (color, gradient, tint, or mixed ink), of column borders in the first alternating column strokes group. Note: Valid when start column stroke count is 1 or greater.
startColumnStrokeGapOverprint	bool	r/w	If true, the gap of the column borders in the first alternating column strokes group will overprint. Note: Valid when start column stroke count is 1 or greater.
startColumnStrokeGapTint	number	r/w	The tint (as a percentage) of the gap color of column borders in the first alternating column strokes group. (Range: 0 to 100) Note: Valid when start column stroke count is 1 or greater.
startColumnStrokeOverprint	bool	r/w	If true, the column borders in the first alternating column strokes group will overprint. Note: Valid when start column stroke count is 1 or greater.
startColumnStrokeTint	number	r/w	The tint (as a percentage) of column borders in the first alternating column strokes group. (Range: 0 to 100) Note: Valid when start column stroke count is 1 or greater.
startColumnStrokeType	String StrokeStyle	r/w	The stroke type of columns in the first alternating strokes group. Can also accept: String.
startColumnStrokeWeight	Measurement Unit (Number or String)	r/w	The stroke weight of column borders in the first alternating column strokes group. Note: Valid when start column stroke count is 1 or greater.
startRowFillColor	Swatch	r/w	The fill color, specified as a swatch (color, gradient, tint, or mixed ink), of rows in the first alternating fills group. Note: Valid when alternating fills are defined for table rows.
startRowFillCount	number	r/w	The number of rows in the first alternating fills group. Note: Valid when alternating fills are defined for table rows.
startRowFillOverprint	bool	r/w	If true, the rows in the first alternating fills group will overprint. Note: Valid when alternating fills are defined for table rows.
startRowFillTint	number	r/w	The tint (as a percentage) of the rows in the first alternating fills group. (Range: 0 to 100) Note: Valid when alternating fills are defined for table rows.
startRowStrokeColor	Swatch	r/w	The color, specified as a swatch (color, gradient, tint, or mixed ink), of row borders in the first alternating row strokes group. Note: Valid when start row stroke count is 1 or greater.
startRowStrokeCount	number	r/w	The number of rows in the first alternating row strokes group.
startRowStrokeGapColor	Swatch	r/w	The stroke gap color of row borders in the first alternating row strokes group, specified as a swatch (color, gradient, tint, or mixed ink). Note: Valid when start row stroke count is 1 or greater.
startRowStrokeGapOverprint	bool	r/w	If true, the gap color of the row border stroke in the first alternating row strokes group will overprint. Note: Valid when start row stroke count is 1 or greater.
startRowStrokeGapTint	number	r/w	The tint (as a percentage) of the gap color of row borders in the first alternating rows group. (Range: 0 to 100) Note: Valid when start row stroke count is 1 or greater.
startRowStrokeOverprint	bool	r/w	If true, the row borders in the first alternating row strokes group will overprint. Note: Valid when start row stroke count is 1 or greater.
startRowStrokeTint	number	r/w	The tint (as a percentage) of the borders in the first alternating row strokes group. (Range: 0 to 100) Note: Valid when start row stroke count is 1 or greater.
startRowStrokeType	String StrokeStyle	r/w	The stroke type of rows in the first alternating strokes group. Can also accept: String.
startRowStrokeWeight	Measurement Unit (Number or String)	r/w	The stroke weight of row borders in the first alternating row strokes group. Note: Valid when start row stroke count is 1 or greater.
storyOffset	InsertionPoint	readonly	The insertion point before the table in the story containing the table.
strokeOrder	StrokeOrderTypes: StrokeOrderTypes.ROW_ON_TOP StrokeOrderTypes.COLUMN_ON_TOP StrokeOrderTypes.BEST_JOINS StrokeOrderTypes.INDESIGN_2_COMPATIBILITY	r/w	The order in which to display row and column strokes at corners.
tableDirection	TableDirectionOptions: TableDirectionOptions.LEFT_TO_RIGHT_DIRECTION TableDirectionOptions.RIGHT_TO_LEFT_DIRECTION	r/w	The direction of the the table
textBoxes	TextBoxes	readonly	A collection of text boxes.
textFrames	TextFrames TextFrame	readonly	A collection of text frames.
textVariableInstances	TextVariableInstances TextVariableInstance	readonly	A collection of text variable instances.
topBorderStrokeColor	Swatch	r/w	The color, specified as a swatch (color, gradient, tint, or mixed ink), of the table's top border stroke.
topBorderStrokeGapColor	Swatch	r/w	The gap color, specified as a swatch (color, gradient, tint, or mixed ink), of the table's top border stroke. Note: Valid only when top border stroke type is not solid.
topBorderStrokeGapOverprint	bool	r/w	If true, the gap of the top border stroke will overprint. Note: Valid only when top border stroke type is not solid.
topBorderStrokeGapTint	number	r/w	The tint (as a percentage) of the gap color of the table's top border stroke. (Range: 0 to 100) Note: Valid only when top border stroke type is not solid.
topBorderStrokeOverprint	bool	r/w	If true, the top border strokes will overprint.
topBorderStrokeTint	number	r/w	The tint (as a percentage) of the table's top border stroke. (Range: 0 to 100)
topBorderStrokeType	String StrokeStyle	r/w	The stroke type of the top border. Can also accept: String.
topBorderStrokeWeight	Measurement Unit (Number or String)	r/w	The stroke weight of the table's top border stroke.
width	Measurement Unit (Number or String)	r/w	The width of the Table. For a table or row, specifies the sum of the column widths.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

void autoTag ()
Tag the object or the parent story using default tags defined in XML preference.

Array of Text changeGlyph ([reverseOrder: bool])
Finds glyphs that match the find what value and replaces the glyphs with the change to value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of Text changeGrep ([reverseOrder: bool])
Finds text that matches the find what value and replaces the text with the change to value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of Text changeText ([reverseOrder: bool])
Finds text that matches the find what value and replaces the text with the change to value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of Text changeTransliterate ([reverseOrder: bool])
Finds text that matches the find character type value and replaces the text with the change character type value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

void clearTableStyleOverrides ()
Clear Table Style Overrides

void convertBulletsAndNumberingToText ()
Convert bullets and numbering to text.

Text convertToText ([columnSeparator: string][, rowSeparator: string])
Converts the table to text.

Parameter	Type	Description
columnSeparator	string	The character to insert between the each column's content in the converted text. Note: Can be defined as any single character, such as a letter, number, or punctuation mark, or by typing a space or tab. Use the actual character rather than its name, such as ',' rather than 'Comma'. Precede double or single quotes or a backslash with an extra backslash as an escape character. For paragraphs, use ^p. (Optional)
rowSeparator	string	The character to use to separate each row's content in the converted text. Note: Can be defined as any single character, such as a letter, number, or punctuation mark, or by typing a space or tab. Use the actual character rather than its name, such as , rather than Comma. Precede double or single quotes or a backslash with an extra backslash as an escape character. For paragraphs, use ^p. (Optional)

Array of PageItem createOutlines ([deleteOriginal: bool=true])
Converts text to outlines. Each line of text becomes a polygon object. When the converted text is a single letter that has no internal spaces or detached parts, the polygon contains only a single path. Note: To determine whether a font allows the creation of outlines, see allow outlines.

Parameter	Type	Description
deleteOriginal	bool	If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional) (default: true)

string extractLabel (key: string)
Gets the label value associated with the specified key.

Parameter	Type	Description
key	string	The key.

Array of Text findGlyph ([reverseOrder: bool])
Finds glyphs that match the find what value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of Text findGrep ([reverseOrder: bool])
Finds text that matches the find what value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of Text findText ([reverseOrder: bool])
Finds text that matches the find what value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of Text findTransliterate ([reverseOrder: bool])
Finds text that matches the find character type value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of Table getElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

Parameter	Type	Description
key	string	The key.
value	string	The value.

void markup (using: XMLElement)
Associates the page item with the specified XML element while preserving existing content.

Parameter	Type	Description
using	XMLElement	The XML element.

void recompose ()
Recomposes the text in the Table.

void remove ()
Deletes the Table.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

string toSource ()
Generates a string which, if executed, will return the Table.

string toSpecifier ()
Retrieves the object specifier.

Array of Cell unmerge ()
Unmerges all merged cells in the Table.

Element of

Column.parent

Row.parent

XMLElement.xmlContent

Used in:

Table Tables.nextItem (obj: Table)

Table Tables.previousItem (obj: Table)

Return

Table Character.convertToTable ([columnSeparator: string][, rowSeparator: string][, numberOfColumns: number=1])

Table InsertionPoint.convertToTable ([columnSeparator: string][, rowSeparator: string][, numberOfColumns: number=1])

Table Line.convertToTable ([columnSeparator: string][, rowSeparator: string][, numberOfColumns: number=1])

Table Paragraph.convertToTable ([columnSeparator: string][, rowSeparator: string][, numberOfColumns: number=1])

Array of Table Table.getElements ()

Table Tables.[] (index: number)

Table Tables.add ([to: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])

Table Tables.anyItem ()

Array of Table Tables.everyItem ()

Table Tables.firstItem ()

Table Tables.item (index: varies)

Table Tables.itemByID (id: number)

Table Tables.itemByName (name: string)

Array of Table Tables.itemByRange (from: varies, to: varies)

Table Tables.lastItem ()

Table Tables.middleItem ()

Table Tables.nextItem (obj: Table)

Table Tables.previousItem (obj: Table)

Table Text.convertToTable ([columnSeparator: string][, rowSeparator: string][, numberOfColumns: number=1])

Table TextColumn.convertToTable ([columnSeparator: string][, rowSeparator: string][, numberOfColumns: number=1])

Table TextStyleRange.convertToTable ([columnSeparator: string][, rowSeparator: string][, numberOfColumns: number=1])

Table Word.convertToTable ([columnSeparator: string][, rowSeparator: string][, numberOfColumns: number=1])

Table XMLElement.convertElementToTable (rowTag: XMLTag, cellTag: XMLTag)

Jongware, 28-Apr-2012 v3.0.3i

Contents :: Index

previous page start next page