Word.Table class

Representa uma tabela em um documento do Word.

Comentários

Usada por

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/table-cell-access.yaml

await Word.run(async (context) => {
  // Use a two-dimensional array to hold the initial table values.
  const data = [
    ["Tokyo", "Beijing", "Seattle"],
    ["Apple", "Orange", "Pineapple"]
  ];
  const table: Word.Table = context.document.body.insertTable(2, 3, "Start", data);
  table.styleBuiltIn = Word.BuiltInStyleName.gridTable5Dark_Accent2;
  table.styleFirstColumn = false;

  await context.sync();
});

Propriedades

alignment	Especifica o alinhamento da tabela em relação à coluna da página. O valor pode ser `left`, `centered`ou `right`.
columns	Retorna o `TableColumnCollection` objeto que representa as colunas na tabela.
context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
description	Especifica a descrição da tabela.
endnotes	Obtém a coleção de notas de fim na tabela.
fields	Obtém a coleção de `Field` objetos na tabela.
font	Obtém a fonte. Use isto para obter e definir o nome, o tamanho e a cor da fonte, além de outras propriedades.
footnotes	Obtém a coleção de notas de rodapé na tabela.
headerRowCount	Especifica o número de linhas de cabeçalho.
horizontalAlignment	Especifica o alinhamento horizontal de cada célula na tabela. O valor pode ser `left`, `centered`, `right`ou `justified`.
isUniform	Indica se todas as linhas de tabela são uniformes.
nestingLevel	Obtém o nível de aninhamento da tabela. Tabelas de nível superior têm o nível 1.
parentBody	Obtém o corpo pai da tabela.
parentContentControl	Obtém o controle de conteúdo que contém a tabela. Lançará um `ItemNotFound` erro se não houver um controle de conteúdo pai.
parentContentControlOrNullObject	Obtém o controle de conteúdo que contém a tabela. Se não houver um controle de conteúdo pai, esse método retornará um objeto com sua `isNullObject` propriedade definida como `true`. Para obter mais informações, consulte métodos e propriedades *OrNullObject.
parentTable	Obtém a tabela que contém esta tabela. Gera um `ItemNotFound` erro se não estiver contido em uma tabela.
parentTableCell	Obtém a célula de tabela que contém esta tabela. Gera um `ItemNotFound` erro se não estiver contido em uma célula da tabela.
parentTableCellOrNullObject	Obtém a célula de tabela que contém esta tabela. Se ele não estiver contido em uma célula da tabela, esse método retornará um objeto com sua `isNullObject` propriedade definida como `true`. Para obter mais informações, consulte métodos e propriedades *OrNullObject.
parentTableOrNullObject	Obtém a tabela que contém esta tabela. Se não estiver contido em uma tabela, esse método retornará um objeto com sua `isNullObject` propriedade definida como `true`. Para obter mais informações, consulte métodos e propriedades *OrNullObject.
rowCount	Obtém a quantidade de linhas na tabela.
rows	Obtém todas as linhas da tabela.
shading	Retorna o `ShadingUniversal` objeto que representa o sombreamento da tabela.
shadingColor	Especifica a cor de sombreamento. Você pode definir a cor no formato "#RRGGBB" ou usando o nome da cor.
style	Especifica o nome do estilo da tabela. Use esta propriedade de estilos personalizados e nomes de estilo localizados. Para usar os estilos internos que são portáteis entre localidades, confira a propriedade "styleBuiltIn".
styleBandedColumns	Especifica se a tabela tem colunas em faixas.
styleBandedRows	Especifica se a tabela possui linhas em faixas.
styleBuiltIn	Especifica o nome do estilo interno da tabela. Use esta propriedade para estilos internos que são portáteis entre localidades. Para usar estilos personalizados ou nomes de estilo localizados, confira a propriedade "estilo".
styleFirstColumn	Especifica se a tabela tem uma primeira coluna com um estilo especial.
styleLastColumn	Especifica se a tabela tem uma última coluna com um estilo especial.
styleTotalRow	Especifica se a tabela tem uma linha de totais (última) com um estilo especial.
tables	Obtém as tabelas filho aninhadas em um nível mais profundo.
title	Especifica o título da tabela.
values	Especifica os valores de texto na tabela, como uma matriz 2D JavaScript.
verticalAlignment	Especifica o alinhamento vertical de cada célula na tabela. O valor pode ser `top`, `center`ou `bottom`.
width	Especifica a largura da tabela em pontos.

Métodos

addColumns(insertLocation, columnCount, values)	Adiciona colunas ao início ou no final da tabela, usando a primeira ou última coluna existente como um modelo. Isto é aplicável às tabelas uniformes. Os valores de cadeia de caracteres, se especificado, são definidos nas linhas recém-inseridas.
addRows(insertLocation, rowCount, values)	Adiciona linhas ao início ou no final da tabela, usando a primeira ou última linha existente como um modelo. Os valores de cadeia de caracteres, se especificado, são definidos nas linhas recém-inseridas.
applyStyleDirectFormatting(styleName)	Aplica o estilo especificado, mas mantém qualquer formatação que um usuário aplique diretamente.
autoFitBehavior(behavior)	Determina como o Microsoft Word redimensiona uma tabela quando o recurso de AutoAjuste é usado.
autoFitBehavior(behavior)	Determina como o Microsoft Word redimensiona uma tabela quando o recurso de AutoAjuste é usado.
autoFitWindow()	Autoajusta as colunas da tabela para a largura da janela.
autoFormat(options)	Aplica uma aparência predefinida a uma tabela.
clear()	Limpa o conteúdo da tabela.
convertToText(options)	Converte uma tabela em texto.
delete()	Exclui toda a tabela.
deleteColumns(columnIndex, columnCount)	Exclui colunas específicas. Isto é aplicável às tabelas uniformes.
deleteRows(rowIndex, rowCount)	Exclui linha específicas.
distributeColumns()	Distribui uniformemente a largura das colunas. Isto é aplicável às tabelas uniformes.
getBorder(borderLocation)	Obtém o estilo de borda para a borda especificada.
getBorder(borderLocation)	Obtém o estilo de borda para a borda especificada.
getCell(rowIndex, cellIndex)	Obtém a célula da tabela em uma linha e coluna especificada. Lançará um `ItemNotFound` erro se a célula da tabela especificada não existir.
getCellOrNullObject(rowIndex, cellIndex)	Obtém a célula da tabela em uma linha e coluna especificada. Se a célula da tabela especificada não existir, esse método retornará um objeto com sua `isNullObject` propriedade definida como `true`. Para obter mais informações, consulte métodos e propriedades *OrNullObject.
getCellPadding(cellPaddingLocation)	Obtém o preenchimento de célula em pontos.
getCellPadding(cellPaddingLocation)	Obtém o preenchimento de célula em pontos.
getNext()	Obtém a próxima tabela. Gera um `ItemNotFound` erro se esta tabela for a última.
getNextOrNullObject()	Obtém a próxima tabela. Se esta tabela for a última, então este método retornará um objeto com sua `isNullObject` propriedade definida como `true`. Para obter mais informações, consulte métodos e propriedades *OrNullObject.
getParagraphAfter()	Obtém o parágrafo após a tabela. Gera um `ItemNotFound` erro se não houver um parágrafo após a tabela.
getParagraphAfterOrNullObject()	Obtém o parágrafo após a tabela. Se não houver um parágrafo após a tabela, esse método retornará um objeto com sua `isNullObject` propriedade definida como `true`. Para obter mais informações, consulte métodos e propriedades *OrNullObject.
getParagraphBefore()	Obtém o parágrafo antes da tabela. Lançará um `ItemNotFound` erro se não houver um parágrafo antes da tabela.
getParagraphBeforeOrNullObject()	Obtém o parágrafo antes da tabela. Se não houver um parágrafo antes da tabela, esse método retornará um objeto com sua `isNullObject` propriedade definida como `true`. Para obter mais informações, consulte métodos e propriedades *OrNullObject.
getRange(rangeLocation)	Obtém o intervalo que contém esta tabela, ou o intervalo no início ou no final da tabela.
insertContentControl()	Insere um controle de conteúdo na tabela.
insertParagraph(paragraphText, insertLocation)	Insere um parágrafo no local especificado.
insertTable(rowCount, columnCount, insertLocation, values)	Insere uma tabela com a quantidade especificada de linhas e colunas.
load(options)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
load(propertyNames)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
load(propertyNamesAndPaths)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
mergeCells(topRow, firstCell, bottomRow, lastCell)	Mescla as células limitadas inclusive pela primeira e última célula.
reapplyAutoFormat()	Atualizações a tabela com as características do formato de tabela predefinido definido quando o `autoFormat` método foi chamado. O formato predefinido padrão é TableFormatType.none.
search(searchText, searchOptions)	Executa uma pesquisa com as opções de pesquisa especificadas no escopo do `Table` objeto. Os resultados da pesquisa são uma coleção de `Range` objetos.
select(selectionMode)	Seleciona a tabela, ou então, a posição no início ou no final da tabela e navega na interface do usuário do Word até ela.
select(selectionMode)	Seleciona a tabela, ou então, a posição no início ou no final da tabela e navega na interface do usuário do Word até ela.
set(properties, options)	Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties)	Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
setCellPadding(cellPaddingLocation, cellPadding)	Define o preenchimento de célula em pontos.
setCellPadding(cellPaddingLocation, cellPadding)	Define o preenchimento de célula em pontos.
sort(options)	Classifica a tabela especificada.
toJSON()	Substitui o método JavaScript `toJSON()` para fornecer uma saída mais útil quando um objeto de API é passado para `JSON.stringify()`. (`JSON.stringify`, por sua vez, chama o `toJSON` método do objeto que é passado para ele.) Enquanto o objeto original `Word.Table` é um objeto de API, o `toJSON` método retorna um objeto JavaScript simples (digitado como `Word.Interfaces.TableData`) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.
track()	Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação de context.trackedObjects.add(thisObject). Se você estiver usando esse objeto entre `.sync` chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez. Se esse objeto fizer parte de uma coleção, você também deverá acompanhar a coleção pai.
untrack()	Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é a forma abreviada de context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Você precisará ligar `context.sync()` antes que a liberação de memória entre em vigor.

alignment

Especifica o alinhamento da tabela em relação à coluna da página. O valor pode ser left, centeredou right.

alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";

Valor da propriedade

Comentários

Conjunto de APIs: WordApi 1.3

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-formatting.yaml

// Gets alignment details about the first table in the document.
await Word.run(async (context) => {
  const firstTable: Word.Table = context.document.body.tables.getFirst();
  firstTable.load(["alignment", "horizontalAlignment", "verticalAlignment"]);
  await context.sync();

  console.log(
    `Details about the alignment of the first table:`,
    `- Alignment of the table within the containing page column: ${firstTable.alignment}`,
    `- Horizontal alignment of every cell in the table: ${firstTable.horizontalAlignment}`,
    `- Vertical alignment of every cell in the table: ${firstTable.verticalAlignment}`,
  );
});

columns

Retorna o TableColumnCollection objeto que representa as colunas na tabela.

readonly columns: Word.TableColumnCollection;

Valor da propriedade

Word.TableColumnCollection

Comentários

Conjunto de APIs: WordApiDesktop 1.4

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Word.RequestContext

description

Especifica a descrição da tabela.

description: string;

Valor da propriedade

string

Comentários

Conjunto de APIs: WordApiDesktop 1.4

endnotes

Obtém a coleção de notas de fim na tabela.

readonly endnotes: Word.NoteItemCollection;

Valor da propriedade

Word.NoteItemCollection

Comentários

Conjunto de APIs: WordApi 1.5

fields

Obtém a coleção de Field objetos na tabela.

readonly fields: Word.FieldCollection;

Valor da propriedade

Word.FieldCollection

Comentários

Conjunto de APIs: WordApi 1.4

font

Obtém a fonte. Use isto para obter e definir o nome, o tamanho e a cor da fonte, além de outras propriedades.

readonly font: Word.Font;

Valor da propriedade

Word.Font

Comentários

Conjunto de APIs: WordApi 1.3

footnotes

Obtém a coleção de notas de rodapé na tabela.

readonly footnotes: Word.NoteItemCollection;

Valor da propriedade

Word.NoteItemCollection

Comentários

Conjunto de APIs: WordApi 1.5

headerRowCount

Especifica o número de linhas de cabeçalho.

headerRowCount: number;

Valor da propriedade

number

Comentários

Conjunto de APIs: WordApi 1.3

horizontalAlignment

Especifica o alinhamento horizontal de cada célula na tabela. O valor pode ser left, centered, rightou justified.

horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";

Valor da propriedade

Comentários

Conjunto de APIs: WordApi 1.3

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-formatting.yaml

// Gets alignment details about the first table in the document.
await Word.run(async (context) => {
  const firstTable: Word.Table = context.document.body.tables.getFirst();
  firstTable.load(["alignment", "horizontalAlignment", "verticalAlignment"]);
  await context.sync();

  console.log(
    `Details about the alignment of the first table:`,
    `- Alignment of the table within the containing page column: ${firstTable.alignment}`,
    `- Horizontal alignment of every cell in the table: ${firstTable.horizontalAlignment}`,
    `- Vertical alignment of every cell in the table: ${firstTable.verticalAlignment}`,
  );
});

isUniform

Indica se todas as linhas de tabela são uniformes.

readonly isUniform: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApi 1.3

nestingLevel

Obtém o nível de aninhamento da tabela. Tabelas de nível superior têm o nível 1.

readonly nestingLevel: number;

Valor da propriedade

number

Comentários

Conjunto de APIs: WordApi 1.3

parentBody

Obtém o corpo pai da tabela.

readonly parentBody: Word.Body;

Valor da propriedade

Word.Body

Comentários

Conjunto de APIs: WordApi 1.3

parentContentControl

Obtém o controle de conteúdo que contém a tabela. Lançará um ItemNotFound erro se não houver um controle de conteúdo pai.

readonly parentContentControl: Word.ContentControl;

Valor da propriedade

Word.ContentControl

Comentários

Conjunto de APIs: WordApi 1.3

parentContentControlOrNullObject

Obtém o controle de conteúdo que contém a tabela. Se não houver um controle de conteúdo pai, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.

readonly parentContentControlOrNullObject: Word.ContentControl;

Valor da propriedade

Word.ContentControl

Comentários

Conjunto de APIs: WordApi 1.3

parentTable

Obtém a tabela que contém esta tabela. Gera um ItemNotFound erro se não estiver contido em uma tabela.

readonly parentTable: Word.Table;

Valor da propriedade

Word.Table

Comentários

Conjunto de APIs: WordApi 1.3

parentTableCell

Obtém a célula de tabela que contém esta tabela. Gera um ItemNotFound erro se não estiver contido em uma célula da tabela.

readonly parentTableCell: Word.TableCell;

Valor da propriedade

Word.TableCell

Comentários

Conjunto de APIs: WordApi 1.3

parentTableCellOrNullObject

Obtém a célula de tabela que contém esta tabela. Se ele não estiver contido em uma célula da tabela, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.

readonly parentTableCellOrNullObject: Word.TableCell;

Valor da propriedade

Word.TableCell

Comentários

Conjunto de APIs: WordApi 1.3

parentTableOrNullObject

Obtém a tabela que contém esta tabela. Se não estiver contido em uma tabela, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.

readonly parentTableOrNullObject: Word.Table;

Valor da propriedade

Word.Table

Comentários

Conjunto de APIs: WordApi 1.3

rowCount

Obtém a quantidade de linhas na tabela.

readonly rowCount: number;

Valor da propriedade

number

Comentários

Conjunto de APIs: WordApi 1.3

rows

Obtém todas as linhas da tabela.

readonly rows: Word.TableRowCollection;

Valor da propriedade

Word.TableRowCollection

Comentários

Conjunto de APIs: WordApi 1.3

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-formatting.yaml

// Gets content alignment details about the first row of the first table in the document.
await Word.run(async (context) => {
  const firstTable: Word.Table = context.document.body.tables.getFirst();
  const firstTableRow: Word.TableRow = firstTable.rows.getFirst();
  firstTableRow.load(["horizontalAlignment", "verticalAlignment"]);
  await context.sync();

  console.log(
    `Details about the alignment of the first table's first row:`,
    `- Horizontal alignment of every cell in the row: ${firstTableRow.horizontalAlignment}`,
    `- Vertical alignment of every cell in the row: ${firstTableRow.verticalAlignment}`,
  );
});

shading

Retorna o ShadingUniversal objeto que representa o sombreamento da tabela.

readonly shading: Word.ShadingUniversal;

Valor da propriedade

Word.ShadingUniversal

Comentários

Conjunto de APIs: WordApiDesktop 1.4

shadingColor

Especifica a cor de sombreamento. Você pode definir a cor no formato "#RRGGBB" ou usando o nome da cor.

shadingColor: string;

Valor da propriedade

string

Comentários

Conjunto de APIs: WordApi 1.3

style

Especifica o nome do estilo da tabela. Use esta propriedade de estilos personalizados e nomes de estilo localizados. Para usar os estilos internos que são portáteis entre localidades, confira a propriedade "styleBuiltIn".

style: string;

Valor da propriedade

string

Comentários

Conjunto de APIs: WordApi 1.3

styleBandedColumns

Especifica se a tabela tem colunas em faixas.

styleBandedColumns: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApi 1.3

styleBandedRows

Especifica se a tabela possui linhas em faixas.

styleBandedRows: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApi 1.3

styleBuiltIn

Especifica o nome do estilo interno da tabela. Use esta propriedade para estilos internos que são portáteis entre localidades. Para usar estilos personalizados ou nomes de estilo localizados, confira a propriedade "estilo".

styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";

Valor da propriedade

Comentários

Conjunto de APIs: WordApi 1.3

styleFirstColumn

Especifica se a tabela tem uma primeira coluna com um estilo especial.

styleFirstColumn: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApi 1.3

styleLastColumn

Especifica se a tabela tem uma última coluna com um estilo especial.

styleLastColumn: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApi 1.3

styleTotalRow

Especifica se a tabela tem uma linha de totais (última) com um estilo especial.

styleTotalRow: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApi 1.3

tables

Obtém as tabelas filho aninhadas em um nível mais profundo.

readonly tables: Word.TableCollection;

Valor da propriedade

Word.TableCollection

Comentários

Conjunto de APIs: WordApi 1.3

title

Especifica o título da tabela.

title: string;

Valor da propriedade

string

Comentários

Conjunto de APIs: WordApiDesktop 1.4

values

Especifica os valores de texto na tabela, como uma matriz 2D JavaScript.

values: string[][];

Valor da propriedade

string[][]

Comentários

Conjunto de APIs: WordApi 1.3

verticalAlignment

Especifica o alinhamento vertical de cada célula na tabela. O valor pode ser top, centerou bottom.

verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom";

Valor da propriedade

Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"

Comentários

Conjunto de APIs: WordApi 1.3

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-formatting.yaml

// Gets alignment details about the first table in the document.
await Word.run(async (context) => {
  const firstTable: Word.Table = context.document.body.tables.getFirst();
  firstTable.load(["alignment", "horizontalAlignment", "verticalAlignment"]);
  await context.sync();

  console.log(
    `Details about the alignment of the first table:`,
    `- Alignment of the table within the containing page column: ${firstTable.alignment}`,
    `- Horizontal alignment of every cell in the table: ${firstTable.horizontalAlignment}`,
    `- Vertical alignment of every cell in the table: ${firstTable.verticalAlignment}`,
  );
});

width

Especifica a largura da tabela em pontos.

width: number;

Valor da propriedade

number

Comentários

Conjunto de APIs: WordApi 1.3

addColumns(insertLocation, columnCount, values)

Adiciona colunas ao início ou no final da tabela, usando a primeira ou última coluna existente como um modelo. Isto é aplicável às tabelas uniformes. Os valores de cadeia de caracteres, se especificado, são definidos nas linhas recém-inseridas.

addColumns(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", columnCount: number, values?: string[][]): void;

Parâmetros

insertLocation: start | end | "Start" | "End"

Deve ser start ou end, correspondente ao lado apropriado da mesa.

columnCount: number

Número de colunas a serem adicionadas.

values: string[][]

Matriz 2D opcional. As células serão preenchidas se as cadeias de caracteres correspondentes estiverem especificadas na matriz.

Retornos

void

Comentários

Conjunto de APIs: WordApi 1.3

addRows(insertLocation, rowCount, values)

Adiciona linhas ao início ou no final da tabela, usando a primeira ou última linha existente como um modelo. Os valores de cadeia de caracteres, se especificado, são definidos nas linhas recém-inseridas.

addRows(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", rowCount: number, values?: string[][]): Word.TableRowCollection;

Parâmetros

insertLocation: start | end | "Start" | "End"

Deve ser start ou end.

rowCount: number

Número de linhas a serem adicionadas.

values: string[][]

Matriz 2D opcional. As células serão preenchidas se as cadeias de caracteres correspondentes estiverem especificadas na matriz.

Retornos

Word.TableRowCollection

Comentários

Conjunto de APIs: WordApi 1.3

applyStyleDirectFormatting(styleName)

Aplica o estilo especificado, mas mantém qualquer formatação que um usuário aplique diretamente.

applyStyleDirectFormatting(styleName: string): void;

Parâmetros

styleName: string

O nome do estilo que será aplicado.

Retornos

void

Comentários

Conjunto de APIs: WordApiDesktop 1.4

autoFitBehavior(behavior)

Determina como o Microsoft Word redimensiona uma tabela quando o recurso de AutoAjuste é usado.

autoFitBehavior(behavior: Word.AutoFitBehavior): void;

Parâmetros

behavior: Word.AutoFitBehavior

Como o Word redimensiona a tabela especificada quando o recurso de AutoAjuste é usado.

Retornos

void

Comentários

Conjunto de APIs: WordApiDesktop 1.4

autoFitBehavior(behavior)

Determina como o Microsoft Word redimensiona uma tabela quando o recurso de AutoAjuste é usado.

autoFitBehavior(behavior: "FixedSize" | "Content" | "Window"): void;

Parâmetros

behavior: "FixedSize" | "Content" | "Window"

Como o Word redimensiona a tabela especificada quando o recurso de AutoAjuste é usado.

Retornos

void

Comentários

Conjunto de APIs: WordApiDesktop 1.4

autoFitWindow()

Autoajusta as colunas da tabela para a largura da janela.

autoFitWindow(): void;

Retornos

void

Comentários

Conjunto de APIs: WordApi 1.3

autoFormat(options)

Aplica uma aparência predefinida a uma tabela.

autoFormat(options?: Word.TableAutoFormatOptions): void;

Parâmetros

options: Word.TableAutoFormatOptions

Opcional. Um objeto que especifica as opções para aplicar o formato de tabela.

Retornos

void

Comentários

Conjunto de APIs: WordApiDesktop 1.4

clear()

Limpa o conteúdo da tabela.

clear(): void;

Retornos

void

Comentários

Conjunto de APIs: WordApi 1.3

convertToText(options)

Converte uma tabela em texto.

convertToText(options?: Word.TableConvertToTextOptions): Word.Range;

Parâmetros

options: Word.TableConvertToTextOptions

Opcional. Um objeto que especifica as opções para converter a tabela em texto.

Retornos

Word.Range

Um Range objeto que representa o texto convertido.

Comentários

Conjunto de APIs: WordApiDesktop 1.4

delete()

Exclui toda a tabela.

delete(): void;

Retornos

void

Comentários

Conjunto de APIs: WordApi 1.3

deleteColumns(columnIndex, columnCount)

Exclui colunas específicas. Isto é aplicável às tabelas uniformes.

deleteColumns(columnIndex: number, columnCount?: number): void;

Parâmetros

columnIndex: number

A primeira coluna a ser excluída.

columnCount: number

Opcional. O número de colunas a serem excluídas. Padrão 1.

Retornos

void

Comentários

Conjunto de APIs: WordApi 1.3

deleteRows(rowIndex, rowCount)

Exclui linha específicas.

deleteRows(rowIndex: number, rowCount?: number): void;

Parâmetros

rowIndex: number

A primeira linha a ser excluída.

rowCount: number

Opcional. O número de linhas a serem excluídas. Padrão 1.

Retornos

void

Comentários

Conjunto de APIs: WordApi 1.3

distributeColumns()

Distribui uniformemente a largura das colunas. Isto é aplicável às tabelas uniformes.

distributeColumns(): void;

Retornos

void

Comentários

Conjunto de APIs: WordApi 1.3

getBorder(borderLocation)

Obtém o estilo de borda para a borda especificada.

getBorder(borderLocation: Word.BorderLocation): Word.TableBorder;

Parâmetros

borderLocation: Word.BorderLocation

O local da fronteira.

Retornos

Word.TableBorder

Comentários

Conjunto de APIs: WordApi 1.3

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-formatting.yaml

// Gets border details about the first table in the document.
await Word.run(async (context) => {
  const firstTable: Word.Table = context.document.body.tables.getFirst();
  const borderLocation = Word.BorderLocation.top;
  const border: Word.TableBorder = firstTable.getBorder(borderLocation);
  border.load(["type", "color", "width"]);
  await context.sync();

  console.log(
    `Details about the ${borderLocation} border of the first table:`,
    `- Color: ${border.color}`,
    `- Type: ${border.type}`,
    `- Width: ${border.width} points`,
  );
});

getBorder(borderLocation)

Obtém o estilo de borda para a borda especificada.

getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder;

Parâmetros

borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"

O local da fronteira.

Retornos

Word.TableBorder

Comentários

Conjunto de APIs: WordApi 1.3

getCell(rowIndex, cellIndex)

Obtém a célula da tabela em uma linha e coluna especificada. Lançará um ItemNotFound erro se a célula da tabela especificada não existir.

getCell(rowIndex: number, cellIndex: number): Word.TableCell;

Parâmetros

rowIndex: number

O índice da linha.

cellIndex: number

O índice da célula na linha.

Retornos

Word.TableCell

Comentários

Conjunto de APIs: WordApi 1.3

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/table-cell-access.yaml

// Gets the content of the first cell in the first table.
await Word.run(async (context) => {
  const firstCell: Word.Body = context.document.body.tables.getFirst().getCell(0, 0).body;
  firstCell.load("text");

  await context.sync();
  console.log("First cell's text is: " + firstCell.text);
});

getCellOrNullObject(rowIndex, cellIndex)

Obtém a célula da tabela em uma linha e coluna especificada. Se a célula da tabela especificada não existir, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.

getCellOrNullObject(rowIndex: number, cellIndex: number): Word.TableCell;

Parâmetros

rowIndex: number

O índice da linha.

cellIndex: number

O índice da célula na linha.

Retornos

Word.TableCell

Comentários

Conjunto de APIs: WordApi 1.3

getCellPadding(cellPaddingLocation)

Obtém o preenchimento de célula em pontos.

getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult<number>;

Parâmetros

cellPaddingLocation: Word.CellPaddingLocation

O local de preenchimento da célula deve ser top,left ,bottom ou right.

Retornos

OfficeExtension.ClientResult<number>

Comentários

Conjunto de APIs: WordApi 1.3

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-formatting.yaml

// Gets cell padding details about the first table in the document.
await Word.run(async (context) => {
  const firstTable: Word.Table = context.document.body.tables.getFirst();
  const cellPaddingLocation = Word.CellPaddingLocation.right;
  const cellPadding = firstTable.getCellPadding(cellPaddingLocation);
  await context.sync();

  console.log(
    `Cell padding details about the ${cellPaddingLocation} border of the first table: ${cellPadding.value} points`,
  );
});

getCellPadding(cellPaddingLocation)

Obtém o preenchimento de célula em pontos.

getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult<number>;

Parâmetros

cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"

getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | "Whole" | "Start" | "End" | "After"): Word.Range;

Parâmetros

rangeLocation: whole | start | end | after | "Whole" | "Start" | "End" | "After"

Opcional. A localização do intervalo deve ser whole,start , end, ou .after

Retornos

Word.Range

Comentários

Conjunto de APIs: WordApi 1.3

insertContentControl()

Insere um controle de conteúdo na tabela.

insertContentControl(): Word.ContentControl;

Retornos

Word.ContentControl

Comentários

Conjunto de APIs: WordApi 1.3

insertParagraph(paragraphText, insertLocation)

Insere um parágrafo no local especificado.

insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;

Parâmetros

paragraphText: string

O texto do parágrafo a ser inserido.

insertLocation: before | after | "Before" | "After"

O valor deve ser before ou after.

Retornos

Word.Paragraph

Comentários

Conjunto de APIs: WordApi 1.3

insertTable(rowCount, columnCount, insertLocation, values)

Insere uma tabela com a quantidade especificada de linhas e colunas.

insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table;

Parâmetros

rowCount: number

O número de linhas na tabela.

columnCount: number

O número de colunas na tabela.

insertLocation: before | after | "Before" | "After"

O valor deve ser before ou after.

values: string[][]

Matriz 2D opcional. As células serão preenchidas se as cadeias de caracteres correspondentes estiverem especificadas na matriz.

Retornos

Word.Table

Comentários

Conjunto de APIs: WordApi 1.3

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(options?: Word.Interfaces.TableLoadOptions): Word.Table;

Parâmetros

options: Word.Interfaces.TableLoadOptions

Fornece opções para quais propriedades do objeto devem ser carregadas.

Retornos

Word.Table

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames?: string | string[]): Word.Table;

Parâmetros

propertyNames: string | string[]

Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especifica as propriedades a serem carregadas.

Retornos

Word.Table

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.Table;

Parâmetros

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades de navegação a serem carregadas.

Retornos

Word.Table

mergeCells(topRow, firstCell, bottomRow, lastCell)

Mescla as células limitadas inclusive pela primeira e última célula.

mergeCells(topRow: number, firstCell: number, bottomRow: number, lastCell: number): Word.TableCell;

Parâmetros

topRow: number

A linha da primeira célula.

firstCell: number

O índice da primeira célula da linha.

bottomRow: number

A linha da última célula.

lastCell: number

O índice da última célula da linha.

Retornos

Word.TableCell

Comentários

Conjunto de APIs: WordApi 1.4

reapplyAutoFormat()

Atualizações a tabela com as características do formato de tabela predefinido definido quando o autoFormat método foi chamado. O formato predefinido padrão é TableFormatType.none.

reapplyAutoFormat(): void;

Retornos

void

Comentários

Conjunto de APIs: WordApiDesktop 1.4

search(searchText, searchOptions)

Executa uma pesquisa com as opções de pesquisa especificadas no escopo do Table objeto. Os resultados da pesquisa são uma coleção de Range objetos.

search(searchText: string, searchOptions?: Word.SearchOptions | {
            ignorePunct?: boolean;
            ignoreSpace?: boolean;
            matchCase?: boolean;
            matchPrefix?: boolean;
            matchSuffix?: boolean;
            matchWholeWord?: boolean;
            matchWildcards?: boolean;
        }): Word.RangeCollection;

Parâmetros

searchText: string

O texto da pesquisa.

searchOptions: Word.SearchOptions | { ignorePunct?: boolean; ignoreSpace?: boolean; matchCase?: boolean; matchPrefix?: boolean; matchSuffix?: boolean; matchWholeWord?: boolean; matchWildcards?: boolean; }

Opcional. Opções da pesquisa.

Retornos

Word.RangeCollection

Comentários

Conjunto de APIs: WordApi 1.3

select(selectionMode)

Seleciona a tabela, ou então, a posição no início ou no final da tabela e navega na interface do usuário do Word até ela.

select(selectionMode?: Word.SelectionMode): void;

Parâmetros

selectionMode: Word.SelectionMode

Opcional. O modo de seleção deve ser select, start, ou end. select é o padrão.

Retornos

void

Comentários

Conjunto de APIs: WordApi 1.3

select(selectionMode)

Seleciona a tabela, ou então, a posição no início ou no final da tabela e navega na interface do usuário do Word até ela.

select(selectionMode?: "Select" | "Start" | "End"): void;

Parâmetros

selectionMode: "Select" | "Start" | "End"

Opcional. O modo de seleção deve ser select, start, ou end. select é o padrão.

Retornos

void

Comentários

Conjunto de APIs: WordApi 1.3

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.TableUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties: Word.Interfaces.TableUpdateData

Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.

options: OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir propriedades somente leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Word.Table): void;

Parâmetros

properties: Word.Table

Retornos

void

setCellPadding(cellPaddingLocation, cellPadding)

Define o preenchimento de célula em pontos.

setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void;

Parâmetros

cellPaddingLocation: Word.CellPaddingLocation

O local de preenchimento da célula deve ser top,left ,bottom ou right.

cellPadding: number

O preenchimento da célula.

Retornos

void

Comentários

Conjunto de APIs: WordApi 1.3

setCellPadding(cellPaddingLocation, cellPadding)

Define o preenchimento de célula em pontos.

setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void;

Parâmetros

cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"

O local de preenchimento da célula deve ser top,left ,bottom ou right.

cellPadding: number

O preenchimento da célula.

Retornos

void

Comentários

Conjunto de APIs: WordApi 1.3

sort(options)

Classifica a tabela especificada.

sort(options?: Word.TableSortOptions): void;

Parâmetros

options: Word.TableSortOptions

Opcional. Um objeto que especifica as opções para classificar a tabela.

Retornos

void

Comentários

Conjunto de APIs: WordApiDesktop 1.4

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Word.Table é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.TableData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): Word.Interfaces.TableData;

Retornos

Word.Interfaces.TableData

track()

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação de context.trackedObjects.add(thisObject). Se você estiver usando esse objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez. Se esse objeto fizer parte de uma coleção, você também deverá acompanhar a coleção pai.

track(): Word.Table;

Retornos

Word.Table

untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é a forma abreviada de context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Você precisará ligar context.sync() antes que a liberação de memória entre em vigor.

untrack(): Word.Table;

Retornos

Word.Table

Comentários

Usada por

Exemplos

Propriedades

Métodos

Detalhes da propriedade

alignment

Valor da propriedade

Comentários

Exemplos

columns

Valor da propriedade

Comentários

context

Valor da propriedade

description

Valor da propriedade

Comentários

endnotes

Valor da propriedade

Comentários

fields

Valor da propriedade

Comentários

font

Valor da propriedade

Comentários

footnotes

Valor da propriedade

Comentários

headerRowCount

Valor da propriedade

Comentários

horizontalAlignment

Valor da propriedade

Comentários

Exemplos

isUniform

Valor da propriedade

Comentários

nestingLevel

Valor da propriedade

Comentários

parentBody

Valor da propriedade

Comentários

parentContentControl

Valor da propriedade

Comentários

parentContentControlOrNullObject

Valor da propriedade

Comentários

parentTable

Valor da propriedade

Comentários

parentTableCell

Valor da propriedade

Comentários

parentTableCellOrNullObject

Valor da propriedade

Comentários

parentTableOrNullObject

Valor da propriedade

Comentários

rowCount

Valor da propriedade

Comentários

rows

Valor da propriedade

Comentários

Exemplos

shading

Valor da propriedade

Comentários

shadingColor

Valor da propriedade

Comentários

style

Valor da propriedade