Word.TableCell class
Representa uma célula de 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/manage-formatting.yaml
// Gets content alignment details about the first cell 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();
const firstCell: Word.TableCell = firstTableRow.cells.getFirst();
firstCell.load(["horizontalAlignment", "verticalAlignment"]);
await context.sync();
console.log(`Details about the alignment of the first table's first cell:`, `- Horizontal alignment of the cell's content: ${firstCell.horizontalAlignment}`, `- Vertical alignment of the cell's content: ${firstCell.verticalAlignment}`);
});
Propriedades
| body | Obtém o |
| cell |
Obtém o índice da célula em sua linha. |
| column | Devolve o |
| column |
Especifica a largura da coluna da célula em pontos. Isto é aplicável às tabelas uniformes. |
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| horizontal |
Especifica o alinhamento horizontal da célula. O valor pode ser |
| parent |
Obtém a linha pai da célula. |
| parent |
Obtém a tabela pai da célula. |
| row |
Obtém o índice da linha da célula na tabela. |
| shading | Devolve o |
| shading |
Especifica a cor de sombreado da célula. Você pode definir a cor no formato "#RRGGBB" ou usando o nome da cor. |
| value | Especifica o texto da célula. |
| vertical |
Especifica o alinhamento vertical da célula. O valor pode ser |
| width | Obtém a largura da célula em pontos. |
Métodos
| auto |
Insere um campo = (Fórmula) que calcula e apresenta a soma dos valores nas células da tabela acima ou à esquerda da célula especificada na expressão. |
| delete(shift |
Elimina a célula da tabela e, opcionalmente, controla a forma como as células restantes são movidas. |
| delete |
Exclui a coluna que contém essa célula. Isto é aplicável às tabelas uniformes. |
| delete |
Exclui a linha que contém essa célula. |
| formula(options) | Insere um campo = (Fórmula) que contém a fórmula especificada numa célula de tabela. |
| 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 o preenchimento de célula em pontos. |
| get |
Obtém o preenchimento de célula em pontos. |
| get |
Obtém a próxima célula. Gera um |
| get |
Obtém a próxima célula. Se esta célula for a última, este método devolverá um objeto com a respetiva |
| insert |
Adiciona colunas à esquerda ou à direita da célula, usando a coluna da célula 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. |
| insert |
Insere linhas acima ou abaixo da célula, usando a linha da célula como um modelo. Os valores de cadeia de caracteres, se especificado, são definidos nas linhas recém-inseridas. |
| 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(merge |
Intercala esta célula de tabela com a célula de tabela especificada. |
| select() | Seleciona a célula da tabela. |
| 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. |
| split(row |
Divide a célula no número especificado de linhas e colunas. |
| 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
body
Obtém o Body objeto da célula.
readonly body: Word.Body;
Valor da propriedade
Comentários
cellIndex
Obtém o índice da célula em sua linha.
readonly cellIndex: number;
Valor da propriedade
number
Comentários
column
Devolve o TableColumn objeto que representa a coluna da tabela que contém esta célula.
readonly column: Word.TableColumn;
Valor da propriedade
Comentários
columnWidth
Especifica a largura da coluna da célula em pontos. Isto é aplicável às tabelas uniformes.
columnWidth: number;
Valor da propriedade
number
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
horizontalAlignment
Especifica o alinhamento horizontal da célula. 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 content alignment details about the first cell 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();
const firstCell: Word.TableCell = firstTableRow.cells.getFirst();
firstCell.load(["horizontalAlignment", "verticalAlignment"]);
await context.sync();
console.log(`Details about the alignment of the first table's first cell:`, `- Horizontal alignment of the cell's content: ${firstCell.horizontalAlignment}`, `- Vertical alignment of the cell's content: ${firstCell.verticalAlignment}`);
});
parentRow
Obtém a linha pai da célula.
readonly parentRow: Word.TableRow;
Valor da propriedade
Comentários
parentTable
Obtém a tabela pai da célula.
readonly parentTable: Word.Table;
Valor da propriedade
Comentários
rowIndex
Obtém o índice da linha da célula na tabela.
readonly rowIndex: number;
Valor da propriedade
number
Comentários
shading
Devolve o ShadingUniversal objeto que representa o sombreado da célula da tabela.
readonly shading: Word.ShadingUniversal;
Valor da propriedade
Comentários
shadingColor
Especifica a cor de sombreado da célula. Você pode definir a cor no formato "#RRGGBB" ou usando o nome da cor.
shadingColor: string;
Valor da propriedade
string
Comentários
value
Especifica o texto da célula.
value: string;
Valor da propriedade
string
Comentários
verticalAlignment
Especifica o alinhamento vertical da célula. 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 content alignment details about the first cell 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();
const firstCell: Word.TableCell = firstTableRow.cells.getFirst();
firstCell.load(["horizontalAlignment", "verticalAlignment"]);
await context.sync();
console.log(`Details about the alignment of the first table's first cell:`, `- Horizontal alignment of the cell's content: ${firstCell.horizontalAlignment}`, `- Vertical alignment of the cell's content: ${firstCell.verticalAlignment}`);
});
width
Obtém a largura da célula em pontos.
readonly width: number;
Valor da propriedade
number
Comentários
Detalhes do método
autoSum()
Insere um campo = (Fórmula) que calcula e apresenta a soma dos valores nas células da tabela acima ou à esquerda da célula especificada na expressão.
autoSum(): void;
Retornos
void
Comentários
delete(shiftCells)
Elimina a célula da tabela e, opcionalmente, controla a forma como as células restantes são movidas.
delete(shiftCells: any): void;
Parâmetros
- shiftCells
-
any
Opcional. Especifica como as células restantes são movidas após a eliminação. A predefinição é shiftLeft.
Retornos
void
Comentários
deleteColumn()
Exclui a coluna que contém essa célula. Isto é aplicável às tabelas uniformes.
deleteColumn(): void;
Retornos
void
Comentários
deleteRow()
Exclui a linha que contém essa célula.
deleteRow(): void;
Retornos
void
Comentários
formula(options)
Insere um campo = (Fórmula) que contém a fórmula especificada numa célula de tabela.
formula(options?: Word.TableCellFormulaOptions): void;
Parâmetros
- options
- Word.TableCellFormulaOptions
Opcional. Um objeto que especifica as opções para a fórmula.
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
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
[ 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 of the first table in the document.
await Word.run(async (context) => {
const firstTable: Word.Table = context.document.body.tables.getFirst();
const firstCell: Word.TableCell = firstTable.getCell(0, 0);
const borderLocation = "Left";
const border: Word.TableBorder = firstCell.getBorder(borderLocation);
border.load(["type", "color", "width"]);
await context.sync();
console.log(`Details about the ${borderLocation} border of the first table's first cell:`, `- Color: ${border.color}`, `- Type: ${border.type}`, `- Width: ${border.width} points`);
});
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
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
[ 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 cell of the first table in the document.
await Word.run(async (context) => {
const firstTable: Word.Table = context.document.body.tables.getFirst();
const firstCell: Word.TableCell = firstTable.getCell(0, 0);
const cellPaddingLocation = "Left";
const cellPadding = firstCell.getCellPadding(cellPaddingLocation);
await context.sync();
console.log(
`Cell padding details about the ${cellPaddingLocation} border of the first table's first cell: ${cellPadding.value} points`
);
});
getNext()
Obtém a próxima célula. Gera um ItemNotFound erro se esta célula for a última.
getNext(): Word.TableCell;
Retornos
Comentários
getNextOrNullObject()
Obtém a próxima célula. Se esta célula 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.TableCell;
Retornos
Comentários
insertColumns(insertLocation, columnCount, values)
Adiciona colunas à esquerda ou à direita da célula, usando a coluna da célula 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.
insertColumns(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", columnCount: number, values?: string[][]): void;
Parâmetros
- 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
insertRows(insertLocation, rowCount, values)
Insere linhas acima ou abaixo da célula, usando a linha da célula como um modelo. Os valores de cadeia de caracteres, se especificado, são definidos nas linhas recém-inseridas.
insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", 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
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.TableCellLoadOptions): Word.TableCell;
Parâmetros
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.TableCell;
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.TableCell;
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
merge(mergeTo)
Intercala esta célula de tabela com a célula de tabela especificada.
merge(mergeTo: Word.TableCell): void;
Parâmetros
- mergeTo
- Word.TableCell
A célula com a qual mesclar.
Retornos
void
Comentários
select()
Seleciona a célula da tabela.
select(): void;
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.TableCellUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parâmetros
- properties
- Word.Interfaces.TableCellUpdateData
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.TableCell): void;
Parâmetros
- properties
- Word.TableCell
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
split(rowCount, columnCount)
Divide a célula no número especificado de linhas e colunas.
split(rowCount: number, columnCount: number): void;
Parâmetros
- rowCount
-
number
O número de linhas para dividir. Tem de ser um divisor do número de linhas subjacentes.
- columnCount
-
number
O número de colunas para dividir.
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.TableCell é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.TableCellData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Word.Interfaces.TableCellData;
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.TableCell;
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.TableCell;