word.interfaces.tableloadoptions.yml

### YamlMime:TSType
name: Word.Interfaces.TableLoadOptions
uid: 'word!Word.Interfaces.TableLoadOptions:interface'
package: word!
fullName: Word.Interfaces.TableLoadOptions
summary: Represents a table in a Word document.
remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: $all
    uid: 'word!Word.Interfaces.TableLoadOptions#$all:member'
    package: word!
    fullName: $all
    summary: >-
      Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`<!-- -->) but not
      the navigational properties (such as `Range.format.fill.color`<!-- -->).
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: '$all?: boolean;'
      return:
        type: boolean
  - name: alignment
    uid: 'word!Word.Interfaces.TableLoadOptions#alignment:member'
    package: word!
    fullName: alignment
    summary: 'Specifies the alignment of the table against the page column. The value can be ''Left'', ''Centered'', or ''Right''.'
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'alignment?: boolean;'
      return:
        type: boolean
  - name: font
    uid: 'word!Word.Interfaces.TableLoadOptions#font:member'
    package: word!
    fullName: font
    summary: 'Gets the font. Use this to get and set font name, size, color, and other properties.'
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'font?: Word.Interfaces.FontLoadOptions;'
      return:
        type: '<xref uid="word!Word.Interfaces.FontLoadOptions:interface" />'
  - name: headerRowCount
    uid: 'word!Word.Interfaces.TableLoadOptions#headerRowCount:member'
    package: word!
    fullName: headerRowCount
    summary: Specifies the number of header rows.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'headerRowCount?: boolean;'
      return:
        type: boolean
  - name: horizontalAlignment
    uid: 'word!Word.Interfaces.TableLoadOptions#horizontalAlignment:member'
    package: word!
    fullName: horizontalAlignment
    summary: >-
      Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or
      'Justified'.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'horizontalAlignment?: boolean;'
      return:
        type: boolean
  - name: isUniform
    uid: 'word!Word.Interfaces.TableLoadOptions#isUniform:member'
    package: word!
    fullName: isUniform
    summary: Indicates whether all of the table rows are uniform.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'isUniform?: boolean;'
      return:
        type: boolean
  - name: nestingLevel
    uid: 'word!Word.Interfaces.TableLoadOptions#nestingLevel:member'
    package: word!
    fullName: nestingLevel
    summary: Gets the nesting level of the table. Top-level tables have level 1.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'nestingLevel?: boolean;'
      return:
        type: boolean
  - name: parentBody
    uid: 'word!Word.Interfaces.TableLoadOptions#parentBody:member'
    package: word!
    fullName: parentBody
    summary: Gets the parent body of the table.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'parentBody?: Word.Interfaces.BodyLoadOptions;'
      return:
        type: '<xref uid="word!Word.Interfaces.BodyLoadOptions:interface" />'
  - name: parentContentControl
    uid: 'word!Word.Interfaces.TableLoadOptions#parentContentControl:member'
    package: word!
    fullName: parentContentControl
    summary: >-
      Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content
      control.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'parentContentControl?: Word.Interfaces.ContentControlLoadOptions;'
      return:
        type: '<xref uid="word!Word.Interfaces.ContentControlLoadOptions:interface" />'
  - name: parentContentControlOrNullObject
    uid: 'word!Word.Interfaces.TableLoadOptions#parentContentControlOrNullObject:member'
    package: word!
    fullName: parentContentControlOrNullObject
    summary: >-
      Gets the content control that contains the table. If there isn't a parent content control, then this method will
      return an object with its `isNullObject` property set to `true`<!-- -->. For further information, see
      [*OrNullObject methods and
      properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties)<!--
      -->.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;'
      return:
        type: '<xref uid="word!Word.Interfaces.ContentControlLoadOptions:interface" />'
  - name: parentTable
    uid: 'word!Word.Interfaces.TableLoadOptions#parentTable:member'
    package: word!
    fullName: parentTable
    summary: Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'parentTable?: Word.Interfaces.TableLoadOptions;'
      return:
        type: '<xref uid="word!Word.Interfaces.TableLoadOptions:interface" />'
  - name: parentTableCell
    uid: 'word!Word.Interfaces.TableLoadOptions#parentTableCell:member'
    package: word!
    fullName: parentTableCell
    summary: >-
      Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table
      cell.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'parentTableCell?: Word.Interfaces.TableCellLoadOptions;'
      return:
        type: '<xref uid="word!Word.Interfaces.TableCellLoadOptions:interface" />'
  - name: parentTableCellOrNullObject
    uid: 'word!Word.Interfaces.TableLoadOptions#parentTableCellOrNullObject:member'
    package: word!
    fullName: parentTableCellOrNullObject
    summary: >-
      Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return
      an object with its `isNullObject` property set to `true`<!-- -->. For further information, see [*OrNullObject
      methods and
      properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties)<!--
      -->.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;'
      return:
        type: '<xref uid="word!Word.Interfaces.TableCellLoadOptions:interface" />'
  - name: parentTableOrNullObject
    uid: 'word!Word.Interfaces.TableLoadOptions#parentTableOrNullObject:member'
    package: word!
    fullName: parentTableOrNullObject
    summary: >-
      Gets the table that contains this table. If it isn't contained in a table, then this method will return an object
      with its `isNullObject` property set to `true`<!-- -->. For further information, see [*OrNullObject methods and
      properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties)<!--
      -->.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;'
      return:
        type: '<xref uid="word!Word.Interfaces.TableLoadOptions:interface" />'
  - name: rowCount
    uid: 'word!Word.Interfaces.TableLoadOptions#rowCount:member'
    package: word!
    fullName: rowCount
    summary: Gets the number of rows in the table.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'rowCount?: boolean;'
      return:
        type: boolean
  - name: shadingColor
    uid: 'word!Word.Interfaces.TableLoadOptions#shadingColor:member'
    package: word!
    fullName: shadingColor
    summary: 'Specifies the shading color. Color is specified in "\#RRGGBB" format or by using the color name.'
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'shadingColor?: boolean;'
      return:
        type: boolean
  - name: style
    uid: 'word!Word.Interfaces.TableLoadOptions#style:member'
    package: word!
    fullName: style
    summary: >-
      Specifies 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.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'style?: boolean;'
      return:
        type: boolean
  - name: styleBandedColumns
    uid: 'word!Word.Interfaces.TableLoadOptions#styleBandedColumns:member'
    package: word!
    fullName: styleBandedColumns
    summary: Specifies whether the table has banded columns.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'styleBandedColumns?: boolean;'
      return:
        type: boolean
  - name: styleBandedRows
    uid: 'word!Word.Interfaces.TableLoadOptions#styleBandedRows:member'
    package: word!
    fullName: styleBandedRows
    summary: Specifies whether the table has banded rows.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'styleBandedRows?: boolean;'
      return:
        type: boolean
  - name: styleBuiltIn
    uid: 'word!Word.Interfaces.TableLoadOptions#styleBuiltIn:member'
    package: word!
    fullName: styleBuiltIn
    summary: >-
      Specifies 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.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'styleBuiltIn?: boolean;'
      return:
        type: boolean
  - name: styleFirstColumn
    uid: 'word!Word.Interfaces.TableLoadOptions#styleFirstColumn:member'
    package: word!
    fullName: styleFirstColumn
    summary: Specifies whether the table has a first column with a special style.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'styleFirstColumn?: boolean;'
      return:
        type: boolean
  - name: styleLastColumn
    uid: 'word!Word.Interfaces.TableLoadOptions#styleLastColumn:member'
    package: word!
    fullName: styleLastColumn
    summary: Specifies whether the table has a last column with a special style.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'styleLastColumn?: boolean;'
      return:
        type: boolean
  - name: styleTotalRow
    uid: 'word!Word.Interfaces.TableLoadOptions#styleTotalRow:member'
    package: word!
    fullName: styleTotalRow
    summary: Specifies whether the table has a total (last) row with a special style.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'styleTotalRow?: boolean;'
      return:
        type: boolean
  - name: values
    uid: 'word!Word.Interfaces.TableLoadOptions#values:member'
    package: word!
    fullName: values
    summary: 'Specifies the text values in the table, as a 2D JavaScript array.'
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'values?: boolean;'
      return:
        type: boolean
  - name: verticalAlignment
    uid: 'word!Word.Interfaces.TableLoadOptions#verticalAlignment:member'
    package: word!
    fullName: verticalAlignment
    summary: 'Specifies the vertical alignment of every cell in the table. The value can be ''Top'', ''Center'', or ''Bottom''.'
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'verticalAlignment?: boolean;'
      return:
        type: boolean
  - name: width
    uid: 'word!Word.Interfaces.TableLoadOptions#width:member'
    package: word!
    fullName: width
    summary: Specifies the width of the table in points.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'width?: boolean;'
      return:
        type: boolean