Office.CustomXmlPrefixMappings interface

Adiciona de forma assíncrona um prefixo ao mapeamento de namespace para usar ao consultar um item.

addNamespaceAsync(prefix: string, ns: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

Parâmetros

prefix: string

Especifica o prefixo a ser adicionado à lista de mapeamento de prefixos. Obrigatório.

ns: string

Especifica o URI do namespace a ser atribuído ao prefixo recém-adicionado. Obrigatório.

options: Office.AsyncContextOptions

Fornece uma opção para preservar dados de contexto de qualquer tipo, inalterados, para uso em um retorno de chamada.

callback: (result: Office.AsyncResult<void>) => void

Opcional. Uma função que é invocada quando o retorno de chamada retorna, cujo único parâmetro é do tipo Office.AsyncResult.

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

Se nenhum namespace tiver sido atribuído ao prefixo solicitado, o método retornará uma cadeia de caracteres vazia ("").

Adiciona de forma assíncrona um prefixo ao mapeamento de namespace para usar ao consultar um item.

addNamespaceAsync(prefix: string, ns: string, callback?: (result: AsyncResult<void>) => void): void;

Parâmetros

prefix: string

Especifica o prefixo a ser adicionado à lista de mapeamento de prefixos. Obrigatório.

ns: string

Especifica o URI do namespace a ser atribuído ao prefixo recém-adicionado. Obrigatório.

callback: (result: Office.AsyncResult<void>) => void

Opcional. Uma função que é invocada quando o retorno de chamada retorna, cujo único parâmetro é do tipo Office.AsyncResult.

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

Se nenhum namespace tiver sido atribuído ao prefixo solicitado, o método retornará uma cadeia de caracteres vazia ("").

Obtém de forma assíncrona o namespace mapeado para o prefixo especificado.

getNamespaceAsync(prefix: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;

Parâmetros

prefix: string

TSpecifica o prefixo para o qual obter o namespace. Obrigatório.

options: Office.AsyncContextOptions

Fornece uma opção para preservar dados de contexto de qualquer tipo, inalterados, para uso em um retorno de chamada.

callback: (result: Office.AsyncResult<string>) => void

Opcional. Uma função que é invocada quando o retorno de chamada retorna, cujo único parâmetro é do tipo Office.AsyncResult. A value propriedade do resultado é uma cadeia de caracteres que contém o namespace mapeado para o prefixo especificado.

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

Se o prefixo já existir no gerenciador de namespace, esse método substituirá o mapeamento desse prefixo, exceto quando o prefixo for um adicionado ou usado internamente pelo armazenamento de dados, retornando nesse caso um erro.

Obtém de forma assíncrona o namespace mapeado para o prefixo especificado.

getNamespaceAsync(prefix: string, callback?: (result: AsyncResult<string>) => void): void;

Parâmetros

prefix: string

TSpecifica o prefixo para o qual obter o namespace. Obrigatório.

callback: (result: Office.AsyncResult<string>) => void

Opcional. Uma função que é invocada quando o retorno de chamada retorna, cujo único parâmetro é do tipo Office.AsyncResult. A value propriedade do resultado é uma cadeia de caracteres que contém o namespace mapeado para o prefixo especificado.

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

Se o prefixo já existir no gerenciador de namespace, esse método substituirá o mapeamento desse prefixo, exceto quando o prefixo for um adicionado ou usado internamente pelo armazenamento de dados, retornando nesse caso um erro.

Obtém de forma assíncrona o prefixo para o namespace especificado.

getPrefixAsync(ns: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;

Parâmetros

ns: string

Especifica o namespace para o qual obter o prefixo. Obrigatório.

options: Office.AsyncContextOptions

Fornece uma opção para preservar dados de contexto de qualquer tipo, inalterados, para uso em um retorno de chamada.

callback: (result: Office.AsyncResult<string>) => void

Opcional. Uma função que é invocada quando o retorno de chamada retorna, cujo único parâmetro é do tipo Office.AsyncResult. A value propriedade do resultado é uma cadeia de caracteres que contém o prefixo do namespace especificado.

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

Se nenhum prefixo tiver sido atribuído ao namespace solicitado, o método retornará uma cadeia de caracteres vazia (""). Se houver vários prefixos especificados no gerenciador de namespace, o método retornará o primeiro prefixo correspondente ao namespace fornecido.

Obtém de forma assíncrona o prefixo para o namespace especificado.

getPrefixAsync(ns: string, callback?: (result: AsyncResult<string>) => void): void;

Parâmetros

ns: string

Especifica o namespace para o qual obter o prefixo. Obrigatório.

callback: (result: Office.AsyncResult<string>) => void

Opcional. Uma função que é invocada quando o retorno de chamada retorna, cujo único parâmetro é do tipo Office.AsyncResult. A value propriedade do resultado é uma cadeia de caracteres que contém o prefixo do namespace especificado.

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

Se nenhum prefixo tiver sido atribuído ao namespace solicitado, o método retornará uma cadeia de caracteres vazia (""). Se houver vários prefixos especificados no gerenciador de namespace, o método retornará o primeiro prefixo correspondente ao namespace fornecido.

Compartilhar via

Comentários

Métodos

Detalhes do método

addNamespaceAsync(prefix, ns, options, callback)

Parâmetros

Retornos

Comentários

addNamespaceAsync(prefix, ns, callback)

Parâmetros

Retornos

Comentários

getNamespaceAsync(prefix, options, callback)

Parâmetros

Retornos

Comentários

getNamespaceAsync(prefix, callback)

Parâmetros

Retornos

Comentários

getPrefixAsync(ns, options, callback)

Parâmetros

Retornos

Comentários

getPrefixAsync(ns, callback)

Parâmetros

Retornos

Comentários

Comentários

Recursos adicionais