Word.BuildingBlock class
Representa um bloco de construção em um modelo. Um bloco de construção é um conteúdo pré-incorporado, similar ao autotexto, que pode conter texto, imagens e formatação.
- Extends
Comentários
Propriedades
| category | Devolve um |
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| description | Especifica a descrição do bloco modular. |
| id | Devolve o número de identificação interna do bloco modular. |
| index | Devolve a posição deste bloco modular numa coleção. |
| insert |
Especifica um |
| name | Especifica o nome do bloco de construção. |
| type | Devolve um |
| value | Especifica o conteúdo do bloco modular. |
Métodos
| delete() | Elimina o bloco modular. |
| insert(range, rich |
Insere o valor do bloco modular no documento e devolve um |
| 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. 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. |
| 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
category
Devolve um BuildingBlockCategory objeto que representa a categoria do bloco modular.
readonly category: Word.BuildingBlockCategory;Valor da propriedade
Comentários
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
description
Especifica a descrição do bloco modular.
description: string;Valor da propriedade
string
Comentários
id
Devolve o número de identificação interna do bloco modular.
readonly id: string;Valor da propriedade
string
Comentários
index
Devolve a posição deste bloco modular numa coleção.
readonly index: number;Valor da propriedade
number
Comentários
insertType
Especifica um DocPartInsertType valor que representa como inserir o conteúdo do bloco modular no documento.
insertType: Word.DocPartInsertType | "Content" | "Paragraph" | "Page";Valor da propriedade
Word.DocPartInsertType | "Content" | "Paragraph" | "Page"
Comentários
name
Especifica o nome do bloco de construção.
name: string;Valor da propriedade
string
Comentários
type
Devolve um BuildingBlockTypeItem objeto que representa o tipo para o bloco modular.
readonly type: Word.BuildingBlockTypeItem;Valor da propriedade
Comentários
value
Especifica o conteúdo do bloco modular.
value: string;Valor da propriedade
string
Comentários
Detalhes do método
delete()
Elimina o bloco modular.
delete(): void;Retornos
void
Comentários
insert(range, richText)
Insere o valor do bloco modular no documento e devolve um Range objeto que representa o conteúdo do bloco modular no documento.
insert(range: Word.Range, richText: boolean): Word.Range;Parâmetros
- range
- Word.Range
O intervalo onde o bloco modular deve ser inserido.
- richText
-
boolean
Indica se pretende inserir como texto formatado.
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.BuildingBlockLoadOptions): Word.BuildingBlock;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.BuildingBlock;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?: {
select?: string;
expand?: string;
}): Word.BuildingBlock;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
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.BuildingBlockUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- Word.Interfaces.BuildingBlockUpdateData
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.BuildingBlock): void;Parâmetros
- properties
- Word.BuildingBlock
Retornos
void
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.BuildingBlock é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.BuildingBlockData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Word.Interfaces.BuildingBlockData;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.BuildingBlock;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.BuildingBlock;