Compartilhar via

Word.XmlMapping class

Pacote:
word

Representa o mapeamento XML num Word. Objeto ContentControl entre XML personalizado e esse controlo de conteúdo. Um mapeamento XML é um vínculo entre o texto em um controle de conteúdo e um elemento XML no repositório de dados XML personalizado para esse documento.

Extends
OfficeExtension.ClientObject

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.
customXmlNode

Devolve um CustomXmlNode objeto que representa o nó XML personalizado no arquivo de dados ao qual o controlo de conteúdo no documento mapeia.
customXmlPart

Devolve um CustomXmlPart objeto que representa a parte XML personalizada à qual o controlo de conteúdo no documento mapeia.
isMapped

Devolve se o controlo de conteúdo no documento está mapeado para um nó XML no arquivo de dados XML do documento.
prefixMappings

Devolve os mapeamentos de prefixos utilizados para avaliar o XPath para o mapeamento XML atual.
xpath

Devolve o XPath para o mapeamento XML, que é avaliado como o nó XML atualmente mapeado.

Métodos

delete()

Exclui o mapeamento XML do controle de conteúdo pai.
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.
setMapping(xPath, options)

Permite criar ou alterar o mapeamento XML no controlo de conteúdo.
setMappingByNode(node)

Permite criar ou alterar o mapeamento de dados XML no controlo de conteúdo.
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.XmlMapping é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.XmlMappingData) 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

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

customXmlNode

Devolve um CustomXmlNode objeto que representa o nó XML personalizado no arquivo de dados ao qual o controlo de conteúdo no documento mapeia.

readonly customXmlNode: Word.CustomXmlNode;

Valor da propriedade

Word.CustomXmlNode

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

customXmlPart

Devolve um CustomXmlPart objeto que representa a parte XML personalizada à qual o controlo de conteúdo no documento mapeia.

readonly customXmlPart: Word.CustomXmlPart;

Valor da propriedade

Word.CustomXmlPart

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

isMapped

Devolve se o controlo de conteúdo no documento está mapeado para um nó XML no arquivo de dados XML do documento.

readonly isMapped: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

prefixMappings

Devolve os mapeamentos de prefixos utilizados para avaliar o XPath para o mapeamento XML atual.

readonly prefixMappings: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

xpath

Devolve o XPath para o mapeamento XML, que é avaliado como o nó XML atualmente mapeado.

readonly xpath: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Detalhes do método

delete()

Exclui o mapeamento XML do controle de conteúdo pai.

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.XmlMappingLoadOptions): Word.XmlMapping;

Parâmetros

options
Word.Interfaces.XmlMappingLoadOptions

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

Retornos

Word.XmlMapping

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

Parâmetros

propertyNames

string | string[]

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

Retornos

Word.XmlMapping

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

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.XmlMapping

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

Parâmetros

properties
Word.Interfaces.XmlMappingUpdateData

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

Parâmetros

properties
Word.XmlMapping

Retornos

void

setMapping(xPath, options)

Permite criar ou alterar o mapeamento XML no controlo de conteúdo.

setMapping(xPath: string, options?: Word.XmlSetMappingOptions): OfficeExtension.ClientResult<boolean>;

Parâmetros

xPath

string

A expressão XPath a avaliar.

options
Word.XmlSetMappingOptions

Opcional. As opções disponíveis para definir o mapeamento XML.

Retornos

OfficeExtension.ClientResult<boolean>

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

setMappingByNode(node)

Permite criar ou alterar o mapeamento de dados XML no controlo de conteúdo.

setMappingByNode(node: Word.CustomXmlNode): OfficeExtension.ClientResult<boolean>;

Parâmetros

node
Word.CustomXmlNode

O nó XML personalizado a mapear.

Retornos

OfficeExtension.ClientResult<boolean>

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

toJSON(): Word.Interfaces.XmlMappingData;

Retornos

Word.Interfaces.XmlMappingData

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

Retornos

Word.XmlMapping

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

Retornos

Word.XmlMapping