Compartilhar via


Word.RepeatingSectionContentControl class

Representa o RepeatingSectionContentControl objeto .

Extends

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Propriedades

allowInsertDeleteSection

Especifica se os utilizadores podem adicionar ou remover secções deste controlo de conteúdo de secção de repetição utilizando a interface de utilizador.

appearance

Especifica o aspeto do controlo de conteúdo.

color

Especifica o valor vermelho-verde-azul (RGB) da cor do controlo de conteúdo. Pode fornecer o valor no formato "#RRGGBB".

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

id

Devolve a identificação do controlo de conteúdo.

isTemporary

Especifica se pretende remover o controlo de conteúdo do documento ativo quando o utilizador edita o conteúdo do controlo.

level

Devolve o nível do controlo de conteúdo , quer o controlo de conteúdo rodeie texto, parágrafos, células de tabela ou linhas de tabela; ou se estiver inline.

lockContentControl

Especifica se o controlo de conteúdo está bloqueado (não pode ser eliminado). true significa que o utilizador não pode eliminá-lo do documento ativo, false significa que pode ser eliminado.

lockContents

Especifica se o conteúdo do controlo de conteúdo está bloqueado (não editável). true significa que o utilizador não pode editar os conteúdos, false significa que os conteúdos são editáveis.

placeholderText

Devolve um BuildingBlock objeto que representa o texto do marcador de posição para o controlo de conteúdo.

range

Obtém um Range objeto que representa o conteúdo do controlo de conteúdo no documento ativo.

repeatingSectionItems

Devolve a coleção de itens de secção repetidos neste controlo de conteúdo de secção de repetição.

repeatingSectionItemTitle

Especifica o nome dos itens de secção de repetição utilizados no menu de contexto associado a este controlo de conteúdo de secção de repetição.

showingPlaceholderText

Devolve se o texto do marcador de posição do controlo de conteúdo está a ser apresentado.

tag

Especifica uma etiqueta para identificar o controlo de conteúdo.

title

Especifica o título do controlo de conteúdo.

xmlMapping

Devolve um XmlMapping objeto que representa o mapeamento do controlo de conteúdo para dados XML no arquivo de dados do documento.

Métodos

copy()

Copia o controle de conteúdo do documento ativo para a área de transferência.

cut()

Remove o controle de conteúdo do documento ativo e move o controle de conteúdo para a área de transferência.

delete(deleteContents)

Elimina o controlo de conteúdo e os conteúdos do controlo de conteúdo.

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.

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.

setPlaceholderText(options)

Define o texto do indicador exibido no controle de conteúdo até que um usuário digite seu próprio texto.

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.RepeatingSectionContentControl é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.RepeatingSectionContentControlData) 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

allowInsertDeleteSection

Especifica se os utilizadores podem adicionar ou remover secções deste controlo de conteúdo de secção de repetição utilizando a interface de utilizador.

allowInsertDeleteSection: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

appearance

Especifica o aspeto do controlo de conteúdo.

appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden";

Valor da propriedade

Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

color

Especifica o valor vermelho-verde-azul (RGB) da cor do controlo de conteúdo. Pode fornecer o valor no formato "#RRGGBB".

color: string;

Valor da propriedade

string

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

id

Devolve a identificação do controlo de conteúdo.

readonly id: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

isTemporary

Especifica se pretende remover o controlo de conteúdo do documento ativo quando o utilizador edita o conteúdo do controlo.

isTemporary: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

level

Devolve o nível do controlo de conteúdo , quer o controlo de conteúdo rodeie texto, parágrafos, células de tabela ou linhas de tabela; ou se estiver inline.

readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell";

Valor da propriedade

Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

lockContentControl

Especifica se o controlo de conteúdo está bloqueado (não pode ser eliminado). true significa que o utilizador não pode eliminá-lo do documento ativo, false significa que pode ser eliminado.

lockContentControl: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

lockContents

Especifica se o conteúdo do controlo de conteúdo está bloqueado (não editável). true significa que o utilizador não pode editar os conteúdos, false significa que os conteúdos são editáveis.

lockContents: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

placeholderText

Devolve um BuildingBlock objeto que representa o texto do marcador de posição para o controlo de conteúdo.

readonly placeholderText: Word.BuildingBlock;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

range

Obtém um Range objeto que representa o conteúdo do controlo de conteúdo no documento ativo.

readonly range: Word.Range;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

repeatingSectionItems

Devolve a coleção de itens de secção repetidos neste controlo de conteúdo de secção de repetição.

readonly repeatingSectionItems: Word.RepeatingSectionItemCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

repeatingSectionItemTitle

Especifica o nome dos itens de secção de repetição utilizados no menu de contexto associado a este controlo de conteúdo de secção de repetição.

repeatingSectionItemTitle: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

showingPlaceholderText

Devolve se o texto do marcador de posição do controlo de conteúdo está a ser apresentado.

readonly showingPlaceholderText: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

tag

Especifica uma etiqueta para identificar o controlo de conteúdo.

tag: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

title

Especifica o título do controlo de conteúdo.

title: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

xmlMapping

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Devolve um XmlMapping objeto que representa o mapeamento do controlo de conteúdo para dados XML no arquivo de dados do documento.

readonly xmlMapping: Word.XmlMapping;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Detalhes do método

copy()

Copia o controle de conteúdo do documento ativo para a área de transferência.

copy(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

cut()

Remove o controle de conteúdo do documento ativo e move o controle de conteúdo para a área de transferência.

cut(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

delete(deleteContents)

Elimina o controlo de conteúdo e os conteúdos do controlo de conteúdo.

delete(deleteContents?: boolean): void;

Parâmetros

deleteContents

boolean

Opcional. Se pretende eliminar os conteúdos dentro do controlo.

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.RepeatingSectionContentControlLoadOptions): Word.RepeatingSectionContentControl;

Parâmetros

options
Word.Interfaces.RepeatingSectionContentControlLoadOptions

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

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

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

Parâmetros

properties
Word.Interfaces.RepeatingSectionContentControlUpdateData

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

Parâmetros

Retornos

void

setPlaceholderText(options)

Define o texto do indicador exibido no controle de conteúdo até que um usuário digite seu próprio texto.

setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void;

Parâmetros

options
Word.ContentControlPlaceholderOptions

Opcional. As opções para configurar o texto do marcador de posição do controlo de conteúdo.

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

toJSON(): Word.Interfaces.RepeatingSectionContentControlData;

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

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

Retornos