Excel.SensitivityLabelAbacAttribute class
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 an ABAC (attribute-based access control) attribute.
- Extends
Properties
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| data |
Gets the data type of the attribute. |
| display |
Gets the display name of the attribute. |
| display |
Gets the display order of the attribute. |
| is |
Gets a value indicating whether the attribute is active. |
| is |
Gets a value indicating whether the attribute supports multiple values. |
| values | Gets the values of the attribute. |
Methods
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| toJSON() | Overrides the JavaScript |
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
dataType
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 data type of the attribute.
readonly dataType: Excel.SensitivityLabelAbacAttributeDataType | "Unknown" | "StringValue" | "BooleanValue" | "NumberValue" | "DateValue";Property Value
Excel.SensitivityLabelAbacAttributeDataType | "Unknown" | "StringValue" | "BooleanValue" | "NumberValue" | "DateValue"
Remarks
displayName
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 display name of the attribute.
readonly displayName: string;Property Value
string
Remarks
displayOrder
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 display order of the attribute.
readonly displayOrder: number;Property Value
number
Remarks
isActive
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 attribute is active.
readonly isActive: boolean;Property Value
boolean
Remarks
isMultiValued
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 attribute supports multiple values.
readonly isMultiValued: boolean;Property Value
boolean
Remarks
values
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 values of the attribute.
readonly values: SensitivityLabelAbacAttributeValue[];Property Value
Remarks
Method Details
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.SensitivityLabelAbacAttributeLoadOptions): Excel.SensitivityLabelAbacAttribute;Parameters
Provides options for which properties of the object to load.
Returns
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.SensitivityLabelAbacAttribute;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
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?: {
select?: string;
expand?: string;
}): Excel.SensitivityLabelAbacAttribute;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
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.SensitivityLabelAbacAttribute object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.SensitivityLabelAbacAttributeData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Excel.Interfaces.SensitivityLabelAbacAttributeData;