Edit

Excel.Interfaces.SensitivityLabelDetailsLoadOptions interface

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 properties of available sensitivity labels in Excel.

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

children

Gets the sublabels of the sensitivity label. Returns null if a label doesn't have any sublabels.

color

Gets the color of the sensitivity label.

id

Gets the unique identifier (GUID) of the sensitivity label.

isEnabled

Gets a value indicating whether the label is enabled.

name

Gets the name of the sensitivity label.

order

Gets the priority of the sensitivity label, with 0 as lowest priority.

protectionType

Gets a value indicating the protection type provided by this label.

siteId

Gets the unique identifier (GUID) of the tenant which the sensitivity label is belonged.

tooltip

Gets the description of the sensitivity label.

Property Details

$all

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.

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

children

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 sublabels of the sensitivity label. Returns null if a label doesn't have any sublabels.

children?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)

color

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 color of the sensitivity label.

color?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)

id

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 unique identifier (GUID) of the sensitivity label.

id?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)

isEnabled

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 a value indicating whether the label is enabled.

isEnabled?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)

name

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 name of the sensitivity label.

name?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)

order

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 priority of the sensitivity label, with 0 as lowest priority.

order?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)

protectionType

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 a value indicating the protection type provided by this label.

protectionType?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)

siteId

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 unique identifier (GUID) of the tenant which the sensitivity label is belonged.

siteId?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)

tooltip

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 description of the sensitivity label.

tooltip?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)