PowerPoint.CustomProperty 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.
Represents a custom property.
- 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. |
key | The string that uniquely identifies the custom property. |
type | The type of the value used for the custom property. |
value | The value of the custom property. If the value is a string, the maximum length 255 characters. Larger strings cause the operation to fail with an |
Methods
delete() | Deletes the custom property. |
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
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.
The string that uniquely identifies the custom property.
readonly key: string;
Property Value
string
Remarks
type
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 type of the value used for the custom property.
readonly type: PowerPoint.DocumentPropertyType | "Boolean" | "Date" | "Number" | "String";
Property Value
PowerPoint.DocumentPropertyType | "Boolean" | "Date" | "Number" | "String"
Remarks
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.
The value of the custom property. If the value is a string, the maximum length 255 characters. Larger strings cause the operation to fail with an InvalidArgument
error.
value: boolean | Date | number | string;
Property Value
boolean | Date | number | string
Remarks
Method Details
delete()
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 the custom property.
delete(): void;
Returns
void
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.CustomPropertyLoadOptions): PowerPoint.CustomProperty;
Parameters
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.CustomProperty;
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?: {
select?: string;
expand?: string;
}): PowerPoint.CustomProperty;
Parameters
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
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 is passed to it.) Whereas the original PowerPoint.CustomProperty
object is an API object, the toJSON
method returns a plain JavaScript object (typed as PowerPoint.Interfaces.CustomPropertyData
) that contains shallow copies of any loaded child properties from the original object.
toJSON(): PowerPoint.Interfaces.CustomPropertyData;
Returns
Office Add-ins