Word.TableColumn class

Pacote:

word

Representa uma coluna de tabela num documento Word.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Propriedades

borders	Devolve um BorderUniversalCollection objeto que representa todos os limites da coluna da tabela.
columnIndex	Devolve a posição desta coluna numa coleçã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.
isFirst	Devolve true se a coluna ou linha for a primeira na tabela; false caso contrário.
isLast	Devolve true se a coluna ou linha for a última na tabela; false caso contrário.
nestingLevel	Devolve o nível de aninhamento da coluna.
preferredWidth	Especifica a largura preferencial (em pontos ou como uma percentagem da largura da janela) para a coluna. A unidade de medida pode ser especificada pela preferredWidthType propriedade .
preferredWidthType	Especifica a unidade de medida preferencial a utilizar para a largura da coluna da tabela.
shading	Devolve um ShadingUniversal objeto que se refere à formatação de sombreado da coluna.
width	Especifica a largura da coluna, em pontos.

Métodos

autoFit()	Altera a largura da coluna da tabela para acomodar a largura do texto sem alterar a forma como o texto molda nas células.
delete()	Elimina a coluna.
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 a coluna 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.
setWidth(columnWidth, rulerStyle)	Define a largura da coluna numa tabela.
setWidth(columnWidth, rulerStyle)	Define a largura da coluna numa tabela.
sort()	Ordena a coluna da 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.TableColumn é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.TableColumnData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
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

borders

Devolve um BorderUniversalCollection objeto que representa todos os limites da coluna da tabela.

readonly borders: Word.BorderUniversalCollection;

Valor da propriedade

Word.BorderUniversalCollection

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

columnIndex

Devolve a posição desta coluna numa coleção.

readonly columnIndex: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

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

Word.RequestContext

isFirst

Devolve true se a coluna ou linha for a primeira na tabela; false caso contrário.

readonly isFirst: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

isLast

Devolve true se a coluna ou linha for a última na tabela; false caso contrário.

readonly isLast: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

nestingLevel

Devolve o nível de aninhamento da coluna.

readonly nestingLevel: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

preferredWidth

Especifica a largura preferencial (em pontos ou como uma percentagem da largura da janela) para a coluna. A unidade de medida pode ser especificada pela preferredWidthType propriedade .

preferredWidth: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

preferredWidthType

Especifica a unidade de medida preferencial a utilizar para a largura da coluna da tabela.

preferredWidthType: Word.PreferredWidthType | "Auto" | "Percent" | "Points";

Valor da propriedade

Word.PreferredWidthType | "Auto" | "Percent" | "Points"

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

shading

Devolve um ShadingUniversal objeto que se refere à formatação de sombreado da coluna.

readonly shading: Word.ShadingUniversal;

Valor da propriedade

Word.ShadingUniversal

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

width

Especifica a largura da coluna, em pontos.

width: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Detalhes do método

autoFit()

Altera a largura da coluna da tabela para acomodar a largura do texto sem alterar a forma como o texto molda nas células.

autoFit(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

delete()

Elimina a coluna.

delete(): 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.TableColumnLoadOptions): Word.TableColumn;

Parâmetros

options

Word.Interfaces.TableColumnLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

Word.TableColumn

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

Parâmetros

propertyNames

string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

Word.TableColumn

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

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

Word.TableColumn

select()

Seleciona a coluna da tabela.

select(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

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.TableColumnUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties

Word.Interfaces.TableColumnUpdateData

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.TableColumn): void;

Parâmetros

properties

Word.TableColumn

Retornos

void

setWidth(columnWidth, rulerStyle)

Define a largura da coluna numa 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 da coluna numa 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 ]

sort()

Ordena a coluna da tabela.

sort(): void;

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.TableColumn é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.TableColumnData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Word.Interfaces.TableColumnData;

Retornos

Word.Interfaces.TableColumnData

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

Retornos

Word.TableColumn

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

Retornos

Word.TableColumn