Compartilhar via


Word.TableColumnCollection class

Representa uma coleção de Word. Objetos TableColumn num documento Word.

Extends

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

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

add(beforeColumn)

Devolve um TableColumn objeto que representa uma coluna adicionada a uma tabela.

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.

delete()

Exclui as colunas especificadas.

distributeWidth()

Ajusta a largura das colunas especificadas para que sejam iguais.

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.

select()

Seleciona as colunas da tabela especificada.

setWidth(columnWidth, rulerStyle)

Define a largura das colunas em uma tabela.

setWidth(columnWidth, rulerStyle)

Define a largura das colunas em uma tabela.

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.TableColumnCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.TableColumnCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

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.

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.

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.TableColumn[];

Valor da propriedade

Detalhes do método

add(beforeColumn)

Devolve um TableColumn objeto que representa uma coluna adicionada a uma tabela.

add(beforeColumn?: Word.TableColumn): Word.TableColumn;

Parâmetros

beforeColumn
Word.TableColumn

Opcional. A coluna antes da qual a nova coluna é adicionada.

Retornos

Um novo TableColumn objeto.

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

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

[ Conjunto de API: WordApiDesktop 1.3 ]

delete()

Exclui as colunas especificadas.

delete(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

distributeWidth()

Ajusta a largura das colunas especificadas para que sejam iguais.

distributeWidth(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 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.TableColumnCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableColumnCollection;

Parâmetros

options

Word.Interfaces.TableColumnCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions

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.TableColumnCollection;

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.TableColumnCollection;

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

select()

Seleciona as colunas da tabela especificada.

select(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

setWidth(columnWidth, rulerStyle)

Define a largura das colunas em uma tabela.

setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void;

Parâmetros

columnWidth

number

A largura a definir.

rulerStyle
Word.RulerStyle

O estilo da régua a aplicar.

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

setWidth(columnWidth, rulerStyle)

Define a largura das colunas em uma tabela.

setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void;

Parâmetros

columnWidth

number

A largura a definir.

rulerStyle

"None" | "Proportional" | "FirstColumn" | "SameWidth"

O estilo da régua a aplicar.

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

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.TableColumnCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.TableColumnCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

toJSON(): Word.Interfaces.TableColumnCollectionData;

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.TableColumnCollection;

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.TableColumnCollection;

Retornos