Word.TableCellCollection class
Contém a coleção do Word do documento. Objetos TableCell.
- 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
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| items | Obtém os itens filhos carregados nesta coleção. |
Métodos
| auto |
Altera a largura de uma coluna de tabela para acomodar a largura do texto sem alterar a disposição do texto nas células. |
| delete(shift |
Elimina as células da tabela e, opcionalmente, controla a forma como as células restantes são movidas. |
| delete(shift |
Elimina as células da tabela e, opcionalmente, controla a forma como as células restantes são movidas. |
| distribute |
Ajusta a altura das células especificadas para que sejam iguais. |
| distribute |
Ajusta a largura das células especificadas para que sejam iguais. |
| get |
Obtém a primeira célula da tabela nesta coleção. Gera um |
| get |
Obtém a primeira célula da tabela nesta coleção. Se esta coleção estiver vazia, este método devolverá um objeto com a respetiva |
| 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 especificadas numa única célula. |
| set |
Define a altura das células numa tabela. |
| set |
Define a altura das células numa tabela. |
| set |
Define a largura das células numa tabela. |
| set |
Define a largura das células numa tabela. |
| split(options) | Divide este intervalo de células de tabela. |
| 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
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
items
Obtém os itens filhos carregados nesta coleção.
readonly items: Word.TableCell[];Valor da propriedade
Detalhes do método
autoFit()
Altera a largura de uma coluna de tabela para acomodar a largura do texto sem alterar a disposição do texto nas células.
autoFit(): void;Retornos
void
Comentários
delete(shiftCells)
Elimina as células da tabela e, opcionalmente, controla a forma como as células restantes são movidas.
delete(shiftCells?: Word.DeleteCells): void;Parâmetros
- shiftCells
- Word.DeleteCells
Opcional. Especifica como as células restantes são movidas após a eliminação. A predefinição é shiftLeft.
Retornos
void
Comentários
delete(shiftCells)
Elimina as células da tabela e, opcionalmente, controla a forma como as células restantes são movidas.
delete(shiftCells?: "ShiftLeft" | "ShiftUp" | "EntireRow" | "EntireColumn"): void;Parâmetros
- shiftCells
-
"ShiftLeft" | "ShiftUp" | "EntireRow" | "EntireColumn"
Opcional. Especifica como as células restantes são movidas após a eliminação. A predefinição é shiftLeft.
Retornos
void
Comentários
distributeHeight()
Ajusta a altura das células especificadas para que sejam iguais.
distributeHeight(): void;Retornos
void
Comentários
distributeWidth()
Ajusta a largura das células especificadas para que sejam iguais.
distributeWidth(): void;Retornos
void
Comentários
getFirst()
Obtém a primeira célula da tabela nesta coleção. Gera um ItemNotFound erro se esta coleção estiver vazia.
getFirst(): Word.TableCell;Retornos
Comentários
getFirstOrNullObject()
Obtém a primeira célula da tabela nesta coleção. Se esta coleção estiver vazia, 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).
getFirstOrNullObject(): Word.TableCell;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.TableCellCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableCellCollection;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.TableCellCollection;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?: OfficeExtension.LoadOption): Word.TableCellCollection;Parâmetros
- propertyNamesAndPaths
- OfficeExtension.LoadOption
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()
Intercala as células especificadas numa única célula.
merge(): void;Retornos
void
Comentários
setHeight(rowHeight, heightRule)
Define a altura das células numa tabela.
setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void;Parâmetros
- rowHeight
-
number
A altura da linha a definir, em pontos.
- heightRule
- Word.RowHeightRule
A regra para determinação da altura das células especificadas.
Retornos
void
Comentários
setHeight(rowHeight, heightRule)
Define a altura das células numa tabela.
setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | "Exactly"): void;Parâmetros
- rowHeight
-
number
A altura da linha a definir, em pontos.
- heightRule
-
"Auto" | "AtLeast" | "Exactly"
A regra para determinação da altura das células especificadas.
Retornos
void
Comentários
setWidth(columnWidth, rulerStyle)
Define a largura das células numa tabela.
setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void;Parâmetros
- columnWidth
-
number
A largura da linha a definir, em pontos.
- rulerStyle
- Word.RulerStyle
O estilo da régua a aplicar.
Retornos
void
Comentários
setWidth(columnWidth, rulerStyle)
Define a largura das células numa tabela.
setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void;Parâmetros
- columnWidth
-
number
A largura da linha a definir, em pontos.
- rulerStyle
-
"None" | "Proportional" | "FirstColumn" | "SameWidth"
O estilo da régua a aplicar.
Retornos
void
Comentários
split(options)
Divide este intervalo de células de tabela.
split(options?: Word.TableCellCollectionSplitOptions): void;Parâmetros
Opcional. Opções para dividir as células da 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.TableCellCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.TableCellCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.
toJSON(): Word.Interfaces.TableCellCollectionData;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.TableCellCollection;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.TableCellCollection;