Edit

Share via

PowerPoint.CustomXmlPart class

Package:
powerpoint

Represents a custom XML part object.

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

The ID of the custom XML part.
namespaceUri

The namespace URI of the custom XML part.

Methods

delete()

Deletes the custom XML part.
getXml()

Gets the XML content of the custom XML part.
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.
setXml(xml)

Sets the XML content for the custom XML part.
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.CustomXmlPart object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.CustomXmlPartData) 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

id

The ID of the custom XML part.

readonly id: string;

Property Value

string

Remarks

[ API set: PowerPointApi 1.7 ]

namespaceUri

The namespace URI of the custom XML part.

readonly namespaceUri: string;

Property Value

string

Remarks

[ API set: PowerPointApi 1.7 ]

Method Details

delete()

Deletes the custom XML part.

delete(): void;

Returns

void

Remarks

[ API set: PowerPointApi 1.7 ]

getXml()

Gets the XML content of the custom XML part.

getXml(): OfficeExtension.ClientResult<string>;

Returns

OfficeExtension.ClientResult<string>

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.CustomXmlPartLoadOptions): PowerPoint.CustomXmlPart;

Parameters

options
PowerPoint.Interfaces.CustomXmlPartLoadOptions

Provides options for which properties of the object to load.

Returns

PowerPoint.CustomXmlPart

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

Parameters

propertyNames

string | string[]

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

Returns

PowerPoint.CustomXmlPart

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

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

setXml(xml)

Sets the XML content for the custom XML part.

setXml(xml: string): void;

Parameters

xml

string

XML content for the part.

Returns

void

Remarks

[ API set: PowerPointApi 1.7 ]

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

toJSON(): PowerPoint.Interfaces.CustomXmlPartData;

Returns

PowerPoint.Interfaces.CustomXmlPartData