PowerPoint.CustomXmlPartCollection class
Colección de elementos XML personalizados.
- Extends
Comentarios
Propiedades
| context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
| items | Obtiene los elementos secundarios cargados en esta colección. |
Métodos
| add(xml) | Agrega una nueva |
| get |
Obtiene una nueva colección con ámbito de elementos XML personalizados cuyos espacios de nombres coinciden con el espacio de nombres determinado. |
| get |
Obtiene el número de elementos XML personalizados de la colección. |
| get |
Obtiene un |
| get |
Obtiene un |
| get |
Obtiene un |
| load(options) | Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| toJSON() | Invalida el método JavaScript |
Detalles de las propiedades
context
Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
context: RequestContext;Valor de propiedad
items
Obtiene los elementos secundarios cargados en esta colección.
readonly items: PowerPoint.CustomXmlPart[];Valor de propiedad
Detalles del método
add(xml)
Agrega una nueva CustomXmlPart a la colección.
add(xml: string): PowerPoint.CustomXmlPart;Parámetros
- xml
-
string
Contenido XML. Debe ser un fragmento XML válido. Si el fragmento XML no es válido, este método devuelve el GeneralException error.
Devoluciones
Comentarios
getByNamespace(namespaceUri)
Obtiene una nueva colección con ámbito de elementos XML personalizados cuyos espacios de nombres coinciden con el espacio de nombres determinado.
getByNamespace(namespaceUri: string): PowerPoint.CustomXmlPartScopedCollection;Parámetros
- namespaceUri
-
string
Debe ser un URI de esquema completo, como "http://schemas.contoso.com/review/1.0".
Devoluciones
Comentarios
getCount()
Obtiene el número de elementos XML personalizados de la colección.
getCount(): OfficeExtension.ClientResult<number>;Devoluciones
OfficeExtension.ClientResult<number>
Número de elementos XML personalizados de la colección.
Comentarios
getItem(id)
Obtiene un CustomXmlPart objeto basado en su identificador.
getItem(id: string): PowerPoint.CustomXmlPart;Parámetros
- id
-
string
Identificador del objeto que se va a recuperar.
Devoluciones
Comentarios
getItemAt(index)
Nota
Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.
Obtiene un CustomXmlPart elemento por su índice de base cero en la colección. Produce una InvalidArgument excepción cuando el índice está fuera del intervalo.
getItemAt(index: number): PowerPoint.CustomXmlPart;Parámetros
- index
-
number
Índice del elemento XML personalizado de la colección.
Devoluciones
Elemento XML personalizado en el índice especificado.
Comentarios
[ Conjunto de API: PowerPointApi BETA (SOLO VERSIÓN PRELIMINAR) ]
getItemOrNullObject(id)
Obtiene un CustomXmlPart objeto basado en su identificador.
CustomXmlPart Si no existe, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).
getItemOrNullObject(id: string): PowerPoint.CustomXmlPart;Parámetros
- id
-
string
Identificador del objeto que se va a recuperar.
Devoluciones
Comentarios
load(options)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(options?: PowerPoint.Interfaces.CustomXmlPartCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.CustomXmlPartCollection;Parámetros
- options
-
PowerPoint.Interfaces.CustomXmlPartCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions
Proporciona opciones para las propiedades del objeto que se van a cargar.
Devoluciones
load(propertyNames)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames?: string | string[]): PowerPoint.CustomXmlPartCollection;Parámetros
- propertyNames
-
string | string[]
Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.
Devoluciones
load(propertyNamesAndPaths)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.CustomXmlPartCollection;Parámetros
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.
Devoluciones
toJSON()
Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original PowerPoint.CustomXmlPartCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como PowerPoint.Interfaces.CustomXmlPartCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.
toJSON(): PowerPoint.Interfaces.CustomXmlPartCollectionData;