Edit

Share via

PowerPoint.DocumentProperties class

  • Reference
Package:
powerpoint

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

Extends
OfficeExtension.ClientObject

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

Properties

author

The author of the presentation.
category

The category of the presentation.
comments

The Comments field in the metadata of the presentation. These have no connection to comments made in slides.
company

The company of the presentation.
context

The request context associated with the object. This connects the add-in's process to the Office host application's process.
creationDate

The creation date of the presentation.
customProperties

The collection of custom properties of the presentation.
keywords

The keywords of the presentation.
lastAuthor

The last author of the presentation.
manager

The manager of the presentation.
revisionNumber

The revision number of the presentation.
subject

The subject of the presentation.
title

The title of the presentation.

Methods

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.DocumentProperties object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.DocumentPropertiesData) that contains shallow copies of any loaded child properties from the original object.

Property Details

author

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 author of the presentation.

author: string;

Property Value

string

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

category

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 category of the presentation.

category: string;

Property Value

string

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

comments

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 Comments field in the metadata of the presentation. These have no connection to comments made in slides.

comments: string;

Property Value

string

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

company

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 company of the presentation.

company: string;

Property Value

string

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

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

PowerPoint.RequestContext

creationDate

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 creation date of the presentation.

readonly creationDate: Date;

Property Value

Date

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

customProperties

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 collection of custom properties of the presentation.

readonly customProperties: PowerPoint.CustomPropertyCollection;

Property Value

PowerPoint.CustomPropertyCollection

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

keywords

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 keywords of the presentation.

keywords: string;

Property Value

string

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

lastAuthor

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 last author of the presentation.

readonly lastAuthor: string;

Property Value

string

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

manager

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 manager of the presentation.

manager: string;

Property Value

string

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

revisionNumber

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 revision number of the presentation.

revisionNumber: number;

Property Value

number

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

subject

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 subject of the presentation.

subject: string;

Property Value

string

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

title

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 title of the presentation.

title: string;

Property Value

string

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

Method Details

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.DocumentPropertiesLoadOptions): PowerPoint.DocumentProperties;

Parameters

options
PowerPoint.Interfaces.DocumentPropertiesLoadOptions

Provides options for which properties of the object to load.

Returns

PowerPoint.DocumentProperties

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

Parameters

propertyNames

string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

PowerPoint.DocumentProperties

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

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

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.DocumentProperties object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.DocumentPropertiesData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): PowerPoint.Interfaces.DocumentPropertiesData;

Returns

PowerPoint.Interfaces.DocumentPropertiesData