PowerPoint.CustomProperty class

Package:

powerpoint

Represents a custom property.

Extends

OfficeExtension.ClientObject

Remarks

[ API set: PowerPointApi 1.7 ]

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 InvalidArgument error.

Methods

delete()	Deletes the custom property.
load(options)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
toJSON()	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.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.

Property Details

context

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

PowerPoint.RequestContext

key

The string that uniquely identifies the custom property.

readonly key: string;

Property Value

string

Remarks

[ API set: PowerPointApi 1.7 ]

type

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

[ API set: PowerPointApi 1.7 ]

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 InvalidArgument error.

value: boolean | Date | number | string;

Property Value

boolean | Date | number | string

Remarks

[ API set: PowerPointApi 1.7 ]

Method Details

delete()

Deletes the custom property.

delete(): void;

Returns

void

Remarks

[ API set: PowerPointApi 1.7 ]

load(options)

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

options

PowerPoint.Interfaces.CustomPropertyLoadOptions

Provides options for which properties of the object to load.

Returns

PowerPoint.CustomProperty

load(propertyNames)

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

PowerPoint.CustomProperty

load(propertyNamesAndPaths)

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

PowerPoint.CustomProperty

toJSON()

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.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

PowerPoint.Interfaces.CustomPropertyData