Excel.SensitivityLabelDetailsCollection class

Package:

excel

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 the collection of Excel.SensitivityLabelDetails objects.

Extends

OfficeExtension.ClientObject

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)

Used by

• Excel.SensitivityLabelDetails: children
• Excel.SensitivityLabelsCatalog: getLabels

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

getFirst()	Gets the first SensitivityLabelDetails object in this collection. Throws an ItemNotFound error if this collection is empty.
getFirstOrNullObject()	Gets the first SensitivityLabelDetails object in this collection. If this collection is empty, then this method will return 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.SensitivityLabelDetailsCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.SensitivityLabelDetailsCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

Property Details

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

Excel.RequestContext

items

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.

Gets the loaded child items in this collection.

readonly items: Excel.SensitivityLabelDetails[];

Property Value

Excel.SensitivityLabelDetails[]

Method Details

getFirst()

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.

Gets the first SensitivityLabelDetails object in this collection. Throws an ItemNotFound error if this collection is empty.

getFirst(): Excel.SensitivityLabelDetails;

Returns

Excel.SensitivityLabelDetails

A new SensitivityLabelDetails object.

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)

getFirstOrNullObject()

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.

Gets the first SensitivityLabelDetails object in this collection. If this collection is empty, then this method will return an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.

getFirstOrNullObject(): OfficeExtension.ClientResult<any>;

Returns

OfficeExtension.ClientResult<any>

The new SensitivityLabelDetails object.

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)

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?: Excel.Interfaces.SensitivityLabelDetailsCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SensitivityLabelDetailsCollection;

Parameters

options

Excel.Interfaces.SensitivityLabelDetailsCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.SensitivityLabelDetailsCollection

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

Parameters

propertyNames

string | string[]

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

Returns

Excel.SensitivityLabelDetailsCollection

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

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

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

toJSON(): Excel.Interfaces.SensitivityLabelDetailsCollectionData;

Returns

Excel.Interfaces.SensitivityLabelDetailsCollectionData