Excel.CustomXmlPartCollection class

Package:

excel

A collection of custom XML parts.

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.
items	Gets the loaded child items in this collection.

Methods

add(xml)	Adds a new custom XML part to the workbook.
getByNamespace(namespaceUri)	Gets a new scoped collection of custom XML parts whose namespaces match the given namespace.
getCount()	Gets the number of custom XML parts in the collection.
getItem(id)	Gets a custom XML part based on its ID.
getItemOrNullObject(id)	Gets a custom XML part based on its ID. If the CustomXmlPart does not exist, then this method returns an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
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 Excel.CustomXmlPartCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.CustomXmlPartCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

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

items

Gets the loaded child items in this collection.

readonly items: Excel.CustomXmlPart[];

Property Value

Excel.CustomXmlPart[]

Method Details

add(xml)

Adds a new custom XML part to the workbook.

add(xml: string): Excel.CustomXmlPart;

Parameters

xml

string

XML content. Must be a valid XML fragment.

Returns

Excel.CustomXmlPart

Remarks

[Api set: ExcelApi 1.5]

getByNamespace(namespaceUri)

Gets a new scoped collection of custom XML parts whose namespaces match the given namespace.

getByNamespace(namespaceUri: string): Excel.CustomXmlPartScopedCollection;

Parameters

namespaceUri

string

This must be a fully qualified schema URI; for example, "http://schemas.contoso.com/review/1.0".

Returns

Excel.CustomXmlPartScopedCollection

Remarks

[Api set: ExcelApi 1.5]

getCount()

Gets the number of custom XML parts in the collection.

getCount(): OfficeExtension.ClientResult<number>;

Returns

OfficeExtension.ClientResult<number>

Remarks

[Api set: ExcelApi 1.5]

getItem(id)

Gets a custom XML part based on its ID.

getItem(id: string): Excel.CustomXmlPart;

Parameters

id

string

ID of the object to be retrieved.

Returns

Excel.CustomXmlPart

Remarks

[Api set: ExcelApi 1.5]

getItemOrNullObject(id)

Gets a custom XML part based on its ID. If the CustomXmlPart does not exist, then this method returns an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.

getItemOrNullObject(id: string): Excel.CustomXmlPart;

Parameters

id

string

ID of the object to be retrieved.

Returns

Excel.CustomXmlPart

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.CustomXmlPartCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CustomXmlPartCollection;

Parameters

options

Excel.Interfaces.CustomXmlPartCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.CustomXmlPartCollection

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

Parameters

propertyNames

string | string[]

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

Returns

Excel.CustomXmlPartCollection

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?: OfficeExtension.LoadOption): Excel.CustomXmlPartCollection;

Parameters

propertyNamesAndPaths

OfficeExtension.LoadOption

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

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.CustomXmlPartCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.CustomXmlPartCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

toJSON(): Excel.Interfaces.CustomXmlPartCollectionData;

Returns

Excel.Interfaces.CustomXmlPartCollectionData