Word.CustomXmlNode class
Representa um nó XML numa árvore no documento. O CustomXmlNode objeto é um membro do Word. Objeto CustomXmlNodeCollection.
- Extends
Comentários
Propriedades
| attributes | Obtém um |
| base |
Obtém o nome de base do nó sem o prefixo do namespace, caso exista um. |
| child |
Obtém 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. |
| first |
Obtém um |
| last |
Obtém um |
| namespace |
Obtém o identificador de endereço exclusivo para o espaço de nomes do nó. |
| next |
Obtém o próximo nó irmão (elemento, comentário ou instrução de processamento) do nó atual. Se o nó for o último elemento colateral ao seu nível, a propriedade devolve |
| node |
Obtém o tipo de nó atual. |
| node |
Especifica o valor do nó atual. |
| owner |
Obtém o objeto representando a parte associada com este nó. |
| parent |
Obtém o pai de nó de elemento do nó atual. Se o nó atual estiver ao nível da raiz, a propriedade devolve |
| previous |
Obtém o nó irmão anterior (elemento, comentário ou instrução de processamento) do nó atual. Se o nó atual for o primeiro elemento colateral ao nível, a propriedade devolve |
| text | Especifica o texto do nó atual. |
| xml | Obtém a representação XML do nó atual e dos respetivos subordinados. |
| xpath | Obtém uma cadeia com o XPath canonizado para o nó atual. Se o nó não está mais no documento DOM (Object Model), a propriedade retornará uma mensagem de erro. |
Métodos
| append |
Anexa um único nó como último filho no nó do elemento contexto na árvore. |
| append |
Adiciona uma subárvore como último filho no nó do elemento contexto na árvore. |
| delete() | Exclui o nó atual da árvore (incluindo todos os seus filhos, se houver). |
| has |
Especifica se o nó do elemento atual tem nós de elemento subordinados. |
| insert |
Insere um novo nó de contexto antes do nó de contexto na árvore. |
| insert |
Insere a subárvore especificada no local, antes do nó de contexto. |
| 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 |
| remove |
Remove da árvore o nó filho especificado. |
| replace |
Remove o nó subordinado especificado e substitui-o por um nó diferente na mesma localização. |
| replace |
Remove o nó especificado e substitui-o por uma subárvore diferente na mesma localização. |
| select |
Seleciona uma coleção de nós que correspondem a uma expressão XPath. |
| select |
Seleciona um único nó de uma coleção de correspondência de uma expressão XPath. |
| 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
attributes
Obtém um CustomXmlNodeCollection objeto que representa os atributos do elemento atual no nó atual.
readonly attributes: Word.CustomXmlNodeCollection;Valor da propriedade
Comentários
baseName
Obtém o nome de base do nó sem o prefixo do namespace, caso exista um.
readonly baseName: string;Valor da propriedade
string
Comentários
childNodes
Obtém um CustomXmlNodeCollection objeto que contém todos os elementos subordinados do nó atual.
readonly childNodes: Word.CustomXmlNodeCollection;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
firstChild
Obtém um CustomXmlNode objeto correspondente ao primeiro elemento subordinado do nó atual. Se o nó não tiver elementos subordinados (ou se não for do tipo CustomXmlNodeType.element), devolve Nothing.
readonly firstChild: Word.CustomXmlNode;Valor da propriedade
Comentários
lastChild
Obtém um CustomXmlNode objeto correspondente ao último elemento subordinado do nó atual. Se o nó não tiver elementos subordinados (ou se não for do tipo CustomXmlNodeType.element), a propriedade devolve Nothing.
readonly lastChild: Word.CustomXmlNode;Valor da propriedade
Comentários
namespaceUri
Obtém o identificador de endereço exclusivo para o espaço de nomes do nó.
readonly namespaceUri: string;Valor da propriedade
string
Comentários
nextSibling
Obtém o próximo nó irmão (elemento, comentário ou instrução de processamento) do nó atual. Se o nó for o último elemento colateral ao seu nível, a propriedade devolve Nothing.
readonly nextSibling: Word.CustomXmlNode;Valor da propriedade
Comentários
nodeType
Obtém o tipo de nó atual.
readonly nodeType: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document";Valor da propriedade
Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"
Comentários
nodeValue
Especifica o valor do nó atual.
nodeValue: string;Valor da propriedade
string
Comentários
ownerPart
Obtém o objeto representando a parte associada com este nó.
readonly ownerPart: Word.CustomXmlPart;Valor da propriedade
Comentários
parentNode
Obtém o pai de nó de elemento do nó atual. Se o nó atual estiver ao nível da raiz, a propriedade devolve Nothing.
readonly parentNode: Word.CustomXmlNode;Valor da propriedade
Comentários
previousSibling
Obtém o nó irmão anterior (elemento, comentário ou instrução de processamento) do nó atual. Se o nó atual for o primeiro elemento colateral ao nível, a propriedade devolve Nothing.
readonly previousSibling: Word.CustomXmlNode;Valor da propriedade
Comentários
text
Especifica o texto do nó atual.
text: string;Valor da propriedade
string
Comentários
xml
Obtém a representação XML do nó atual e dos respetivos subordinados.
readonly xml: string;Valor da propriedade
string
Comentários
xpath
Obtém uma cadeia com o XPath canonizado para o nó atual. Se o nó não está mais no documento DOM (Object Model), a propriedade retornará uma mensagem de erro.
readonly xpath: string;Valor da propriedade
string
Comentários
Detalhes do método
appendChildNode(options)
Anexa um único nó como último filho no nó do elemento contexto na árvore.
appendChildNode(options?: Word.CustomXmlAppendChildNodeOptions): OfficeExtension.ClientResult<number>;Parâmetros
Opcional. As opções que definem o nó a acrescentar.
Retornos
OfficeExtension.ClientResult<number>
Comentários
appendChildSubtree(xml)
Adiciona uma subárvore como último filho no nó do elemento contexto na árvore.
appendChildSubtree(xml: string): OfficeExtension.ClientResult<number>;Parâmetros
- xml
-
string
Uma cadeia que representa a subárvore XML.
Retornos
OfficeExtension.ClientResult<number>
Comentários
delete()
Exclui o nó atual da árvore (incluindo todos os seus filhos, se houver).
delete(): void;Retornos
void
Comentários
hasChildNodes()
Especifica se o nó do elemento atual tem nós de elemento subordinados.
hasChildNodes(): OfficeExtension.ClientResult<boolean>;Retornos
OfficeExtension.ClientResult<boolean>
Comentários
insertNodeBefore(options)
Insere um novo nó de contexto antes do nó de contexto na árvore.
insertNodeBefore(options?: Word.CustomXmlInsertNodeBeforeOptions): OfficeExtension.ClientResult<number>;Parâmetros
Opcional. As opções que definem o nó a inserir.
Retornos
OfficeExtension.ClientResult<number>
Comentários
insertSubtreeBefore(xml, options)
Insere a subárvore especificada no local, antes do nó de contexto.
insertSubtreeBefore(xml: string, options?: Word.CustomXmlInsertSubtreeBeforeOptions): OfficeExtension.ClientResult<number>;Parâmetros
- xml
-
string
Uma cadeia que representa a subárvore XML.
Opcional. As opções disponíveis para inserir a subárvore.
Retornos
OfficeExtension.ClientResult<number>
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.CustomXmlNodeLoadOptions): Word.CustomXmlNode;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.CustomXmlNode;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.CustomXmlNode;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
removeChild(child)
Remove da árvore o nó filho especificado.
removeChild(child: Word.CustomXmlNode): OfficeExtension.ClientResult<number>;Parâmetros
- child
- Word.CustomXmlNode
O nó subordinado a remover.
Retornos
OfficeExtension.ClientResult<number>
Comentários
replaceChildNode(oldNode, options)
Remove o nó subordinado especificado e substitui-o por um nó diferente na mesma localização.
replaceChildNode(oldNode: Word.CustomXmlNode, options?: Word.CustomXmlReplaceChildNodeOptions): OfficeExtension.ClientResult<number>;Parâmetros
- oldNode
- Word.CustomXmlNode
O nó a ser substituído.
Opcional. As opções que definem o nó subordinado que consiste em substituir o nó antigo.
Retornos
OfficeExtension.ClientResult<number>
Comentários
replaceChildSubtree(xml, oldNode)
Remove o nó especificado e substitui-o por uma subárvore diferente na mesma localização.
replaceChildSubtree(xml: string, oldNode: Word.CustomXmlNode): OfficeExtension.ClientResult<number>;Parâmetros
- xml
-
string
Uma cadeia que representa a nova subárvore.
- oldNode
- Word.CustomXmlNode
O nó a ser substituído.
Retornos
OfficeExtension.ClientResult<number>
Comentários
selectNodes(xPath)
Seleciona uma coleção de nós que correspondem a uma expressão XPath.
selectNodes(xPath: string): Word.CustomXmlNodeCollection;Parâmetros
- xPath
-
string
A expressão XPath.
Retornos
Comentários
selectSingleNode(xPath)
Seleciona um único nó de uma coleção de correspondência de uma expressão XPath.
selectSingleNode(xPath: string): Word.CustomXmlNode;Parâmetros
- xPath
-
string
A expressão XPath.
Retornos
Comentários
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.CustomXmlNodeUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- Word.Interfaces.CustomXmlNodeUpdateData
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.CustomXmlNode): void;Parâmetros
- properties
- Word.CustomXmlNode
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.CustomXmlNode é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.CustomXmlNodeData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Word.Interfaces.CustomXmlNodeData;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.CustomXmlNode;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.CustomXmlNode;