Word.Table class
Representa uma tabela num documento Word.
- Extends
Comentários
[ Conjunto de API: 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
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 de página. O valor pode ser |
| columns | Devolve o |
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã 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 |
| 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. |
| header |
Especifica o número de linhas de cabeçalho. |
| horizontal |
Especifica o alinhamento horizontal de cada célula na tabela. O valor pode ser |
| is |
Indica se todas as linhas de tabela são uniformes. |
| nesting |
Obtém o nível de aninhamento da tabela. Tabelas de nível superior têm o nível 1. |
| parent |
Obtém o corpo pai da tabela. |
| parent |
Obtém o controle de conteúdo que contém a tabela. Gera um |
| parent |
Obtém o controle de conteúdo que contém a tabela. Se não existir um controlo de conteúdo principal, este método devolverá um objeto com a respetiva |
| parent |
Obtém a tabela que contém esta tabela. Gera um |
| parent |
Obtém a célula de tabela que contém esta tabela. Gera um |
| parent |
Obtém a célula de tabela que contém esta tabela. Se não estiver contido numa célula de tabela, este método devolverá um objeto com a respetiva |
| parent |
Obtém a tabela que contém esta tabela. Se não estiver contido numa tabela, este método devolverá um objeto com a respetiva |
| row |
Obtém a quantidade de linhas na tabela. |
| rows | Obtém todas as linhas da tabela. |
| shading | Devolve o |
| shading |
Especifica a cor do sombreado. 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". |
| style |
Especifica se a tabela tem colunas listadas. |
| style |
Especifica se a tabela tem linhas listadas. |
| style |
Especifica o nome de estilo incorporado para a 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". |
| style |
Especifica se a tabela tem uma primeira coluna com um estilo especial. |
| style |
Especifica se a tabela tem uma última coluna com um estilo especial. |
| style |
Especifica se a tabela tem uma linha total (ú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 JavaScript 2D. |
| vertical |
Especifica o alinhamento vertical de cada célula na tabela. O valor pode ser |
| width | Especifica a largura da tabela em pontos. |
Métodos
| add |
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. |
| add |
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. |
| apply |
Aplica o estilo especificado, mas mantém qualquer formatação que um usuário aplique diretamente. |
| auto |
Determina como o Microsoft Word redimensiona uma tabela quando o recurso de AutoAjuste é usado. |
| auto |
Determina como o Microsoft Word redimensiona uma tabela quando o recurso de AutoAjuste é usado. |
| auto |
Autoajusta as colunas da tabela para a largura da janela. |
| auto |
Aplica uma aparência predefinida a uma tabela. |
| clear() | Limpa o conteúdo da tabela. |
| convert |
Converte uma tabela em texto. |
| delete() | Exclui toda a tabela. |
| delete |
Exclui colunas específicas. Isto é aplicável às tabelas uniformes. |
| delete |
Exclui linha específicas. |
| distribute |
Distribui uniformemente a largura das colunas. Isto é aplicável às tabelas uniformes. |
| get |
Obtém o estilo de borda para a borda especificada. |
| get |
Obtém o estilo de borda para a borda especificada. |
| get |
Obtém a célula da tabela em uma linha e coluna especificada. Gera um |
| get |
Obtém a célula da tabela em uma linha e coluna especificada. Se a célula de tabela especificada não existir, este método devolverá um objeto com a respetiva |
| get |
Obtém o preenchimento de célula em pontos. |
| get |
Obtém o preenchimento de célula em pontos. |
| get |
Obtém a próxima tabela. Gera um |
| get |
Obtém a próxima tabela. Se esta tabela for a última, este método devolverá um objeto com a respetiva |
| get |
Obtém o parágrafo após a tabela. Gera um |
| get |
Obtém o parágrafo após a tabela. Se não existir um parágrafo a seguir à tabela, este método devolverá um objeto com a respetiva |
| get |
Obtém o parágrafo antes da tabela. Gera um |
| get |
Obtém o parágrafo antes da tabela. Se não existir um parágrafo antes da tabela, este método devolverá um objeto com a respetiva |
| get |
Obtém o intervalo que contém esta tabela, ou o intervalo no início ou no final da tabela. |
| insert |
Insere um controle de conteúdo na tabela. |
| insert |
Insere um parágrafo no local especificado. |
| insert |
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 |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| merge |
Intercala as células delimitadas inclusivamente por uma primeira e última célula. |
| reapply |
Atualizações a tabela com as características do formato de tabela predefinido definido quando o |
| search(search |
Efetua uma pesquisa com as opções de pesquisa especificadas no âmbito do |
| select(selection |
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(selection |
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. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo. |
| set(properties) | Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente. |
| set |
Define o preenchimento de célula em pontos. |
| set |
Define o preenchimento de célula em pontos. |
| sort(options) | Classifica a tabela especificada. |
| toJSON() | Substitui o método JavaScript |
| track() | Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este objeto entre |
| untrack() | Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para 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. Terá de chamar |
Detalhes da propriedade
alignment
Especifica o alinhamento da tabela em relação à coluna de página. O valor pode ser left, centeredou right.
alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";
Valor da propriedade
Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"
Comentários
[ Conjunto de API: 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
Devolve o TableColumnCollection objeto que representa as colunas na tabela.
readonly columns: Word.TableColumnCollection;
Valor da propriedade
Comentários
context
O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
context: RequestContext;
Valor da propriedade
description
Especifica a descrição da tabela.
description: string;
Valor da propriedade
string
Comentários
endnotes
Obtém a coleção de notas de fim na tabela.
readonly endnotes: Word.NoteItemCollection;
Valor da propriedade
Comentários
fields
Obtém a coleção de Field objetos na tabela.
readonly fields: Word.FieldCollection;
Valor da propriedade
Comentários
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
Comentários
footnotes
Obtém a coleção de notas de rodapé na tabela.
readonly footnotes: Word.NoteItemCollection;
Valor da propriedade
Comentários
headerRowCount
Especifica o número de linhas de cabeçalho.
headerRowCount: number;
Valor da propriedade
number
Comentários
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
Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"
Comentários
[ Conjunto de API: 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
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
parentBody
Obtém o corpo pai da tabela.
readonly parentBody: Word.Body;
Valor da propriedade
Comentários
parentContentControl
Obtém o controle de conteúdo que contém a tabela. Gera um ItemNotFound erro se não existir um controlo de conteúdo principal.
readonly parentContentControl: Word.ContentControl;
Valor da propriedade
Comentários
parentContentControlOrNullObject
Obtém o controle de conteúdo que contém a tabela. Se não existir um controlo de conteúdo principal, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
readonly parentContentControlOrNullObject: Word.ContentControl;
Valor da propriedade
Comentários
parentTable
Obtém a tabela que contém esta tabela. Gera um ItemNotFound erro se não estiver contido numa tabela.
readonly parentTable: Word.Table;
Valor da propriedade
Comentários
parentTableCell
Obtém a célula de tabela que contém esta tabela. Gera um ItemNotFound erro se não estiver contido numa célula de tabela.
readonly parentTableCell: Word.TableCell;
Valor da propriedade
Comentários
parentTableCellOrNullObject
Obtém a célula de tabela que contém esta tabela. Se não estiver contido numa célula de tabela, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
readonly parentTableCellOrNullObject: Word.TableCell;
Valor da propriedade
Comentários
parentTableOrNullObject
Obtém a tabela que contém esta tabela. Se não estiver contido numa tabela, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
readonly parentTableOrNullObject: Word.Table;
Valor da propriedade
Comentários
rowCount
Obtém a quantidade de linhas na tabela.
readonly rowCount: number;
Valor da propriedade
number
Comentários
rows
Obtém todas as linhas da tabela.
readonly rows: Word.TableRowCollection;
Valor da propriedade
Comentários
[ Conjunto de API: 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
Devolve o ShadingUniversal objeto que representa o sombreado da tabela.
readonly shading: Word.ShadingUniversal;
Valor da propriedade
Comentários
shadingColor
Especifica a cor do sombreado. Você pode definir a cor no formato "#RRGGBB" ou usando o nome da cor.
shadingColor: string;
Valor da propriedade
string
Comentários
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
styleBandedColumns
Especifica se a tabela tem colunas listadas.
styleBandedColumns: boolean;
Valor da propriedade
boolean
Comentários
styleBandedRows
Especifica se a tabela tem linhas listadas.
styleBandedRows: boolean;
Valor da propriedade
boolean
Comentários
styleBuiltIn
Especifica o nome de estilo incorporado para a 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
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"
Comentários
styleFirstColumn
Especifica se a tabela tem uma primeira coluna com um estilo especial.
styleFirstColumn: boolean;
Valor da propriedade
boolean
Comentários
styleLastColumn
Especifica se a tabela tem uma última coluna com um estilo especial.
styleLastColumn: boolean;
Valor da propriedade
boolean
Comentários
styleTotalRow
Especifica se a tabela tem uma linha total (última) com um estilo especial.
styleTotalRow: boolean;
Valor da propriedade
boolean
Comentários
tables
Obtém as tabelas filho aninhadas em um nível mais profundo.
readonly tables: Word.TableCollection;
Valor da propriedade
Comentários
title
Especifica o título da tabela.
title: string;
Valor da propriedade
string
Comentários
values
Especifica os valores de texto na tabela, como uma matriz JavaScript 2D.
values: string[][];
Valor da propriedade
string[][]
Comentários
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 API: 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
Detalhes do método
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
Tem de ser start ou end, correspondente ao lado adequado da tabela.
- columnCount
-
number
Número de colunas a adicionar.
- 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
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
- rowCount
-
number
Número de linhas a adicionar.
- values
-
string[][]
Matriz 2D opcional. As células serão preenchidas se as cadeias de caracteres correspondentes estiverem especificadas na matriz.
Retornos
Comentários
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
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
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
autoFitWindow()
Autoajusta as colunas da tabela para a largura da janela.
autoFitWindow(): void;
Retornos
void
Comentários
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
clear()
Limpa o conteúdo da tabela.
clear(): void;
Retornos
void
Comentários
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
Um Range objeto que representa o texto convertido.
Comentários
delete()
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 eliminar.
- columnCount
-
number
Opcional. O número de colunas a eliminar. Predefinição 1.
Retornos
void
Comentários
deleteRows(rowIndex, rowCount)
Exclui linha específicas.
deleteRows(rowIndex: number, rowCount?: number): void;
Parâmetros
- rowIndex
-
number
A primeira linha a eliminar.
- rowCount
-
number
Opcional. O número de linhas a eliminar. Predefinição 1.
Retornos
void
Comentários
distributeColumns()
Distribui uniformemente a largura das colunas. Isto é aplicável às tabelas uniformes.
distributeColumns(): void;
Retornos
void
Comentários
getBorder(borderLocation)
Obtém o estilo de borda para a borda especificada.
getBorder(borderLocation: Word.BorderLocation): Word.TableBorder;
Parâmetros
- borderLocation
- Word.BorderLocation
A localização do limite.
Retornos
Comentários
[ Conjunto de API: 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"
A localização do limite.
Retornos
Comentários
getCell(rowIndex, cellIndex)
Obtém a célula da tabela em uma linha e coluna especificada. Gera 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
Comentários
[ Conjunto de API: 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 de tabela especificada não existir, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do 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
Comentários
getCellPadding(cellPaddingLocation)
Obtém o preenchimento de célula em pontos.
getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult<number>;
Parâmetros
- cellPaddingLocation
- Word.CellPaddingLocation
A localização do preenchimento da célula tem de ser top,left ,bottom ou .right
Retornos
OfficeExtension.ClientResult<number>
Comentários
[ Conjunto de API: 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"
A localização do preenchimento da célula tem de ser top,left ,bottom ou .right
Retornos
OfficeExtension.ClientResult<number>
Comentários
getNext()
Obtém a próxima tabela. Gera um ItemNotFound erro se esta tabela for a última.
getNext(): Word.Table;
Retornos
Comentários
getNextOrNullObject()
Obtém a próxima tabela. Se esta tabela for a última, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
getNextOrNullObject(): Word.Table;
Retornos
Comentários
getParagraphAfter()
Obtém o parágrafo após a tabela. Gera um ItemNotFound erro se não existir um parágrafo a seguir à tabela.
getParagraphAfter(): Word.Paragraph;
Retornos
Comentários
getParagraphAfterOrNullObject()
Obtém o parágrafo após a tabela. Se não existir um parágrafo a seguir à tabela, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
getParagraphAfterOrNullObject(): Word.Paragraph;
Retornos
Comentários
getParagraphBefore()
Obtém o parágrafo antes da tabela. Gera um ItemNotFound erro se não existir um parágrafo antes da tabela.
getParagraphBefore(): Word.Paragraph;
Retornos
Comentários
getParagraphBeforeOrNullObject()
Obtém o parágrafo antes da tabela. Se não existir um parágrafo antes da tabela, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
getParagraphBeforeOrNullObject(): Word.Paragraph;
Retornos
Comentários
getRange(rangeLocation)
Obtém o intervalo que contém esta tabela, ou o intervalo no início ou no final da tabela.
getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | "Whole" | "Start" | "End" | "After"): Word.Range;
Parâmetros
Opcional. A localização do intervalo tem de ser whole,start ,end ou .after
Retornos
Comentários
insertContentControl()
Insere um controle de conteúdo na tabela.
insertContentControl(): Word.ContentControl;
Retornos
Comentários
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.
Retornos
Comentários
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.
- values
-
string[][]
Matriz 2D opcional. As células serão preenchidas se as cadeias de caracteres correspondentes estiverem especificadas na matriz.
Retornos
Comentários
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 as propriedades do objeto a carregar.
Retornos
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 delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
Retornos
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 delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.
Retornos
mergeCells(topRow, firstCell, bottomRow, lastCell)
Intercala as células delimitadas inclusivamente por uma 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 na respetiva linha.
- bottomRow
-
number
A linha da última célula.
- lastCell
-
number
O índice da última célula na respetiva linha.
Retornos
Comentários
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 predefinido é TableFormatType.none.
reapplyAutoFormat(): void;
Retornos
void
Comentários
search(searchText, searchOptions)
Efetua uma pesquisa com as opções de pesquisa especificadas no âmbito 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
Comentários
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 tem de ser select, startou end.
select é a predefinição.
Retornos
void
Comentários
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 tem de ser select, startou end.
select é a predefinição.
Retornos
void
Comentários
set(properties, options)
Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas 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 que são estruturadas isomorfoticamente 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 quaisquer propriedades só de leitura.
Retornos
void
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base num 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
A localização do preenchimento da célula tem de ser top,left ,bottom ou .right
- cellPadding
-
number
O preenchimento da célula.
Retornos
void
Comentários
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"
A localização do preenchimento da célula tem de ser top,left ,bottom ou .right
- cellPadding
-
number
O preenchimento da célula.
Retornos
void
Comentários
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 ordenar a tabela.
Retornos
void
Comentários
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Word.Table é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.TableData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Word.Interfaces.TableData;
Retornos
track()
Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este 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, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez. Se este objeto fizer parte de uma coleção, também deve controlar a coleção principal.
track(): Word.Table;
Retornos
untrack()
Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para 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. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.
untrack(): Word.Table;