Edit

Word.Interfaces.SensitivityLabelDetailsLoadOptions interface

Package:
word

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

Remarks

API set: WordApi BETA (PREVIEW ONLY)

Used by

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).
color

The color of the sensitivity label.
id

The unique identifier (GUID) of the sensitivity label.
isEnabled

Gets a value indicating whether the label is enabled.
name

The name of the sensitivity label.
order

The order of the sensitivity label.
protectionType

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

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

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

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.

The color of the sensitivity label.

color?: boolean;

Property Value

boolean

Remarks

API set: WordApi 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.

The unique identifier (GUID) of the sensitivity label.

id?: boolean;

Property Value

boolean

Remarks

API set: WordApi 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: WordApi 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.

The name of the sensitivity label.

name?: boolean;

Property Value

boolean

Remarks

API set: WordApi 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.

The order of the sensitivity label.

order?: boolean;

Property Value

boolean

Remarks

API set: WordApi 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: WordApi 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.

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

siteId?: boolean;

Property Value

boolean

Remarks

API set: WordApi 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.

The description of the sensitivity label.

tooltip?: boolean;

Property Value

boolean

Remarks

API set: WordApi BETA (PREVIEW ONLY)