Word.TextColumnCollection class
Uma coleção de Word. Objetos TextColumn que representam todas as colunas de texto no documento ou numa secção do documento.
- Extends
Comentários
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(options) | Devolve um |
| get |
Obtém a direção na qual o texto flui de uma coluna de texto para a seguinte. |
| get |
Obtém se as linhas verticais aparecem entre todas as colunas no |
| get |
Obtém se as colunas de texto estão uniformemente espaçados. |
| 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 |
Organiza texto no número especificado de colunas de texto. |
| set |
Define a direção em que o texto flui de uma coluna de texto para a seguinte. |
| set |
Define a direção em que o texto flui de uma coluna de texto para a seguinte. |
| set |
Define se as linhas verticais aparecem entre todas as colunas no |
| set |
Define se as colunas de texto estão uniformemente espaçados. |
| 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.TextColumn[];Valor da propriedade
Detalhes do método
add(options)
Devolve um TextColumn objeto que representa uma nova coluna de texto adicionada a uma secção ou documento.
add(options?: Word.TextColumnAddOptions): Word.TextColumn;Parâmetros
- options
- Word.TextColumnAddOptions
Opcional. Opções para configurar a nova coluna de texto.
Retornos
Um TextColumn objeto que representa uma nova coluna de texto adicionada ao documento.
Comentários
getFlowDirection()
Obtém a direção na qual o texto flui de uma coluna de texto para a seguinte.
getFlowDirection(): OfficeExtension.ClientResult<Word.FlowDirection>;Retornos
Comentários
getHasLineBetween()
Obtém se as linhas verticais aparecem entre todas as colunas no TextColumnCollection objeto.
getHasLineBetween(): OfficeExtension.ClientResult<boolean>;Retornos
OfficeExtension.ClientResult<boolean>
Comentários
getIsEvenlySpaced()
Obtém se as colunas de texto estão uniformemente espaçados.
getIsEvenlySpaced(): OfficeExtension.ClientResult<boolean>;Retornos
OfficeExtension.ClientResult<boolean>
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.TextColumnCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TextColumnCollection;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.TextColumnCollection;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.TextColumnCollection;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
setCount(numColumns)
Organiza texto no número especificado de colunas de texto.
setCount(numColumns: number): void;Parâmetros
- numColumns
-
number
O número de colunas nas quais o texto será organizado.
Retornos
void
Comentários
setFlowDirection(value)
Define a direção em que o texto flui de uma coluna de texto para a seguinte.
setFlowDirection(value: Word.FlowDirection): void;Parâmetros
- value
- Word.FlowDirection
A direção do fluxo a definir.
Retornos
void
Comentários
setFlowDirection(value)
Define a direção em que o texto flui de uma coluna de texto para a seguinte.
setFlowDirection(value: "LeftToRight" | "RightToLeft"): void;Parâmetros
- value
-
"LeftToRight" | "RightToLeft"
A direção do fluxo a definir.
Retornos
void
Comentários
setHasLineBetween(value)
Define se as linhas verticais aparecem entre todas as colunas no TextColumnCollection objeto.
setHasLineBetween(value: boolean): void;Parâmetros
- value
-
boolean
true para mostrar linhas verticais entre colunas.
Retornos
void
Comentários
setIsEvenlySpaced(value)
Define se as colunas de texto estão uniformemente espaçados.
setIsEvenlySpaced(value: boolean): void;Parâmetros
- value
-
boolean
true para espaçar uniformemente todas as colunas de texto no documento.
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.TextColumnCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.TextColumnCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.
toJSON(): Word.Interfaces.TextColumnCollectionData;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.TextColumnCollection;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.TextColumnCollection;