Office.CustomXmlPrefixMappings interface

Paquete:

office

Representa una colección de objetos CustomXmlPart.

Comentarios

Aplicaciones: Word

Métodos

addNamespaceAsync(prefix, ns, options, callback)	Agrega de forma asincrónica un prefijo a una asignación de espacio de nombres para usarla cuando se consulte un elemento.
addNamespaceAsync(prefix, ns, callback)	Agrega de forma asincrónica un prefijo a una asignación de espacio de nombres para usarla cuando se consulte un elemento.
getNamespaceAsync(prefix, options, callback)	Obtiene de forma asíncrona el espacio de nombres asignado al prefijo especificado.
getNamespaceAsync(prefix, callback)	Obtiene de forma asíncrona el espacio de nombres asignado al prefijo especificado.
getPrefixAsync(ns, options, callback)	Obtiene de forma asincrónica el prefijo para el espacio de nombres que se ha especificado.
getPrefixAsync(ns, callback)	Obtiene de forma asincrónica el prefijo para el espacio de nombres que se ha especificado.

Detalles del método

addNamespaceAsync(prefix, ns, options, callback)

Agrega de forma asincrónica un prefijo a una asignación de espacio de nombres para usarla cuando se consulte un elemento.

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

Parámetros

prefix

string

Especifica el prefijo que se debe agregar a la lista de asignación de prefijos. Necesario.

ns

string

Especifica el URI del espacio de nombres que se va a asignar al prefijo recién agregado. Necesario.

options

Office.AsyncContextOptions

Proporciona una opción para conservar los datos de contexto de cualquier tipo, sin cambios, para su uso en una devolución de llamada.

callback

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

Opcional. Función que se invoca cuando se devuelve la devolución de llamada, cuyo único parámetro es de tipo Office.AsyncResult.

Devoluciones

void

Comentarios

Conjunto de requisitos: CustomXmlParts

Si no se asigna ningún espacio de nombres al prefijo solicitado, el método devuelve una cadena vacía ("").

addNamespaceAsync(prefix, ns, callback)

Agrega de forma asincrónica un prefijo a una asignación de espacio de nombres para usarla cuando se consulte un elemento.

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

Parámetros

prefix

string

Especifica el prefijo que se debe agregar a la lista de asignación de prefijos. Necesario.

ns

string

Especifica el URI del espacio de nombres que se va a asignar al prefijo recién agregado. Necesario.

callback

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

Opcional. Función que se invoca cuando se devuelve la devolución de llamada, cuyo único parámetro es de tipo Office.AsyncResult.

Devoluciones

void

Comentarios

Conjunto de requisitos: CustomXmlParts

Si no se asigna ningún espacio de nombres al prefijo solicitado, el método devuelve una cadena vacía ("").

getNamespaceAsync(prefix, options, callback)

Obtiene de forma asíncrona el espacio de nombres asignado al prefijo especificado.

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

Parámetros

prefix

string

TSpecifies el prefijo para obtener el espacio de nombres. Necesario.

options

Office.AsyncContextOptions

Proporciona una opción para conservar los datos de contexto de cualquier tipo, sin cambios, para su uso en una devolución de llamada.

callback

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

Opcional. Función que se invoca cuando se devuelve la devolución de llamada, cuyo único parámetro es de tipo Office.AsyncResult. La value propiedad del resultado es una cadena que contiene el espacio de nombres asignado al prefijo especificado.

Devoluciones

void

Comentarios

Conjunto de requisitos: CustomXmlParts

Si ya existe el prefijo en el administrador de espacio de nombres, este método sobrescribirá la asignación de ese prefijo salvo en los casos en los que el almacén de datos agregue o use ese prefijo de forma interna. En este caso, devolverá un error.

getNamespaceAsync(prefix, callback)

Obtiene de forma asíncrona el espacio de nombres asignado al prefijo especificado.

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

Parámetros

prefix

string

TSpecifies el prefijo para obtener el espacio de nombres. Necesario.

callback

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

Opcional. Función que se invoca cuando se devuelve la devolución de llamada, cuyo único parámetro es de tipo Office.AsyncResult. La value propiedad del resultado es una cadena que contiene el espacio de nombres asignado al prefijo especificado.

Devoluciones

void

Comentarios

Conjunto de requisitos: CustomXmlParts

Si ya existe el prefijo en el administrador de espacio de nombres, este método sobrescribirá la asignación de ese prefijo salvo en los casos en los que el almacén de datos agregue o use ese prefijo de forma interna. En este caso, devolverá un error.

getPrefixAsync(ns, options, callback)

Obtiene de forma asincrónica el prefijo para el espacio de nombres que se ha especificado.

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

Parámetros

ns

string

Especifica el espacio de nombres para el que hay que obtener el prefijo. Necesario.

options

Office.AsyncContextOptions

Proporciona una opción para conservar los datos de contexto de cualquier tipo, sin cambios, para su uso en una devolución de llamada.

callback

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

Opcional. Función que se invoca cuando se devuelve la devolución de llamada, cuyo único parámetro es de tipo Office.AsyncResult. La value propiedad del resultado es una cadena que contiene el prefijo del espacio de nombres especificado.

Devoluciones

void

Comentarios

Conjunto de requisitos: CustomXmlParts

Si no se asigna ningún prefijo al espacio de nombres solicitado, el método devuelve una cadena en blanco (""). Si se especifican varios prefijos en el administrador de espacios de nombres, el método devuelve el primer prefijo que coincida con el espacio de nombres proporcionado.

getPrefixAsync(ns, callback)

Obtiene de forma asincrónica el prefijo para el espacio de nombres que se ha especificado.

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

Parámetros

ns

string

Especifica el espacio de nombres para el que hay que obtener el prefijo. Necesario.

callback

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

Opcional. Función que se invoca cuando se devuelve la devolución de llamada, cuyo único parámetro es de tipo Office.AsyncResult. La value propiedad del resultado es una cadena que contiene el prefijo del espacio de nombres especificado.

Devoluciones

void

Comentarios

Conjunto de requisitos: CustomXmlParts

Si no se asigna ningún prefijo al espacio de nombres solicitado, el método devuelve una cadena en blanco (""). Si se especifican varios prefijos en el administrador de espacios de nombres, el método devuelve el primer prefijo que coincida con el espacio de nombres proporcionado.