PowerPoint.CustomPropertyCollection class
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
A collection of custom properties.
- Extends
Remarks
[ API set: PowerPointApi BETA (PREVIEW ONLY) ]
Properties
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| items | Gets the loaded child items in this collection. |
Methods
| add(key, value) | Creates a new |
| delete |
Deletes all custom properties in this collection. |
| get |
Gets the number of custom properties in the collection. |
| get |
Gets a |
| get |
Gets a |
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| toJSON() | Overrides the JavaScript |
Property Details
context
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;Property Value
items
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Gets the loaded child items in this collection.
readonly items: PowerPoint.CustomProperty[];Property Value
Method Details
add(key, value)
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Creates a new CustomProperty or updates the property with the given key.
add(key: string, value: boolean | Date | number | string): PowerPoint.CustomProperty;Parameters
- key
-
string
The string that identifies the CustomProperty object. It's case-insensitive. The maximum key length is 255 characters. Larger strings cause the operation to fail with an InvalidArgument error.
- value
-
boolean | Date | number | string
The value of the CustomProperty. If the value is a string, the maximum length 255 characters. Larger strings cause the operation to fail with an InvalidArgument error.
Returns
Remarks
deleteAll()
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Deletes all custom properties in this collection.
deleteAll(): void;Returns
void
Remarks
getCount()
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Gets the number of custom properties in the collection.
getCount(): OfficeExtension.ClientResult<number>;Returns
OfficeExtension.ClientResult<number>
The number of custom properties in the collection.
Remarks
getItem(key)
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Gets a CustomProperty by its key.
getItem(key: string): PowerPoint.CustomProperty;Parameters
- key
-
string
The string that identifies the CustomProperty object. It's case-insensitive. Keys have a maximum length of 255 characters. If the argument exceeds 255 characters, then this method returns the InvalidArgument error.
Returns
Remarks
getItemOrNullObject(key)
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Gets a CustomProperty by its key. If the CustomProperty doesn't exist, then this method returns an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
getItemOrNullObject(key: string): PowerPoint.CustomProperty;Parameters
- key
-
string
The string that identifies the CustomProperty object. It's case-insensitive. Keys have a maximum length of 255 characters. If the argument exceeds 255 characters, then this method returns the InvalidArgument error.
Returns
Remarks
load(options)
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(options?: PowerPoint.Interfaces.CustomPropertyCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.CustomPropertyCollection;Parameters
- options
-
PowerPoint.Interfaces.CustomPropertyCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames?: string | string[]): PowerPoint.CustomPropertyCollection;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.CustomPropertyCollection;Parameters
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Returns
toJSON()
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original PowerPoint.CustomPropertyCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.CustomPropertyCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
toJSON(): PowerPoint.Interfaces.CustomPropertyCollectionData;Returns
Office Add-ins