Word JavaScript API requirement sets
Requirement sets are named groups of API members. Office Add-ins use requirement sets specified in the manifest or use a runtime check to determine whether an Office host supports APIs that an add-in needs. For more information, see Specify Office hosts and API requirements.
Word Add-ins run across multiple versions of Office, including Office 2016 for Windows, Office for iPad, Office for Mac, and Office Online. The following table lists the Word requirement sets, the Office host applications that support that requirement set, and the build or version numbers for those applications.
For the requirement sets that are marked as Beta, use the specified (or later) version of the Office software and use the Beta library of the CDN: https://appsforoffice.microsoft.com/lib/beta/hosted/office.js
Entires not listed as Beta are generally available and you can continue to use Production CDN library: https://appsforoffice.microsoft.com/lib/1/hosted/office.js
| Requirement set | Office 2016 for Windows* | Office 2016 for iPad | Office 2016 for Mac | Office Online | Office Online Server |
|---|---|---|---|---|---|
| WordApi 1.3 | Version 1612 (Build 7668.1000) or later | March 2017, 2.22 or later | March 2017, 15.32 or later | March 2017. | |
| WordApi 1.2 | December 2015 update, Version 1601 (Build 6568.1000) or later | January 2016, 1.18 or later | January 2016, 15.19 or later | September 2016 | |
| WordApi 1.1 | Version 1509 (Build 4266.1001) or later | January 2016, 1.18 or later | January 2016, 15.19 or later | September 2016 |
*Note: The build number for Office 2016 installed via MSI is 16.0.4266.1001. This version only contains the WordApi 1.1 requirement set.
To find out more about versions, build numbers, and Office Online Server, see:
- Version and build numbers of update channel releases for Office 365 clients
- What version of Office am I using?
- Where you can find the version and build number for an Office 365 client application
- Office Online Server overview
Office common API requirement sets
For information about common API requirement sets, see Office common API requirement sets.
What's new in Word JavaScript API 1.3
The following are the new additions to the Word JavaScript APIs in requirement set 1.3.
| Object | What's new | Description | Requirement set | |
|---|---|---|---|---|
| body | Relationship > lists | Gets the collection of list objects in the body. Read-only. | 1.3 | |
| body | Relationship > parentBody | Gets the parent body of the body. For example, a table cell body's parent body could be a header. Read-only. | 1.3 | |
| body | Relationship > parentSection | Gets the parent section of the body. Read-only. | 1.3 | |
| body | Relationship > styleBuiltIn | Gets or sets the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. | 1.3 | |
| body | Relationship > tables | Gets the collection of table objects in the body. Read-only. | 1.3 | |
| body | Relationship > type | Gets the type of the body. The type can be 'MainDoc', 'Section', 'Header', 'Footer', or 'TableCell'. Read-only. | 1.3 | |
| body | Method > getRange(rangeLocation: RangeLocation) | Gets the whole body, or the starting or ending point of the body, as a range. | 1.3 | |
| body | Method > insertTable(rowCount: number, columnCount: number, insertLocation: InsertLocation, values: string[][]) | Inserts a table with the specified number of rows and columns. The insertLocation value can be 'Start' or 'End'. | 1.3 | |
| contentControl | Relationship > lists | Gets the collection of list objects in the content control. Read-only. | 1.3 | |
| contentControl | Relationship > parentBody | Gets the parent body of the content control. Read-only. | 1.3 | |
| contentControl | Relationship > parentTable | Gets the table that contains the content control. Returns a null object if it is not contained in a table. Read-only. | 1.3 | |
| contentControl | Relationship > parentTableCell | Gets the table cell that contains the content control. Returns a null object if it is not contained in a table cell. Read-only. | 1.3 | |
| contentControl | Relationship > styleBuiltIn | Gets or sets the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. | 1.3 | |
| contentControl | Relationship > subtype | Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls. Read-only. | 1.3 | |
| contentControl | Relationship > tables | Gets the collection of table objects in the content control. Read-only. | 1.3 | |
| contentControl | Method > getRange(rangeLocation: RangeLocation) | Gets the whole content control, or the starting or ending point of the content control, as a range. | 1.3 | |
| contentControl | Method > getTextRanges(endingMarks: string[], trimSpacing: bool) | Gets the text ranges in the content control by using punctuation marks andor other ending marks. | 1.3 | |
| contentControl | Method > insertTable(rowCount: number, columnCount: number, insertLocation: InsertLocation, values: string[][]) | Inserts a table with the specified number of rows and columns into, or next to, a content control. The insertLocation value can be 'Start', 'End', 'Before' or 'After'. | 1.3 | |
| contentControl | Method > split(delimiters: string[], multiParagraphs: bool, trimDelimiters: bool, trimSpacing: bool) | Splits the content control into child ranges by using delimiters. | 1.3 | |
| contentControlCollection | Method > getByTypes(types: ContentControlType[]) | Gets the content controls that have the specified types andor subtypes. | 1.3 | |
| contentControlCollection | Method > getFirst() | Gets the first content control in this collection. | 1.3 | |
| customProperty | Property > key | Gets the key of the custom property. Read only. Read-only. | 1.3 | |
| customProperty | Property > value | Gets or sets the value of the custom property. | 1.3 | |
| customProperty | Relationship > type | Gets the value type of the custom property. Read only. Read-only. | 1.3 | |
| customProperty | Method > delete() | Deletes the custom property. | 1.3 | |
| customPropertyCollection | Property > items | A collection of customProperty objects. Read-only. | 1.3 | |
| customPropertyCollection | Method > deleteAll() | Deletes all custom properties in this collection. | 1.3 | |
| customPropertyCollection | Method > getCount() | Gets the count of custom properties. | 1.3 | |
| customPropertyCollection | Method > getItem(key: string) | Gets a custom property object by its key, which is case-insensitive. | 1.3 | |
| customPropertyCollection | Method > set(key: string, value: object) | Creates or sets a custom property. | 1.3 | |
| document | Relationship > properties | Gets the properties of the current document. Read-only. | 1.3 | |
| document | Method > open() | Open the document. | 1.3 | |
| documentProperties | Property > applicationName | Gets the application name of the document. Read only. Read-only. | 1.3 | |
| documentProperties | Property > author | Gets or sets the author of the document. | 1.3 | |
| documentProperties | Property > category | Gets or sets the category of the document. | 1.3 | |
| documentProperties | Property > comments | Gets or sets the comments of the document. | 1.3 | |
| documentProperties | Property > company | Gets or sets the company of the document. | 1.3 | |
| documentProperties | Property > format | Gets or sets the format of the document. | 1.3 | |
| documentProperties | Property > keywords | Gets or sets the keywords of the document. | 1.3 | |
| documentProperties | Property > lastAuthor | Gets or sets the last author of the document. | 1.3 | |
| documentProperties | Property > manager | Gets or sets the manager of the document. | 1.3 | |
| documentProperties | Property > revisionNumber | Gets the revision number of the document. Read only. Read-only. | 1.3 | |
| documentProperties | Property > security | Gets the security of the document. Read only. Read-only. | 1.3 | |
| documentProperties | Property > subject | Gets or sets the subject of the document. | 1.3 | |
| documentProperties | Property > template | Gets the template of the document. Read only. Read-only. | 1.3 | |
| documentProperties | Property > title | Gets or sets the title of the document. | 1.3 | |
| documentProperties | Relationship > creationDate | Gets the creation date of the document. Read only. Read-only. | 1.3 | |
| documentProperties | Relationship > customProperties | Gets the collection of custom properties of the document. Read only. Read-only. | 1.3 | |
| documentProperties | Relationship > lastPrintDate | Gets the last print date of the document. Read only. Read-only. | 1.3 | |
| documentProperties | Relationship > lastSaveTime | Gets the last save time of the document. Read only. Read-only. | 1.3 | |
| inlinePicture | Relationship > parentTable | Gets the table that contains the inline image. Returns a null object if it is not contained in a table. Read-only. | 1.3 | |
| inlinePicture | Relationship > parentTableCell | Gets the table cell that contains the inline image. Returns a null object if it is not contained in a table cell. Read-only. | 1.3 | |
| inlinePicture | Method > getNext() | Gets the next inline image. | 1.3 | |
| inlinePicture | Method > getRange(rangeLocation: RangeLocation) | Gets the picture, or the starting or ending point of the picture, as a range. | 1.3 | |
| inlinePictureCollection | Method > getFirst() | Gets the first inline image in this collection. | 1.3 | |
| list | Property > id | Gets the list's id. Read-only. | 1.3 | |
| list | Property > levelExistences | Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. Read-only. | 1.3 | |
| list | Relationship > levelTypes | Gets all 9 level types in the list. Each type can be 'Bullet', 'Number' or 'Picture'. Read-only. | 1.3 | |
| list | Relationship > paragraphs | Gets paragraphs in the list. Read-only. | 1.3 | |
| list | Method > getLevelParagraphs(level: number) | Gets the paragraphs that occur at the specified level in the list. | 1.3 | |
| list | Method > getLevelString(level: number) | Gets the bullet, number or picture at the specified level as a string. | 1.3 | |
| list | Method > insertParagraph(paragraphText: string, insertLocation: InsertLocation) | Inserts a paragraph at the specified location. The insertLocation value can be 'Start', 'End', 'Before' or 'After'. | 1.3 | |
| list | Method > setLevelAlignment(level: number, alignment: Alignment) | Sets the alignment of the bullet, number or picture at the specified level in the list. | 1.3 | |
| list | Method > setLevelBullet(level: number, listBullet: ListBullet, charCode: number, fontName: string) | Sets the bullet format at the specified level in the list. If the bullet is 'Custom', the charCode is required. | 1.3 | |
| list | Method > setLevelIndents(level: number, textIndent: float, textIndent: float) | Sets the two indents of the specified level in the list. | 1.3 | |
| list | Method > setLevelNumbering(level: number, listNumbering: ListNumbering, formatString: object[]) | Sets the numbering format at the specified level in the list. | 1.3 | |
| list | Method > setLevelStartingNumber(level: number, startingNumber: number) | Sets the starting number at the specified level in the list. Default value is 1. | 1.3 | |
| listCollection | Property > items | A collection of list objects. Read-only. | 1.3 | |
| listCollection | Method > getById(id: number) | Gets a list by its identifier. | 1.3 | |
| listCollection | Method > getFirst() | Gets the first list in this collection. | 1.3 | |
| listCollection | Method > getItem(index: number) | Gets a list object by its index in the collection. | 1.3 | |
| listItem | Property > level | Gets or sets the level of the item in the list. | 1.3 | |
| listItem | Property > listString | Gets the list item bullet, number or picture as a string. Read-only. | 1.3 | |
| listItem | Property > siblingIndex | Gets the list item order number in relation to its siblings. Read-only. | 1.3 | |
| listItem | Method > getAncestor(parentOnly: bool) | Gets the list item parent, or the closest ancestor if the parent does not exist. | 1.3 | |
| listItem | Method > getDescendants(directChildrenOnly: bool) | Gets all descendant list items of the list item. | 1.3 | |
| paragraph | Property > isLastParagraph | Indicates the paragraph is the last one inside its parent body. Read-only. | 1.3 | |
| paragraph | Property > isListItem | Checks whether the paragraph is a list item. Read-only. | 1.3 | |
| paragraph | Property > tableNestingLevel | Gets the level of the paragraph's table. It returns 0 if the paragraph is not in a table. Read-only. | 1.3 | |
| paragraph | Relationship > list | Gets the List to which this paragraph belongs. Returns a null object if the paragraph is not in a list. Read-only. | 1.3 | |
| paragraph | Relationship > listItem | Gets the ListItem for the paragraph. Returns a null object if the paragraph is not part of a list. Read-only. | 1.3 | |
| paragraph | Relationship > parentBody | Gets the parent body of the paragraph. Read-only. | 1.3 | |
| paragraph | Relationship > parentTable | Gets the table that contains the paragraph. Returns a null object if it is not contained in a table. Read-only. | 1.3 | |
| paragraph | Relationship > parentTableCell | Gets the table cell that contains the paragraph. Returns a null object if it is not contained in a table cell. Read-only. | 1.3 | |
| paragraph | Relationship > styleBuiltIn | Gets or sets the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. | 1.3 | |
| paragraph | Method > attachToList(listId: number, level: number) | Lets the paragraph join an existing list at the specified level. Fails if the paragraph cannot join the list or if the paragraph is already a list item. | 1.3 | |
| paragraph | Method > detachFromList() | Moves this paragraph out of its list, if the paragraph is a list item. | 1.3 | |
| paragraph | Method > getNext() | Gets the next paragraph. | 1.3 | |
| paragraph | Method > getPrevious() | Gets the previous paragraph. | 1.3 | |
| paragraph | Method > getRange(rangeLocation: RangeLocation) | Gets the whole paragraph, or the starting or ending point of the paragraph, as a range. | 1.3 | |
| paragraph | Method > getTextRanges(endingMarks: string[], trimSpacing: bool) | Gets the text ranges in the paragraph by using punctuation marks andor other ending marks. | 1.3 | |
| paragraph | Method > insertTable(rowCount: number, columnCount: number, insertLocation: InsertLocation, values: string[][]) | Inserts a table with the specified number of rows and columns. The insertLocation value can be 'Before' or 'After'. | 1.3 | |
| paragraph | Method > split(delimiters: string[], trimDelimiters: bool, trimSpacing: bool) | Splits the paragraph into child ranges by using delimiters. | 1.3 | |
| paragraph | Method > startNewList() | Starts a new list with this paragraph. Fails if the paragraph is already a list item. | 1.3 | |
| paragraphCollection | Method > getFirst() | Gets the first paragraph in this collection. | 1.3 | |
| paragraphCollection | Method > getLast() | Gets the last paragraph in this collection. | 1.3 | |
| range | Property > hyperlink | Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a newline character ('\n') to separate the address part from the optional location part. | 1.3 | |
| range | Property > isEmpty | Checks whether the range length is zero. Read-only. | 1.3 | |
| range | Relationship > lists | Gets the collection of list objects in the range. Read-only. | 1.3 | |
| range | Relationship > parentBody | Gets the parent body of the range. Read-only. | 1.3 | |
| range | Relationship > parentTable | Gets the table that contains the range. Returns null if it is not contained in a table. Read-only. | 1.3 | |
| range | Relationship > parentTableCell | Gets the table cell that contains the range. Returns a null object if it is not contained in a table cell. Read-only. | 1.3 | |
| range | Relationship > styleBuiltIn | Gets or sets the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. | 1.3 | |
| range | Relationship > tables | Gets the collection of table objects in the range. Read-only. | 1.3 | |
| range | Method > compareLocationWith(range: Range) | Compares this range's location with another range's location. | 1.3 | |
| range | Method > expandTo(range: Range) | Returns a new range that extends from this range in either direction to cover another range. This range is not changed. | 1.3 | |
| range | Method > getHyperlinkRanges() | Gets hyperlink child ranges within the range. | 1.3 | |
| range | Method > getNextTextRange(endingMarks: string[], trimSpacing: bool) | Gets the next text range by using punctuation marks andor other ending marks. | 1.3 | |
| range | Method > getRange(rangeLocation: RangeLocation) | Clones the range, or gets the starting or ending point of the range as a new range. | 1.3 | |
| range | Method > getTextRanges(endingMarks: string[], trimSpacing: bool) | Gets the text child ranges in the range by using punctuation marks andor other ending marks. | 1.3 | |
| range | Method > insertTable(rowCount: number, columnCount: number, insertLocation: InsertLocation, values: string[][]) | Inserts a table with the specified number of rows and columns. The insertLocation value can be 'Before' or 'After'. | 1.3 | |
| range | Method > intersectWith(range: Range) | Returns a new range as the intersection of this range with another range. This range is not changed. | 1.3 | |
| range | Method > split(delimiters: string[], multiParagraphs: bool, trimDelimiters: bool, trimSpacing: bool) | Splits the range into child ranges by using delimiters. | 1.3 | |
| rangeCollection | Property > items | A collection of range objects. Read-only. | 1.3 | |
| rangeCollection | Method > getFirst() | Gets the first range in this collection. | 1.3 | |
| rangeCollection | Method > getItem(index: number) | Gets a range object by its index in the collection. | 1.3 | |
| section | Method > getNext() | Gets the next section. | 1.3 | |
| sectionCollection | Method > getFirst() | Gets the first section in this collection. | 1.3 | |
| table | Property > headerRowCount | Gets and sets the number of header rows. | 1.3 | |
| table | Property > height | Gets the height of the table in points. Read-only. | 1.3 | |
| table | Property > isUniform | Indicates whether all of the table rows are uniform. Read-only. | 1.3 | |
| table | Property > nestingLevel | Gets the nesting level of the table. Top-level tables have level 1. Read-only. | 1.3 | |
| table | Property > rowCount | Gets the number of rows in the table. Read-only. | 1.3 | |
| table | Property > shadingColor | Gets and sets the shading color. | 1.3 | |
| table | Property > style | Gets or sets the style name for the table. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. | 1.3 | |
| table | Property > styleBandedColumns | Gets and sets whether the table has banded columns. | 1.3 | |
| table | Property > styleBandedRows | Gets and sets whether the table has banded rows. | 1.3 | |
| table | Property > styleFirstColumn | Gets and sets whether the table has a first column with a special style. | 1.3 | |
| table | Property > styleLastColumn | Gets and sets whether the table has a last column with a special style. | 1.3 | |
| table | Property > styleTotalRow | Gets and sets whether the table has a total (last) row with a special style. | 1.3 | |
| table | Property > values | Gets and sets the text values in the table, as a 2D Javascript array. | 1.3 | |
| table | Property > width | Gets and sets the width of the table in points. | 1.3 | |
| table | Relationship > font | Gets the font. Use this to get and set font name, size, color, and other properties. Read-only. | 1.3 | |
| table | Relationship > horizontalAlignment | Gets and sets the horizontal alignment of every cell in the table. The value can be 'left', 'centered', 'right', or 'justified'. | 1.3 | |
| table | Relationship > paragraphAfter | Gets the paragraph after the table. Read-only. | 1.3 | |
| table | Relationship > paragraphBefore | Gets the paragraph before the table. Read-only. | 1.3 | |
| table | Relationship > parentBody | Gets the parent body of the table. Read-only. | 1.3 | |
| table | Relationship > parentContentControl | Gets the content control that contains the table. Read-only. | 1.3 | |
| table | Relationship > parentTable | Gets the table that contains this table. Returns a null object if it is not contained in a table. Read-only. | 1.3 | |
| table | Relationship > parentTableCell | Gets the table cell that contains this table. Returns a null object if it is not contained in a table cell. Read-only. | 1.3 | |
| table | Relationship > rows | Gets all of the table rows. Read-only. | 1.3 | |
| table | Relationship > styleBuiltIn | Gets or sets the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. | 1.3 | |
| table | Relationship > tables | Gets the child tables nested one level deeper. Read-only. | 1.3 | |
| table | Relationship > verticalAlignment | Gets and sets the vertical alignment of every cell in the table. The value can be 'top', 'center' or 'bottom'. | 1.3 | |
| table | Method > addColumns(insertLocation: InsertLocation, columnCount: number, values: string[][]) | Adds columns to the start or end of the table, using the first or last existing column as a template. This is applicable to uniform tables. The string values, if specified, are set in the newly inserted rows. | 1.3 | |
| table | Method > addRows(insertLocation: InsertLocation, rowCount: number, values: string[][]) | Adds rows to the start or end of the table, using the first or last existing row as a template. The string values, if specified, are set in the newly inserted rows. | 1.3 | |
| table | Method > autoFitContents() | Autofits the table columns to the width of their contents. | 1.3 | |
| table | Method > autoFitWindow() | Autofits the table columns to the width of the window. | 1.3 | |
| table | Method > clear() | Clears the contents of the table. | 1.3 | |
| table | Method > delete() | Deletes the entire table. | 1.3 | |
| table | Method > deleteColumns(columnIndex: number, columnCount: number) | Deletes specific columns. This is applicable to uniform tables. | 1.3 | |
| table | Method > deleteRows(rowIndex: number, rowCount: number) | Deletes specific rows. | 1.3 | |
| table | Method > distributeColumns() | Distributes the column widths evenly. | 1.3 | |
| table | Method > distributeRows() | Distributes the row heights evenly. | 1.3 | |
| table | Method > getBorder(borderLocation: BorderLocation) | Gets the border style for the specified border. | 1.3 | |
| table | Method > getCell(rowIndex: number, cellIndex: number) | Gets the table cell at a specified row and column. | 1.3 | |
| table | Method > getCellPadding(cellPaddingLocation: CellPaddingLocation) | Gets cell padding in points. | 1.3 | |
| table | Method > getNext() | Gets the next table. | 1.3 | |
| table | Method > getRange(rangeLocation: RangeLocation) | Gets the range that contains this table, or the range at the start or end of the table. | 1.3 | |
| table | Method > insertContentControl() | Inserts a content control on the table. | 1.3 | |
| table | Method > insertParagraph(paragraphText: string, insertLocation: InsertLocation) | Inserts a paragraph at the specified location. The insertLocation value can be 'Before' or 'After'. | 1.3 | |
| table | Method > insertTable(rowCount: number, columnCount: number, insertLocation: InsertLocation, values: string[][]) | Inserts a table with the specified number of rows and columns. The insertLocation value can be 'Before' or 'After'. | 1.3 | |
| table | Method > search(searchText: string, searchOptions: ParamTypeStrings.SearchOptions) | Performs a search with the specified searchOptions on the scope of the table object. The search results are a collection of range objects. | 1.3 | |
| table | Method > select(selectionMode: SelectionMode) | Selects the table, or the position at the start or end of the table, and navigates the Word UI to it. | 1.3 | |
| table | Method > setCellPadding(cellPaddingLocation: CellPaddingLocation, cellPadding: float) | Sets cell padding in points. | 1.3 | |
| tableBorder | Property > color | Gets or sets the table border color, as a hex value or name. | 1.3 | |
| tableBorder | Property > width | Gets or sets the width, in points, of the table border. Not applicable to table border types that have fixed widths. | 1.3 | |
| tableBorder | Relationship > type | Gets or sets the type of the table border. | 1.3 | |
| tableCell | Property > cellIndex | Gets the index of the cell in its row. Read-only. | 1.3 | |
| tableCell | Property > columnWidth | Gets and sets the width of the cell's column in points. This is applicable to uniform tables. | 1.3 | |
| tableCell | Property > rowIndex | Gets the index of the cell's row in the table. Read-only. | 1.3 | |
| tableCell | Property > shadingColor | Gets or sets the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. | 1.3 | |
| tableCell | Property > value | Gets and sets the text of the cell. | 1.3 | |
| tableCell | Property > width | Gets the width of the cell in points. Read-only. | 1.3 | |
| tableCell | Relationship > body | Gets the body object of the cell. Read-only. | 1.3 | |
| tableCell | Relationship > horizontalAlignment | Gets and sets the horizontal alignment of the cell. The value can be 'left', 'centered', 'right', or 'justified'. | 1.3 | |
| tableCell | Relationship > parentRow | Gets the parent row of the cell. Read-only. | 1.3 | |
| tableCell | Relationship > parentTable | Gets the parent table of the cell. Read-only. | 1.3 | |
| tableCell | Relationship > verticalAlignment | Gets and sets the vertical alignment of the cell. The value can be 'top', 'center' or 'bottom'. | 1.3 | |
| tableCell | Method > deleteColumn() | Deletes the column containing this cell. This is applicable to uniform tables. | 1.3 | |
| tableCell | Method > deleteRow() | Deletes the row containing this cell. | 1.3 | |
| tableCell | Method > getBorder(borderLocation: BorderLocation) | Gets the border style for the specified border. | 1.3 | |
| tableCell | Method > getCellPadding(cellPaddingLocation: CellPaddingLocation) | Gets cell padding in points. | 1.3 | |
| tableCell | Method > getNext() | Gets the next cell. | 1.3 | |
| tableCell | Method > insertColumns(insertLocation: InsertLocation, columnCount: number, values: string[][]) | Adds columns to the left or right of the cell, using the cell's column as a template. This is applicable to uniform tables. The string values, if specified, are set in the newly inserted rows. | 1.3 | |
| tableCell | Method > insertRows(insertLocation: InsertLocation, rowCount: number, values: string[][]) | Inserts rows above or below the cell, using the cell's row as a template. The string values, if specified, are set in the newly inserted rows. | 1.3 | |
| tableCell | Method > setCellPadding(cellPaddingLocation: CellPaddingLocation, cellPadding: float) | Sets cell padding in points. | 1.3 | |
| tableCellCollection | Property > items | A collection of tableCell objects. Read-only. | 1.3 | |
| tableCellCollection | Method > getFirst() | Gets the first table cell in this collection. | 1.3 | |
| tableCellCollection | Method > getItem(index: number) | Gets a table cell object by its index in the collection. | 1.3 | |
| tableCollection | Property > items | A collection of table objects. Read-only. | 1.3 | |
| tableCollection | Method > getFirst() | Gets the first table in this collection. | 1.3 | |
| tableCollection | Method > getItem(index: number) | Gets a table object by its index in the collection. | 1.3 | |
| tableRow | Property > cellCount | Gets the number of cells in the row. Read-only. | 1.3 | |
| tableRow | Property > isHeader | Checks whether the row is a header row. Read-only. To set the number of header rows, use HeaderRowCount on the Table object. Read-only. | 1.3 | |
| tableRow | Property > preferredHeight | Gets and sets the preferred height of the row in points. | 1.3 | |
| tableRow | Property > rowIndex | Gets the index of the row in its parent table. Read-only. | 1.3 | |
| tableRow | Property > shadingColor | Gets and sets the shading color. | 1.3 | |
| tableRow | Property > values | Gets and sets the text values in the row, as a 1D Javascript array. | 1.3 | |
| tableRow | Relationship > cells | Gets cells. Read-only. | 1.3 | |
| tableRow | Relationship > font | Gets the font. Use this to get and set font name, size, color, and other properties. Read-only. | 1.3 | |
| tableRow | Relationship > horizontalAlignment | Gets and sets the horizontal alignment of every cell in the row. The value can be 'left', 'centered', 'right', or 'justified'. | 1.3 | |
| tableRow | Relationship > parentTable | Gets parent table. Read-only. | 1.3 | |
| tableRow | Relationship > verticalAlignment | Gets and sets the vertical alignment of the cells in the row. The value can be 'top', 'center' or 'bottom'. | 1.3 | |
| tableRow | Method > clear() | Clears the contents of the row. | 1.3 | |
| tableRow | Method > delete() | Deletes the entire row. | 1.3 | |
| tableRow | Method > getBorder(borderLocation: BorderLocation) | Gets the border style of the cells in the row. | 1.3 | |
| tableRow | Method > getCellPadding(cellPaddingLocation: CellPaddingLocation) | Gets cell padding in points. | 1.3 | |
| tableRow | Method > getNext() | Gets the next row. | 1.3 | |
| tableRow | Method > insertRows(insertLocation: InsertLocation, rowCount: number, values: string[][]) | Inserts rows using this row as a template. If values are specified, inserts the values into the new rows. | 1.3 | |
| tableRow | Method > search(searchText: string, searchOptions: ParamTypeStrings.SearchOptions) | Performs a search with the specified searchOptions on the scope of the row. The search results are a collection of range objects. | 1.3 | |
| tableRow | Method > select(selectionMode: SelectionMode) | Selects the row and navigates the Word UI to it. | 1.3 | |
| tableRow | Method > setCellPadding(cellPaddingLocation: CellPaddingLocation, cellPadding: float) | Sets cell padding in points. | 1.3 | |
| tableRowCollection | Property > items | A collection of tableRow objects. Read-only. | 1.3 | |
| tableRowCollection | Method > getFirst() | Gets the first row in this collection. | 1.3 | |
| tableRowCollection | Method > getItem(index: number) | Gets a table row object by its index in the collection. | 1.3 |
What's new in Word JavaScript API 1.2
The following are the new additions to the Word JavaScript APIs in requirement set 1.2.
| Object | What's new | Description | Requirement set |
|---|---|---|---|
| contentControl | Method > insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: InsertLocation) | Inserts an inline picture into the content control at the specified location. The insertLocation value can be 'Replace', 'Start' or 'End'. | 1.2 |
| inlinePicture | Relationship > paragraph | Gets the parent paragraph that contains the inline image. Read-only. | 1.2 |
| inlinePicture | Method > delete() | Deletes the inline picture from the document. | 1.2 |
| inlinePicture | Method > insertBreak(breakType: BreakType, insertLocation: InsertLocation) | Inserts a break at the specified location in the main document. The insertLocation value can be 'Before' or 'After'. | 1.2 |
| inlinePicture | Method > insertFileFromBase64(base64File: string, insertLocation: InsertLocation) | Inserts a document at the specified location. The insertLocation value can be 'Before' or 'After'. | 1.2 |
| inlinePicture | Method > insertHtml(html: string, insertLocation: InsertLocation) | Inserts HTML at the specified location. The insertLocation value can be 'Before' or 'After'. | 1.2 |
| inlinePicture | Method > insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: InsertLocation) | Inserts an inline picture at the specified location. The insertLocation value can be 'Replace', 'Before' or 'After'. | 1.2 |
| inlinePicture | Method > insertOoxml(ooxml: string, insertLocation: InsertLocation) | Inserts OOXML at the specified location. The insertLocation value can be 'Before' or 'After'. | 1.2 |
| inlinePicture | Method > insertParagraph(paragraphText: string, insertLocation: InsertLocation) | Inserts a paragraph at the specified location. The insertLocation value can be 'Before' or 'After'. | 1.2 |
| inlinePicture | Method > insertText(text: string, insertLocation: InsertLocation) | Inserts text at the specified location. The insertLocation value can be 'Before' or 'After'. | 1.2 |
| inlinePicture | Method > select(selectionMode: SelectionMode) | Selects the inline picture. This causes Word to scroll to the selection. | 1.2 |
| range | Relationship > inlinePictures | Gets the collection of inline picture objects in the range. Read-only. | 1.2 |
| range | Method > insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: InsertLocation) | Inserts a picture at the specified location. The insertLocation value can be 'Replace', 'Start', 'End', 'Before' or 'After'. | 1.2 |
Word JavaScript API 1.1
Word JavaScript API 1.1 is the first version of the API. For details about the API, see the Word JavaScript API reference topics.