PowerPoint.ShapeScopedCollection class
Representa una colección de formas.
- Extends
Comentarios
[ Conjunto de API: PowerPointApi 1.5 ]
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
| get |
Obtiene el número de formas de la colección. |
| get |
Obtiene una forma con su identificador único. Se produce un error si la forma no existe. |
| get |
Obtiene una forma mediante su índice de base cero en la colección. Se produce un error si el índice está fuera del intervalo. |
| get |
Obtiene una forma con su identificador único. Si dicha forma no existe, se devuelve un objeto con una |
| 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.Shape[];Valor de propiedad
Detalles del método
getCount()
Obtiene el número de formas de la colección.
getCount(): OfficeExtension.ClientResult<number>;Devoluciones
OfficeExtension.ClientResult<number>
Número de formas de la colección.
Comentarios
getItem(key)
Obtiene una forma con su identificador único. Se produce un error si la forma no existe.
getItem(key: string): PowerPoint.Shape;Parámetros
- key
-
string
Identificador de la forma.
Devoluciones
Forma con el identificador único. Si dicha forma no existe, se produce un error.
Comentarios
getItemAt(index)
Obtiene una forma mediante su índice de base cero en la colección. Se produce un error si el índice está fuera del intervalo.
getItemAt(index: number): PowerPoint.Shape;Parámetros
- index
-
number
Índice de la forma de la colección.
Devoluciones
Forma en el índice especificado. Se produce un error si el índice está fuera del intervalo.
Comentarios
getItemOrNullObject(id)
Obtiene una forma con su identificador único. Si dicha forma no existe, se devuelve un objeto con una isNullObject propiedad establecida en true.
getItemOrNullObject(id: string): PowerPoint.Shape;Parámetros
- id
-
string
Identificador de la forma.
Devoluciones
Forma con el identificador único. Si dicha forma no existe, se devuelve un objeto con una isNullObject propiedad establecida en true.
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.ShapeScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.ShapeScopedCollection;Parámetros
- options
-
PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions & 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.ShapeScopedCollection;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.ShapeScopedCollection;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.ShapeScopedCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como PowerPoint.Interfaces.ShapeScopedCollectionData) que contiene una matriz "items" con copias superficiales de las propiedades cargadas de los elementos de la colección.
toJSON(): PowerPoint.Interfaces.ShapeScopedCollectionData;