Excel.CustomXmlPart class

Package:

excel

Represents a custom XML part object in a workbook.

Extends

OfficeExtension.ClientObject

Remarks

[Api set: ExcelApi 1.5]

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 custom XML part's ID.
namespaceUri	The custom XML part's namespace URI.

Methods

delete()	Deletes the custom XML part.
getXml()	Gets the custom XML part's full XML content.
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 custom XML part's full XML content.
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 Excel.CustomXmlPart object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.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

Excel.RequestContext

id

The custom XML part's ID.

readonly id: string;

Property Value

string

Remarks

[Api set: ExcelApi 1.5]

namespaceUri

The custom XML part's namespace URI.

readonly namespaceUri: string;

Property Value

string

Remarks

[Api set: ExcelApi 1.5]

Method Details

delete()

Deletes the custom XML part.

delete(): void;

Returns

void

Remarks

[Api set: ExcelApi 1.5]

getXml()

Gets the custom XML part's full XML content.

getXml(): OfficeExtension.ClientResult<string>;

Returns

OfficeExtension.ClientResult<string>

Remarks

[Api set: ExcelApi 1.5]

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?: Excel.Interfaces.CustomXmlPartLoadOptions): Excel.CustomXmlPart;

Parameters

options

Excel.Interfaces.CustomXmlPartLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.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[]): Excel.CustomXmlPart;

Parameters

propertyNames

string | string[]

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

Returns

Excel.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;
        }): Excel.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

Excel.CustomXmlPart

setXml(xml)

Sets the custom XML part's full XML content.

setXml(xml: string): void;

Parameters

xml

string

XML content for the part.

Returns

void

Remarks

[Api set: ExcelApi 1.5]

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

toJSON(): Excel.Interfaces.CustomXmlPartData;

Returns

Excel.Interfaces.CustomXmlPartData