Word.TableCell class
Representa uma célula de tabela em um 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
// Gets the content of the first cell in the first table.
await Word.run(async (context) => {
const firstCell = context.document.body.tables.getFirst().getCell(0, 0).body;
firstCell.load("text");
await context.sync();
console.log("First cell's text is: " + firstCell.text);
});
Propriedades
| body | Obtém o objeto do corpo da célula. |
| cell |
Obtém o índice da célula em sua linha. |
| column |
Especifica a largura da coluna da célula em pontos. Isto é aplicável às tabelas uniformes. |
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
| horizontal |
Especifica o alinhamento horizontal da célula. O valor pode ser 'Left', 'Centered', 'Right' ou 'Justified'. |
| 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 |
Especifica a cor de sombreamento 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 'Top', 'Center' ou 'Bottom'. |
| width | Obtém a largura da célula em pontos. |
Métodos
| 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. |
| 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. Gerará um |
| get |
Obtém a próxima célula. Se essa célula for a última, esse método retornará um objeto com sua |
| 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 |
| 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. |
| 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. Essa chamada é uma abreviação para context.trackedObjects.add(thisObject). Se você estiver usando esse objeto entre |
| untrack() | Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa 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. Você precisará chamar |
Detalhes da propriedade
body
Obtém o objeto do corpo 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
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 de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
context: RequestContext;Valor da propriedade
horizontalAlignment
Especifica o alinhamento horizontal da célula. O valor pode ser 'Left', 'Centered', 'Right' ou '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 = context.document.body.tables.getFirst();
const firstCell = firstTable.getCell(0, 0);
firstCell.load(["horizontalAlignment", "verticalAlignment"]);
await context.sync();
console.log(`Details about the alignment of the first table's first cell:`);
console.log(`- Horizontal alignment of the cell's content: ${firstCell.horizontalAlignment}`);
console.log(`- 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
shadingColor
Especifica a cor de sombreamento 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', 'Center' ou '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 = context.document.body.tables.getFirst();
const firstCell = firstTable.getCell(0, 0);
firstCell.load(["horizontalAlignment", "verticalAlignment"]);
await context.sync();
console.log(`Details about the alignment of the first table's first cell:`);
console.log(`- Horizontal alignment of the cell's content: ${firstCell.horizontalAlignment}`);
console.log(`- 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
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
getBorder(borderLocation)
Obtém o estilo de borda para a borda especificada.
getBorder(borderLocation: Word.BorderLocation): Word.TableBorder;Parâmetros
- borderLocation
- Word.BorderLocation
Obrigatório. O local da borda.
Retornos
Comentários
getBorder(borderLocationString)
Obtém o estilo de borda para a borda especificada.
getBorder(borderLocationString: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder;Parâmetros
- borderLocationString
-
"Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"
Obrigatório. O local da borda.
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 = context.document.body.tables.getFirst();
const firstCell = firstTable.getCell(0, 0);
const borderLocation = "Left";
const border = 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:`);
console.log(`- Color: ${border.color}`);
console.log(`- Type: ${border.type}`);
console.log(`- 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
Obrigatório. O local de preenchimento da célula deve ser 'Top', 'Left', 'Bottom' ou 'Right'.
Retornos
OfficeExtension.ClientResult<number>
Comentários
getCellPadding(cellPaddingLocationString)
Obtém o preenchimento de célula em pontos.
getCellPadding(cellPaddingLocationString: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult<number>;Parâmetros
- cellPaddingLocationString
-
"Top" | "Left" | "Bottom" | "Right"
Obrigatório. O local de preenchimento da célula deve 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 = context.document.body.tables.getFirst();
const firstCell = 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. Gerará um ItemNotFound erro se essa célula for a última.
getNext(): Word.TableCell;Retornos
Comentários
getNextOrNullObject()
Obtém a próxima célula. Se essa célula for a última, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades 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
Obrigatório. 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
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
Obrigatório. 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
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 quais propriedades do objeto 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 de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.
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 de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.
Retornos
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.TableCellUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- Word.Interfaces.TableCellUpdateData
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 properties tentar definir quaisquer 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.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
Obrigatório. O local de preenchimento da célula deve ser 'Top', 'Left', 'Bottom' ou 'Right'.
- cellPadding
-
number
Obrigatório. O preenchimento da célula.
Retornos
void
Comentários
setCellPadding(cellPaddingLocationString, cellPadding)
Define o preenchimento de célula em pontos.
setCellPadding(cellPaddingLocationString: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void;Parâmetros
- cellPaddingLocationString
-
"Top" | "Left" | "Bottom" | "Right"
Obrigatório. O local de preenchimento da célula deve ser 'Top', 'Left', 'Bottom' ou 'Right'.
- cellPadding
-
number
Obrigatório. 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
Obrigatório. O número de linhas para dividir. Deve ser um divisor do número de linhas subjacentes.
- columnCount
-
number
Obrigatório. O número de colunas a serem divididas.
Retornos
void
Comentários
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o Word original. O objeto TableCell é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.TableCellData) que contém cópias rasas de todas as propriedades filho 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. Essa chamada é uma abreviação para 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, você 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.TableCell;Retornos
untrack()
Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa 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. Você precisará chamar context.sync() antes que a versão da memória entre em vigor.
untrack(): Word.TableCell;Retornos
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de