PowerPoint.CustomPropertyCollection class
Colección de propiedades personalizadas.
- Extends
Comentarios
[ Conjunto de API: PowerPointApi 1.7 ]
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(key, value) | Crea una nueva |
| delete |
Elimina todas las propiedades personalizadas de la colección. |
| get |
Obtiene el número de propiedades personalizadas de la colección. |
| get |
Obtiene un objeto |
| get |
Obtiene un objeto |
| 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.CustomProperty[];Valor de propiedad
Detalles del método
add(key, value)
Crea una nueva CustomProperty propiedad o actualiza la propiedad con la clave especificada.
add(key: string, value: boolean | Date | number | string): PowerPoint.CustomProperty;Parámetros
- key
-
string
Cadena que identifica el CustomProperty objeto. No distingue mayúsculas de minúsculas. La longitud máxima de la clave es de 255 caracteres. Las cadenas más grandes hacen que se produzca un InvalidArgument error en la operación.
- value
-
boolean | Date | number | string
Valor de .CustomProperty Si el valor es una cadena, la longitud máxima es de 255 caracteres. Las cadenas más grandes hacen que se produzca un InvalidArgument error en la operación.
Devoluciones
Comentarios
deleteAll()
Elimina todas las propiedades personalizadas de la colección.
deleteAll(): void;Devoluciones
void
Comentarios
getCount()
Obtiene el número de propiedades personalizadas de la colección.
getCount(): OfficeExtension.ClientResult<number>;Devoluciones
OfficeExtension.ClientResult<number>
Número de propiedades personalizadas de la colección.
Comentarios
getItem(key)
Obtiene un objeto CustomProperty por su clave.
getItem(key: string): PowerPoint.CustomProperty;Parámetros
- key
-
string
Cadena que identifica el CustomProperty objeto. No distingue mayúsculas de minúsculas. Las claves tienen una longitud máxima de 255 caracteres. Si el argumento supera los 255 caracteres, este método devuelve el InvalidArgument error.
Devoluciones
Comentarios
getItemOrNullObject(key)
Obtiene un objeto CustomProperty por su clave.
CustomProperty 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(key: string): PowerPoint.CustomProperty;Parámetros
- key
-
string
Cadena que identifica el CustomProperty objeto. No distingue mayúsculas de minúsculas. Las claves tienen una longitud máxima de 255 caracteres. Si el argumento supera los 255 caracteres, este método devuelve el InvalidArgument error.
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.CustomPropertyCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.CustomPropertyCollection;Parámetros
- options
-
PowerPoint.Interfaces.CustomPropertyCollectionLoadOptions & 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.CustomPropertyCollection;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.CustomPropertyCollection;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.CustomPropertyCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como PowerPoint.Interfaces.CustomPropertyCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.
toJSON(): PowerPoint.Interfaces.CustomPropertyCollectionData;