Word.XmlNode class

Obtém os atributos para este nó XML. Devolve null se o tipo de nó for attribute.

readonly attributes: Word.XmlNodeCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém o nome do elemento sem qualquer prefixo.

readonly baseName: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém os elementos subordinados deste nó XML. Devolve uma coleção vazia se o tipo de nó for attribute.

readonly childNodes: Word.XmlNodeCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

Obtém o primeiro nó subordinado se este for um nó principal. Devolve null se o tipo de nó for attribute.

readonly firstChild: Word.XmlNode;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém se este nó XML tem nós subordinados. false Devolve sempre para nós de atributo, uma vez que não podem ter subordinados.

readonly hasChildNodes: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém o último nó subordinado se for um nó principal. Devolve null se o tipo de nó for attribute.

readonly lastChild: Word.XmlNode;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém se este elemento XML faz parte de um parágrafo, é um parágrafo ou está contido numa célula de tabela ou contém uma linha de tabela. Devolve null se o tipo de nó for attribute.

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

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém o Uniform Resource Identifier (URI) do espaço de nomes de esquema para este nó XML.

readonly namespaceUri: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém o elemento seguinte no documento que está no mesmo nível que este nó XML. Devolve null se o tipo de nó for attribute.

readonly nextSibling: Word.XmlNode;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém o documento principal deste nó XML.

readonly ownerDocument: Word.Document;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém o elemento principal deste nó XML.

readonly parentNode: Word.XmlNode;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica o texto apresentado para este elemento se não contiver texto. Aplica-se apenas a nós de elementos e não a nós de atributo.

placeholderText: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém o elemento anterior no documento que está no mesmo nível que este nó XML. Devolve null se o tipo de nó for attribute.

readonly previousSibling: Word.XmlNode;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém a parte de um documento que está contida neste nó XML. Devolve null se o tipo de nó for attribute.

readonly range: Word.Range;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica o texto contido no elemento XML. Devolve uma cadeia vazia se o tipo de nó for attribute.

text: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém o tipo de nó.

readonly type: Word.XmlNodeType | "Element" | "Attribute";

Valor da propriedade

Comentários

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

Obtém a descrição de um erro de validação neste XmlNode objeto. Pode não ser significativo para nós de atributo.

readonly validationErrorText: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém se este elemento é válido de acordo com o esquema anexado. Pode não ser significativo para nós de atributo.

readonly validationStatus: Word.XmlValidationStatus | "Ok" | "Custom";

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica o valor deste nó XML. Para nós de elemento, representa o conteúdo do texto; para nós de atributo, representa o valor do atributo.

value: string;

Valor da propriedade

Comentários

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

Copia este nó XML, excluindo a marcação XML, para a Área de Transferência. Para nós de atributo, copia apenas o valor do atributo como texto.

copy(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Remove este nó XML do documento e coloca-o na Área de Transferência. Para nós de atributo, remove o atributo do respetivo elemento principal e copia apenas o valor do atributo como texto para a área de transferência.

cut(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Elimina o nó XML do documento XML. Para nós de elemento, remove todo o elemento e o respetivo conteúdo; para nós de atributo, remove o atributo do respetivo elemento principal.

delete(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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.XmlNodeLoadOptions): Word.XmlNode;

Parâmetros

Retornos

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

Parâmetros

Retornos

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

Parâmetros

Retornos

Remove um elemento subordinado deste nó XML. Este método não tem efeito se o tipo de nó for attribute (uma vez que os nós de atributo não têm elementos subordinados).

removeChild(childElement: Word.XmlNode): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Devolve todos os elementos subordinados que correspondem ao parâmetro XPath, pela ordem em que aparecem neste nó XML. Devolve null se o tipo de nó for attribute (uma vez que os nós de atributo não têm elementos subordinados para procurar).

selectNodes(xPath: string, options?: Word.SelectNodesOptions): Word.XmlNodeCollection;

Parâmetros

Retornos

Uma coleção de nós XML que correspondem à expressão XPath.

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Devolve o primeiro elemento subordinado que corresponde ao parâmetro XPath neste nó XML. Devolve null se o tipo de nó for attribute (uma vez que os nós de atributo não têm elementos subordinados para procurar).

selectSingleNode(xPath: string, options?: Word.SelectSingleNodeOptions): Word.XmlNode;

Parâmetros

Retornos

O primeiro nó XML que corresponde à expressão XPath ou null se não for encontrada nenhuma correspondência.

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Altera o texto de erro de validação apresentado a um utilizador para este nó XML e se pretende forçar Word a comunicar o nó como inválido. Pode não ser significativo para nós de atributo.

setValidationError(status: Word.XmlValidationStatus, options?: Word.XmlNodeSetValidationErrorOptions): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Altera o texto de erro de validação apresentado a um utilizador para este nó XML e se pretende forçar Word a comunicar o nó como inválido. Pode não ser significativo para nós de atributo.

setValidationError(status: "Ok" | "Custom", options?: Word.XmlNodeSetValidationErrorOptions): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

toJSON(): Word.Interfaces.XmlNodeData;

Retornos

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

Retornos

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

Retornos

Valida este nó XML em relação aos esquemas XML anexados ao documento. Pode não ser significativo para nós de atributo.

validate(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]