Excel.CustomXmlPartCollection class
Una colección de elementos XML personalizados.
- Extends
Comentarios
[Conjunto de API: ExcelApi 1.5]
Propiedades
| context | El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office. |
| items | Obtiene los elementos secundarios cargados en esta colección. |
Métodos
| add(xml) | Se agrega un nuevo elemento XML personalizado al libro. |
| 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 elemento XML personalizado a partir de su identificador. |
| get |
Obtiene un elemento XML personalizado a partir de su identificador. Si no |
| 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() | Reemplaza el método JavaScript |
Detalles de las propiedades
context
El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el 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: Excel.CustomXmlPart[];Valor de propiedad
Detalles del método
add(xml)
Se agrega un nuevo elemento XML personalizado al libro.
add(xml: string): Excel.CustomXmlPart;Parámetros
- xml
-
string
Contenido XML. Debe ser un fragmento XML válido.
Devoluciones
Comentarios
[Conjunto de API: ExcelApi 1.5]
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): Excel.CustomXmlPartScopedCollection;Parámetros
- namespaceUri
-
string
Debe ser un URI de esquema completo; Por ejemplo, "http://schemas.contoso.com/review/1.0".
Devoluciones
Comentarios
[Conjunto de API: ExcelApi 1.5]
getCount()
Obtiene el número de elementos XML personalizados de la colección.
getCount(): OfficeExtension.ClientResult<number>;Devoluciones
OfficeExtension.ClientResult<number>
Comentarios
[Conjunto de API: ExcelApi 1.5]
getItem(id)
Obtiene un elemento XML personalizado a partir de su identificador.
getItem(id: string): Excel.CustomXmlPart;Parámetros
- id
-
string
Identificador del objeto que se va a recuperar.
Devoluciones
Comentarios
[Conjunto de API: ExcelApi 1.5]
getItemOrNullObject(id)
Obtiene un elemento XML personalizado a partir de su identificador. Si no CustomXmlPart existe, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea los métodos y propiedades *OrNullObject.
getItemOrNullObject(id: string): Excel.CustomXmlPart;Parámetros
- id
-
string
Identificador del objeto que se va a recuperar.
Devoluciones
Comentarios
[Conjunto de API: ExcelApi 1.5]
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?: Excel.Interfaces.CustomXmlPartCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CustomXmlPartCollection;Parámetros
- options
-
Excel.Interfaces.CustomXmlPartCollectionLoadOptions & Excel.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[]): Excel.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): Excel.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()
Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.CustomXmlPartCollection es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.CustomXmlPartCollectionData) que contiene una matriz "items" con copias superficiales de cualquier propiedad cargada de los elementos de la colección.
toJSON(): Excel.Interfaces.CustomXmlPartCollectionData;