Office.CustomXmlPrefixMappings interface
Representa uma coleção de objetos CustomXmlPart.
Comentários
Aplicações: Word
Métodos
| add |
Adiciona de forma assíncrona um prefixo ao mapeamento de namespace para usar ao consultar um item. |
| add |
Adiciona de forma assíncrona um prefixo ao mapeamento de namespace para usar ao consultar um item. |
| get |
Obtém de forma assíncrona o namespace mapeado para o prefixo especificado. |
| get |
Obtém de forma assíncrona o namespace mapeado para o prefixo especificado. |
| get |
Obtém de forma assíncrona o prefixo para o namespace especificado. |
| get |
Obtém de forma assíncrona o prefixo para o namespace especificado. |
Detalhes do método
addNamespaceAsync(prefix, ns, options, callback)
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 espaço de nomes a atribuir ao prefixo adicionado recentemente. Obrigatório.
- options
- Office.AsyncContextOptions
Fornece uma opção para preservar dados de contexto de qualquer tipo, inalterados, para utilização numa chamada de retorno.
- callback
-
(result: Office.AsyncResult<void>) => void
Opcional. Uma função que é invocada quando a chamada de retorno é devolvida, 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 ("").
addNamespaceAsync(prefix, ns, callback)
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 espaço de nomes a atribuir ao prefixo adicionado recentemente. Obrigatório.
- callback
-
(result: Office.AsyncResult<void>) => void
Opcional. Uma função que é invocada quando a chamada de retorno é devolvida, 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 ("").
getNamespaceAsync(prefix, options, callback)
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
O TSpecifica o prefixo para o qual obter o espaço de nomes. Obrigatório.
- options
- Office.AsyncContextOptions
Fornece uma opção para preservar dados de contexto de qualquer tipo, inalterados, para utilização numa chamada de retorno.
- callback
-
(result: Office.AsyncResult<string>) => void
Opcional. Uma função que é invocada quando a chamada de retorno é devolvida, cujo único parâmetro é do tipo Office.AsyncResult. A value propriedade do resultado é uma cadeia que contém o espaço de nomes 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.
getNamespaceAsync(prefix, callback)
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
O TSpecifica o prefixo para o qual obter o espaço de nomes. Obrigatório.
- callback
-
(result: Office.AsyncResult<string>) => void
Opcional. Uma função que é invocada quando a chamada de retorno é devolvida, cujo único parâmetro é do tipo Office.AsyncResult. A value propriedade do resultado é uma cadeia que contém o espaço de nomes 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.
getPrefixAsync(ns, options, callback)
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 utilização numa chamada de retorno.
- callback
-
(result: Office.AsyncResult<string>) => void
Opcional. Uma função que é invocada quando a chamada de retorno é devolvida, cujo único parâmetro é do tipo Office.AsyncResult. A value propriedade do resultado é uma cadeia que contém o prefixo do espaço de nomes 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.
getPrefixAsync(ns, callback)
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 a chamada de retorno é devolvida, cujo único parâmetro é do tipo Office.AsyncResult. A value propriedade do resultado é uma cadeia que contém o prefixo do espaço de nomes 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.