From 0345746b34d403a4d95440655ec4a1cd07a71be8 Mon Sep 17 00:00:00 2001 From: Alex Jerabek <38896772+AlexJerabek@users.noreply.github.com> Date: Fri, 26 Jun 2026 15:19:14 -0700 Subject: [PATCH] Latest from CDN (#2573) --- docs/docs-ref-autogen/excel/excel.yml | 52 +- .../excel/excel/excel.eventsource.yml | 1 + ...excel.interfaces.collectionloadoptions.yml | 1 + ....sensitivitylabeldetailscollectiondata.yml | 28 + ...ivitylabeldetailscollectionloadoptions.yml | 147 ++ ...tivitylabeldetailscollectionupdatedata.yml | 25 + ...interfaces.sensitivitylabeldetailsdata.yml | 132 ++ ...ces.sensitivitylabeldetailsloadoptions.yml | 147 ++ ...nterfaces.sensitivitylabelscatalogdata.yml | 28 + ...es.sensitivitylabelscatalogloadoptions.yml | 43 + .../excel/excel/excel.labelingcapability.yml | 48 + .../excel/excel.linkedentitycellvalue.yml | 1 + ...l.linkedentitycellvalueloadedeventargs.yml | 82 + ...excel.linkedentitydatadomaincollection.yml | 31 + .../excel/excel/excel.linkedentityid.yml | 2 + .../excel/excel/excel.requestcontext.yml | 17 + .../excel/excel/excel.sensitivitylabel.yml | 84 + .../excel/excel.sensitivitylabeldetails.yml | 226 +++ ...xcel.sensitivitylabeldetailscollection.yml | 142 ++ .../excel.sensitivitylabelprotectiontype.yml | 40 + .../excel/excel.sensitivitylabelscatalog.yml | 135 ++ .../excel.sensitivitylabelupdateresult.yml | 104 ++ .../excel/excel/excel.workbook.yml | 13 + docs/docs-ref-autogen/excel/toc.yml | 16 + .../officeextension.clientrequestcontext.yml | 1 + .../office/officeextension.clientresult.yml | 3 + .../office/officeextension.eventhandlers.yml | 2 +- .../office/officeextension.loadoption.yml | 2 + .../officeextension.clientrequestcontext.yml | 1 + .../office/officeextension.clientresult.yml | 3 + .../office/officeextension.eventhandlers.yml | 2 +- .../office/officeextension.loadoption.yml | 2 + docs/docs-ref-autogen/word/toc.yml | 14 + docs/docs-ref-autogen/word/word.yml | 14 + .../word/word/word.document.yml | 13 + .../word.interfaces.collectionloadoptions.yml | 1 + ....sensitivitylabeldetailscollectiondata.yml | 28 + ...ivitylabeldetailscollectionloadoptions.yml | 134 ++ ...tivitylabeldetailscollectionupdatedata.yml | 25 + ...interfaces.sensitivitylabeldetailsdata.yml | 132 ++ ...ces.sensitivitylabeldetailsloadoptions.yml | 134 ++ ...nterfaces.sensitivitylabelscatalogdata.yml | 28 + ...es.sensitivitylabelscatalogloadoptions.yml | 43 + .../word/word/word.labelingcapability.yml | 48 + .../word/word/word.requestcontext.yml | 17 + .../word/word/word.sensitivitylabel.yml | 159 ++ .../word/word.sensitivitylabeldetails.yml | 254 +++ ...word.sensitivitylabeldetailscollection.yml | 188 ++ .../word.sensitivitylabelprotectiontype.yml | 40 + .../word/word.sensitivitylabelscatalog.yml | 181 ++ .../word.sensitivitylabelupdateresult.yml | 104 ++ docs/includes/excel-preview.md | 27 +- docs/includes/word-preview.md | 19 + .../excel/excel-preview-apis.md | 2 +- .../word/word-preview-apis.md | 2 +- generate-docs/API Coverage Report.csv | 141 +- .../api-extractor-inputs-excel/excel.d.ts | 780 ++++++++- .../api-extractor-inputs-word/word.d.ts | 743 ++++++++ .../script-inputs/include-hashes.json | 4 +- .../script-inputs/office_preview.d.ts | 1523 ++++++++++++++++- 60 files changed, 6307 insertions(+), 52 deletions(-) create mode 100644 docs/docs-ref-autogen/excel/excel/excel.interfaces.sensitivitylabeldetailscollectiondata.yml create mode 100644 docs/docs-ref-autogen/excel/excel/excel.interfaces.sensitivitylabeldetailscollectionloadoptions.yml create mode 100644 docs/docs-ref-autogen/excel/excel/excel.interfaces.sensitivitylabeldetailscollectionupdatedata.yml create mode 100644 docs/docs-ref-autogen/excel/excel/excel.interfaces.sensitivitylabeldetailsdata.yml create mode 100644 docs/docs-ref-autogen/excel/excel/excel.interfaces.sensitivitylabeldetailsloadoptions.yml create mode 100644 docs/docs-ref-autogen/excel/excel/excel.interfaces.sensitivitylabelscatalogdata.yml create mode 100644 docs/docs-ref-autogen/excel/excel/excel.interfaces.sensitivitylabelscatalogloadoptions.yml create mode 100644 docs/docs-ref-autogen/excel/excel/excel.labelingcapability.yml create mode 100644 docs/docs-ref-autogen/excel/excel/excel.linkedentitycellvalueloadedeventargs.yml create mode 100644 docs/docs-ref-autogen/excel/excel/excel.sensitivitylabel.yml create mode 100644 docs/docs-ref-autogen/excel/excel/excel.sensitivitylabeldetails.yml create mode 100644 docs/docs-ref-autogen/excel/excel/excel.sensitivitylabeldetailscollection.yml create mode 100644 docs/docs-ref-autogen/excel/excel/excel.sensitivitylabelprotectiontype.yml create mode 100644 docs/docs-ref-autogen/excel/excel/excel.sensitivitylabelscatalog.yml create mode 100644 docs/docs-ref-autogen/excel/excel/excel.sensitivitylabelupdateresult.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.sensitivitylabeldetailscollectiondata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.sensitivitylabeldetailscollectionloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.sensitivitylabeldetailscollectionupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.sensitivitylabeldetailsdata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.sensitivitylabeldetailsloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.sensitivitylabelscatalogdata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.sensitivitylabelscatalogloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.labelingcapability.yml create mode 100644 docs/docs-ref-autogen/word/word/word.sensitivitylabel.yml create mode 100644 docs/docs-ref-autogen/word/word/word.sensitivitylabeldetails.yml create mode 100644 docs/docs-ref-autogen/word/word/word.sensitivitylabeldetailscollection.yml create mode 100644 docs/docs-ref-autogen/word/word/word.sensitivitylabelprotectiontype.yml create mode 100644 docs/docs-ref-autogen/word/word/word.sensitivitylabelscatalog.yml create mode 100644 docs/docs-ref-autogen/word/word/word.sensitivitylabelupdateresult.yml diff --git a/docs/docs-ref-autogen/excel/excel.yml b/docs/docs-ref-autogen/excel/excel.yml index 0b46c1f4e2..9a73f4b8fd 100644 --- a/docs/docs-ref-autogen/excel/excel.yml +++ b/docs/docs-ref-autogen/excel/excel.yml @@ -120,6 +120,7 @@ enums: - excel!Excel.InsertShiftDirection:enum - excel!Excel.KeyboardDirection:enum - excel!Excel.LabelFilterCondition:enum + - excel!Excel.LabelingCapability:enum - excel!Excel.LinkedDataTypeState:enum - excel!Excel.LinkedEntityDataDomainRefreshMode:enum - excel!Excel.LoadToType:enum @@ -157,6 +158,8 @@ enums: - excel!Excel.SaveBehavior:enum - excel!Excel.ScrollWorkbookTabPosition:enum - excel!Excel.SearchDirection:enum + - excel!Excel.SensitivityLabelProtectionType:enum + - excel!Excel.SensitivityLabelUpdateResult:enum - excel!Excel.ShapeAutoSize:enum - excel!Excel.ShapeFillType:enum - excel!Excel.ShapeFontUnderlineStyle:enum @@ -350,6 +353,10 @@ classes: - excel!Excel.RowColumnPivotHierarchy:class - excel!Excel.RowColumnPivotHierarchyCollection:class - excel!Excel.Runtime:class + - excel!Excel.SensitivityLabel:class + - excel!Excel.SensitivityLabelDetails:class + - excel!Excel.SensitivityLabelDetailsCollection:class + - excel!Excel.SensitivityLabelsCatalog:class - excel!Excel.Setting:class - excel!Excel.SettingCollection:class - excel!Excel.Shape:class @@ -925,6 +932,13 @@ interfaces: - excel!Excel.Interfaces.RuntimeData:interface - excel!Excel.Interfaces.RuntimeLoadOptions:interface - excel!Excel.Interfaces.RuntimeUpdateData:interface + - excel!Excel.Interfaces.SensitivityLabelDetailsCollectionData:interface + - excel!Excel.Interfaces.SensitivityLabelDetailsCollectionLoadOptions:interface + - excel!Excel.Interfaces.SensitivityLabelDetailsCollectionUpdateData:interface + - excel!Excel.Interfaces.SensitivityLabelDetailsData:interface + - excel!Excel.Interfaces.SensitivityLabelDetailsLoadOptions:interface + - excel!Excel.Interfaces.SensitivityLabelsCatalogData:interface + - excel!Excel.Interfaces.SensitivityLabelsCatalogLoadOptions:interface - excel!Excel.Interfaces.SettingCollectionData:interface - excel!Excel.Interfaces.SettingCollectionLoadOptions:interface - excel!Excel.Interfaces.SettingCollectionUpdateData:interface @@ -1049,6 +1063,7 @@ interfaces: - excel!Excel.Interfaces.WorksheetUpdateData:interface - excel!Excel.JavaScriptCustomFunctionReferenceCellValue:interface - excel!Excel.LinkedEntityCellValue:interface + - excel!Excel.LinkedEntityCellValueLoadedEventArgs:interface - excel!Excel.LinkedEntityDataDomainAddedEventArgs:interface - excel!Excel.LinkedEntityDataDomainCreateOptions:interface - excel!Excel.LinkedEntityDataDomainRefreshCompletedEventArgs:interface @@ -1197,43 +1212,6 @@ functions: // Read in the file as a data URL so we can parse the base64-encoded string. reader.readAsDataURL(myFile.files[0]); ``` - - name: Excel.getDataCommonPostprocess(response, callArgs) - uid: excel!Excel.getDataCommonPostprocess:function(1) - package: excel! - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'export function getDataCommonPostprocess(response: any, callArgs: any): any;' - parameters: - - id: response - description: '' - type: any - - id: callArgs - description: '' - type: any - return: - type: any - description: '' - - name: Excel.postprocessBindingDescriptor(response) - uid: excel!Excel.postprocessBindingDescriptor:function(1) - package: excel! - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'export function postprocessBindingDescriptor(response: any): any;' - parameters: - - id: response - description: '' - type: any - return: - type: any - description: '' - name: Excel.run(batch) uid: excel!Excel.run:function(1) package: excel! diff --git a/docs/docs-ref-autogen/excel/excel/excel.eventsource.yml b/docs/docs-ref-autogen/excel/excel/excel.eventsource.yml index 18e68e60d1..528b86dbe4 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.eventsource.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.eventsource.yml @@ -14,6 +14,7 @@ remarks: |- - [Excel.CommentAddedEventArgs](/javascript/api/excel/excel.commentaddedeventargs): [source](/javascript/api/excel/excel.commentaddedeventargs#excel-excel-commentaddedeventargs-source-member) - [Excel.CommentChangedEventArgs](/javascript/api/excel/excel.commentchangedeventargs): [source](/javascript/api/excel/excel.commentchangedeventargs#excel-excel-commentchangedeventargs-source-member) - [Excel.CommentDeletedEventArgs](/javascript/api/excel/excel.commentdeletedeventargs): [source](/javascript/api/excel/excel.commentdeletedeventargs#excel-excel-commentdeletedeventargs-source-member) + - [Excel.LinkedEntityCellValueLoadedEventArgs](/javascript/api/excel/excel.linkedentitycellvalueloadedeventargs): [source](/javascript/api/excel/excel.linkedentitycellvalueloadedeventargs#excel-excel-linkedentitycellvalueloadedeventargs-source-member) - [Excel.LinkedEntityDataDomainAddedEventArgs](/javascript/api/excel/excel.linkedentitydatadomainaddedeventargs): [source](/javascript/api/excel/excel.linkedentitydatadomainaddedeventargs#excel-excel-linkedentitydatadomainaddedeventargs-source-member) - [Excel.LinkedEntityDataDomainRefreshCompletedEventArgs](/javascript/api/excel/excel.linkedentitydatadomainrefreshcompletedeventargs): [source](/javascript/api/excel/excel.linkedentitydatadomainrefreshcompletedeventargs#excel-excel-linkedentitydatadomainrefreshcompletedeventargs-source-member) - [Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs](/javascript/api/excel/excel.linkedentitydatadomainrefreshmodechangedeventargs): [source](/javascript/api/excel/excel.linkedentitydatadomainrefreshmodechangedeventargs#excel-excel-linkedentitydatadomainrefreshmodechangedeventargs-source-member) diff --git a/docs/docs-ref-autogen/excel/excel/excel.interfaces.collectionloadoptions.yml b/docs/docs-ref-autogen/excel/excel/excel.interfaces.collectionloadoptions.yml index b23175eca9..14f2a8fd83 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.interfaces.collectionloadoptions.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.interfaces.collectionloadoptions.yml @@ -45,6 +45,7 @@ remarks: |- - [Excel.RangeCollection](/javascript/api/excel/excel.rangecollection): [load](/javascript/api/excel/excel.rangecollection#excel-excel-rangecollection-load-member(1)) - [Excel.RangeViewCollection](/javascript/api/excel/excel.rangeviewcollection): [load](/javascript/api/excel/excel.rangeviewcollection#excel-excel-rangeviewcollection-load-member(1)) - [Excel.RowColumnPivotHierarchyCollection](/javascript/api/excel/excel.rowcolumnpivothierarchycollection): [load](/javascript/api/excel/excel.rowcolumnpivothierarchycollection#excel-excel-rowcolumnpivothierarchycollection-load-member(1)) + - [Excel.SensitivityLabelDetailsCollection](/javascript/api/excel/excel.sensitivitylabeldetailscollection): [load](/javascript/api/excel/excel.sensitivitylabeldetailscollection#excel-excel-sensitivitylabeldetailscollection-load-member(1)) - [Excel.SettingCollection](/javascript/api/excel/excel.settingcollection): [load](/javascript/api/excel/excel.settingcollection#excel-excel-settingcollection-load-member(1)) - [Excel.ShapeCollection](/javascript/api/excel/excel.shapecollection): [load](/javascript/api/excel/excel.shapecollection#excel-excel-shapecollection-load-member(1)) - [Excel.SlicerCollection](/javascript/api/excel/excel.slicercollection): [load](/javascript/api/excel/excel.slicercollection#excel-excel-slicercollection-load-member(1)) diff --git a/docs/docs-ref-autogen/excel/excel/excel.interfaces.sensitivitylabeldetailscollectiondata.yml b/docs/docs-ref-autogen/excel/excel/excel.interfaces.sensitivitylabeldetailscollectiondata.yml new file mode 100644 index 0000000000..7d500b7dc4 --- /dev/null +++ b/docs/docs-ref-autogen/excel/excel/excel.interfaces.sensitivitylabeldetailscollectiondata.yml @@ -0,0 +1,28 @@ +### YamlMime:TSType +name: Excel.Interfaces.SensitivityLabelDetailsCollectionData +uid: excel!Excel.Interfaces.SensitivityLabelDetailsCollectionData:interface +package: excel! +fullName: Excel.Interfaces.SensitivityLabelDetailsCollectionData +summary: An interface describing the data returned by calling `sensitivityLabelDetailsCollection.toJSON()`. +remarks: |- + #### Used by + + - [Excel.SensitivityLabelDetailsCollection](/javascript/api/excel/excel.sensitivitylabeldetailscollection): [toJSON](/javascript/api/excel/excel.sensitivitylabeldetailscollection#excel-excel-sensitivitylabeldetailscollection-tojson-member(1)) + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.SensitivityLabelDetailsCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.SensitivityLabelDetailsData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel/excel/excel.interfaces.sensitivitylabeldetailscollectionloadoptions.yml b/docs/docs-ref-autogen/excel/excel/excel.interfaces.sensitivitylabeldetailscollectionloadoptions.yml new file mode 100644 index 0000000000..0c0eaa295d --- /dev/null +++ b/docs/docs-ref-autogen/excel/excel/excel.interfaces.sensitivitylabeldetailscollectionloadoptions.yml @@ -0,0 +1,147 @@ +### YamlMime:TSType +name: Excel.Interfaces.SensitivityLabelDetailsCollectionLoadOptions +uid: excel!Excel.Interfaces.SensitivityLabelDetailsCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.SensitivityLabelDetailsCollectionLoadOptions +summary: Represents the collection of [Excel.SensitivityLabelDetails](xref:excel!Excel.SensitivityLabelDetails:class) objects. +remarks: |- + [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + + #### Used by + + - [Excel.SensitivityLabelDetailsCollection](/javascript/api/excel/excel.sensitivitylabeldetailscollection): [load](/javascript/api/excel/excel.sensitivitylabeldetailscollection#excel-excel-sensitivitylabeldetailscollection-load-member(1)) + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.SensitivityLabelDetailsCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: 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`). + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: children + uid: excel!Excel.Interfaces.SensitivityLabelDetailsCollectionLoadOptions#children:member + package: excel! + fullName: children + summary: 'For EACH ITEM in the collection: Gets the sublabels of the sensitivity label. Returns `null` if a label doesn''t have any sublabels.' + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'children?: boolean;' + return: + type: boolean + - name: color + uid: excel!Excel.Interfaces.SensitivityLabelDetailsCollectionLoadOptions#color:member + package: excel! + fullName: color + summary: 'For EACH ITEM in the collection: Gets the color of the sensitivity label.' + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'color?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.SensitivityLabelDetailsCollectionLoadOptions#id:member + package: excel! + fullName: id + summary: 'For EACH ITEM in the collection: Gets the unique identifier (GUID) of the sensitivity label.' + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: isEnabled + uid: excel!Excel.Interfaces.SensitivityLabelDetailsCollectionLoadOptions#isEnabled:member + package: excel! + fullName: isEnabled + summary: 'For EACH ITEM in the collection: Gets a value indicating whether the label is enabled.' + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'isEnabled?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.SensitivityLabelDetailsCollectionLoadOptions#name:member + package: excel! + fullName: name + summary: 'For EACH ITEM in the collection: Gets the name of the sensitivity label.' + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: order + uid: excel!Excel.Interfaces.SensitivityLabelDetailsCollectionLoadOptions#order:member + package: excel! + fullName: order + summary: 'For EACH ITEM in the collection: Gets the priority of the sensitivity label, with 0 as lowest priority.' + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'order?: boolean;' + return: + type: boolean + - name: protectionType + uid: excel!Excel.Interfaces.SensitivityLabelDetailsCollectionLoadOptions#protectionType:member + package: excel! + fullName: protectionType + summary: 'For EACH ITEM in the collection: Gets a value indicating the protection type provided by this label.' + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'protectionType?: boolean;' + return: + type: boolean + - name: siteId + uid: excel!Excel.Interfaces.SensitivityLabelDetailsCollectionLoadOptions#siteId:member + package: excel! + fullName: siteId + summary: 'For EACH ITEM in the collection: Gets the unique identifier (GUID) of the tenant which the sensitivity label is belonged.' + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'siteId?: boolean;' + return: + type: boolean + - name: tooltip + uid: excel!Excel.Interfaces.SensitivityLabelDetailsCollectionLoadOptions#tooltip:member + package: excel! + fullName: tooltip + summary: 'For EACH ITEM in the collection: Gets the description of the sensitivity label.' + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'tooltip?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel/excel/excel.interfaces.sensitivitylabeldetailscollectionupdatedata.yml b/docs/docs-ref-autogen/excel/excel/excel.interfaces.sensitivitylabeldetailscollectionupdatedata.yml new file mode 100644 index 0000000000..5aea5c5174 --- /dev/null +++ b/docs/docs-ref-autogen/excel/excel/excel.interfaces.sensitivitylabeldetailscollectionupdatedata.yml @@ -0,0 +1,25 @@ +### YamlMime:TSType +name: Excel.Interfaces.SensitivityLabelDetailsCollectionUpdateData +uid: excel!Excel.Interfaces.SensitivityLabelDetailsCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.SensitivityLabelDetailsCollectionUpdateData +summary: An interface for updating data on the `SensitivityLabelDetailsCollection` object, for use in `sensitivityLabelDetailsCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.SensitivityLabelDetailsCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.SensitivityLabelDetailsData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel/excel/excel.interfaces.sensitivitylabeldetailsdata.yml b/docs/docs-ref-autogen/excel/excel/excel.interfaces.sensitivitylabeldetailsdata.yml new file mode 100644 index 0000000000..f08c6122ca --- /dev/null +++ b/docs/docs-ref-autogen/excel/excel/excel.interfaces.sensitivitylabeldetailsdata.yml @@ -0,0 +1,132 @@ +### YamlMime:TSType +name: Excel.Interfaces.SensitivityLabelDetailsData +uid: excel!Excel.Interfaces.SensitivityLabelDetailsData:interface +package: excel! +fullName: Excel.Interfaces.SensitivityLabelDetailsData +summary: An interface describing the data returned by calling `sensitivityLabelDetails.toJSON()`. +remarks: |- + #### Used by + + - [Excel.SensitivityLabelDetails](/javascript/api/excel/excel.sensitivitylabeldetails): [toJSON](/javascript/api/excel/excel.sensitivitylabeldetails#excel-excel-sensitivitylabeldetails-tojson-member(1)) + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: children + uid: excel!Excel.Interfaces.SensitivityLabelDetailsData#children:member + package: excel! + fullName: children + summary: Gets the sublabels of the sensitivity label. Returns `null` if a label doesn't have any sublabels. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'children?: SensitivityLabelDetailsCollection | null;' + return: + type: | null + - name: color + uid: excel!Excel.Interfaces.SensitivityLabelDetailsData#color:member + package: excel! + fullName: color + summary: Gets the color of the sensitivity label. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'color?: string;' + return: + type: string + - name: id + uid: excel!Excel.Interfaces.SensitivityLabelDetailsData#id:member + package: excel! + fullName: id + summary: Gets the unique identifier (GUID) of the sensitivity label. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: isEnabled + uid: excel!Excel.Interfaces.SensitivityLabelDetailsData#isEnabled:member + package: excel! + fullName: isEnabled + summary: Gets a value indicating whether the label is enabled. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'isEnabled?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.SensitivityLabelDetailsData#name:member + package: excel! + fullName: name + summary: Gets the name of the sensitivity label. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: order + uid: excel!Excel.Interfaces.SensitivityLabelDetailsData#order:member + package: excel! + fullName: order + summary: Gets the priority of the sensitivity label, with 0 as lowest priority. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'order?: number;' + return: + type: number + - name: protectionType + uid: excel!Excel.Interfaces.SensitivityLabelDetailsData#protectionType:member + package: excel! + fullName: protectionType + summary: Gets a value indicating the protection type provided by this label. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'protectionType?: Excel.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined";' + return: + type: | "NoProtection" | "AdminDefined" | "UserDefined" + - name: siteId + uid: excel!Excel.Interfaces.SensitivityLabelDetailsData#siteId:member + package: excel! + fullName: siteId + summary: Gets the unique identifier (GUID) of the tenant which the sensitivity label is belonged. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'siteId?: string;' + return: + type: string + - name: tooltip + uid: excel!Excel.Interfaces.SensitivityLabelDetailsData#tooltip:member + package: excel! + fullName: tooltip + summary: Gets the description of the sensitivity label. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'tooltip?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel/excel/excel.interfaces.sensitivitylabeldetailsloadoptions.yml b/docs/docs-ref-autogen/excel/excel/excel.interfaces.sensitivitylabeldetailsloadoptions.yml new file mode 100644 index 0000000000..aff330d417 --- /dev/null +++ b/docs/docs-ref-autogen/excel/excel/excel.interfaces.sensitivitylabeldetailsloadoptions.yml @@ -0,0 +1,147 @@ +### YamlMime:TSType +name: Excel.Interfaces.SensitivityLabelDetailsLoadOptions +uid: excel!Excel.Interfaces.SensitivityLabelDetailsLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.SensitivityLabelDetailsLoadOptions +summary: Represents the properties of available sensitivity labels in Excel. +remarks: |- + [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + + #### Used by + + - [Excel.SensitivityLabelDetails](/javascript/api/excel/excel.sensitivitylabeldetails): [load](/javascript/api/excel/excel.sensitivitylabeldetails#excel-excel-sensitivitylabeldetails-load-member(1)) + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.SensitivityLabelDetailsLoadOptions#$all:member + package: excel! + fullName: $all + summary: 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`). + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: children + uid: excel!Excel.Interfaces.SensitivityLabelDetailsLoadOptions#children:member + package: excel! + fullName: children + summary: Gets the sublabels of the sensitivity label. Returns `null` if a label doesn't have any sublabels. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'children?: boolean;' + return: + type: boolean + - name: color + uid: excel!Excel.Interfaces.SensitivityLabelDetailsLoadOptions#color:member + package: excel! + fullName: color + summary: Gets the color of the sensitivity label. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'color?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.SensitivityLabelDetailsLoadOptions#id:member + package: excel! + fullName: id + summary: Gets the unique identifier (GUID) of the sensitivity label. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: isEnabled + uid: excel!Excel.Interfaces.SensitivityLabelDetailsLoadOptions#isEnabled:member + package: excel! + fullName: isEnabled + summary: Gets a value indicating whether the label is enabled. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'isEnabled?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.SensitivityLabelDetailsLoadOptions#name:member + package: excel! + fullName: name + summary: Gets the name of the sensitivity label. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: order + uid: excel!Excel.Interfaces.SensitivityLabelDetailsLoadOptions#order:member + package: excel! + fullName: order + summary: Gets the priority of the sensitivity label, with 0 as lowest priority. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'order?: boolean;' + return: + type: boolean + - name: protectionType + uid: excel!Excel.Interfaces.SensitivityLabelDetailsLoadOptions#protectionType:member + package: excel! + fullName: protectionType + summary: Gets a value indicating the protection type provided by this label. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'protectionType?: boolean;' + return: + type: boolean + - name: siteId + uid: excel!Excel.Interfaces.SensitivityLabelDetailsLoadOptions#siteId:member + package: excel! + fullName: siteId + summary: Gets the unique identifier (GUID) of the tenant which the sensitivity label is belonged. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'siteId?: boolean;' + return: + type: boolean + - name: tooltip + uid: excel!Excel.Interfaces.SensitivityLabelDetailsLoadOptions#tooltip:member + package: excel! + fullName: tooltip + summary: Gets the description of the sensitivity label. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'tooltip?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel/excel/excel.interfaces.sensitivitylabelscatalogdata.yml b/docs/docs-ref-autogen/excel/excel/excel.interfaces.sensitivitylabelscatalogdata.yml new file mode 100644 index 0000000000..a77807668e --- /dev/null +++ b/docs/docs-ref-autogen/excel/excel/excel.interfaces.sensitivitylabelscatalogdata.yml @@ -0,0 +1,28 @@ +### YamlMime:TSType +name: Excel.Interfaces.SensitivityLabelsCatalogData +uid: excel!Excel.Interfaces.SensitivityLabelsCatalogData:interface +package: excel! +fullName: Excel.Interfaces.SensitivityLabelsCatalogData +summary: An interface describing the data returned by calling `sensitivityLabelsCatalog.toJSON()`. +remarks: |- + #### Used by + + - [Excel.SensitivityLabelsCatalog](/javascript/api/excel/excel.sensitivitylabelscatalog): [toJSON](/javascript/api/excel/excel.sensitivitylabelscatalog#excel-excel-sensitivitylabelscatalog-tojson-member(1)) + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: getLabelingCapability + uid: excel!Excel.Interfaces.SensitivityLabelsCatalogData#getLabelingCapability:member + package: excel! + fullName: getLabelingCapability + summary: Gets whether the catalog of sensitivity labels is enabled in Excel. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'getLabelingCapability?: Excel.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled";' + return: + type: | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled" diff --git a/docs/docs-ref-autogen/excel/excel/excel.interfaces.sensitivitylabelscatalogloadoptions.yml b/docs/docs-ref-autogen/excel/excel/excel.interfaces.sensitivitylabelscatalogloadoptions.yml new file mode 100644 index 0000000000..055bd1eef2 --- /dev/null +++ b/docs/docs-ref-autogen/excel/excel/excel.interfaces.sensitivitylabelscatalogloadoptions.yml @@ -0,0 +1,43 @@ +### YamlMime:TSType +name: Excel.Interfaces.SensitivityLabelsCatalogLoadOptions +uid: excel!Excel.Interfaces.SensitivityLabelsCatalogLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.SensitivityLabelsCatalogLoadOptions +summary: Provides methods to check the status of the catalog of sensitivity labels in Excel and retrieve all available sensitivity labels if the catalog is enabled. +remarks: |- + [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + + #### Used by + + - [Excel.SensitivityLabelsCatalog](/javascript/api/excel/excel.sensitivitylabelscatalog): [load](/javascript/api/excel/excel.sensitivitylabelscatalog#excel-excel-sensitivitylabelscatalog-load-member(1)) + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.SensitivityLabelsCatalogLoadOptions#$all:member + package: excel! + fullName: $all + summary: 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`). + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: getLabelingCapability + uid: excel!Excel.Interfaces.SensitivityLabelsCatalogLoadOptions#getLabelingCapability:member + package: excel! + fullName: getLabelingCapability + summary: Gets whether the catalog of sensitivity labels is enabled in Excel. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'getLabelingCapability?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel/excel/excel.labelingcapability.yml b/docs/docs-ref-autogen/excel/excel/excel.labelingcapability.yml new file mode 100644 index 0000000000..68f952a86a --- /dev/null +++ b/docs/docs-ref-autogen/excel/excel/excel.labelingcapability.yml @@ -0,0 +1,48 @@ +### YamlMime:TSEnum +name: Excel.LabelingCapability +uid: excel!Excel.LabelingCapability:enum +package: excel! +fullName: Excel.LabelingCapability +summary: Represents the labeling capability status of the sensitivity label catalog. +remarks: |- + [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + + #### Used by + + - [Excel.SensitivityLabelsCatalog](/javascript/api/excel/excel.sensitivitylabelscatalog): [getLabelingCapability](/javascript/api/excel/excel.sensitivitylabelscatalog#excel-excel-sensitivitylabelscatalog-getlabelingcapability-member) + +isPreview: true +isDeprecated: false +fields: + - name: labelingDisabled + uid: excel!Excel.LabelingCapability.labelingDisabled:member + package: excel! + summary: |- + Sensitivity labeling is disabled for the user or tenant. + + * [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + value: '"LabelingDisabled"' + - name: labelingEnabled + uid: excel!Excel.LabelingCapability.labelingEnabled:member + package: excel! + summary: |- + Sensitivity labeling is fully enabled. + + * [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + value: '"LabelingEnabled"' + - name: labelingPolicyNotFound + uid: excel!Excel.LabelingCapability.labelingPolicyNotFound:member + package: excel! + summary: |- + No labeling policy was found for the user. + + * [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + value: '"LabelingPolicyNotFound"' + - name: noLicense + uid: excel!Excel.LabelingCapability.noLicense:member + package: excel! + summary: |- + No valid license is available for sensitivity labeling. + + * [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + value: '"NoLicense"' diff --git a/docs/docs-ref-autogen/excel/excel/excel.linkedentitycellvalue.yml b/docs/docs-ref-autogen/excel/excel/excel.linkedentitycellvalue.yml index 452fa6206c..593f70229f 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.linkedentitycellvalue.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.linkedentitycellvalue.yml @@ -9,6 +9,7 @@ remarks: |- #### Used by + - [Excel.LinkedEntityCellValueLoadedEventArgs](/javascript/api/excel/excel.linkedentitycellvalueloadedeventargs): [linkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalueloadedeventargs#excel-excel-linkedentitycellvalueloadedeventargs-linkedentitycellvalue-member) - [Excel.LinkedEntityLoadServiceResult](/javascript/api/excel/excel.linkedentityloadserviceresult): [entities](/javascript/api/excel/excel.linkedentityloadserviceresult#excel-excel-linkedentityloadserviceresult-entities-member) - [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue): [target](/javascript/api/excel/excel.placeholdererrorcellvalue#excel-excel-placeholdererrorcellvalue-target-member) - [Excel.Workbook](/javascript/api/excel/excel.workbook): [getLinkedEntityCellValue](/javascript/api/excel/excel.workbook#excel-excel-workbook-getlinkedentitycellvalue-member(1)) diff --git a/docs/docs-ref-autogen/excel/excel/excel.linkedentitycellvalueloadedeventargs.yml b/docs/docs-ref-autogen/excel/excel/excel.linkedentitycellvalueloadedeventargs.yml new file mode 100644 index 0000000000..77cb8da947 --- /dev/null +++ b/docs/docs-ref-autogen/excel/excel/excel.linkedentitycellvalueloadedeventargs.yml @@ -0,0 +1,82 @@ +### YamlMime:TSType +name: Excel.LinkedEntityCellValueLoadedEventArgs +uid: excel!Excel.LinkedEntityCellValueLoadedEventArgs:interface +package: excel! +fullName: Excel.LinkedEntityCellValueLoadedEventArgs +summary: Provides information about the `LinkedEntityCellValue` that was requested given a specified `LinkedEntityId`. +remarks: |- + [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + + #### Used by + + - [Excel.LinkedEntityDataDomainCollection](/javascript/api/excel/excel.linkedentitydatadomaincollection): [onLinkedEntityCellValueLoaded](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-onlinkedentitycellvalueloaded-member) + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: error + uid: excel!Excel.LinkedEntityCellValueLoadedEventArgs#error:member + package: excel! + fullName: error + summary: Any error encountered during the request to load the `LinkedEntityCellValue`. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'error?: string;' + return: + type: string + - name: id + uid: excel!Excel.LinkedEntityCellValueLoadedEventArgs#id:member + package: excel! + fullName: id + summary: Gets the `LinkedEntityId` of the requested `LinkedEntityCellValue`. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'id: LinkedEntityId;' + return: + type: + - name: linkedEntityCellValue + uid: excel!Excel.LinkedEntityCellValueLoadedEventArgs#linkedEntityCellValue:member + package: excel! + fullName: linkedEntityCellValue + summary: Gets the `LinkedEntityCellValue` of the requested `LinkedEntityId`. If the load operation failed, this property is `null`. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'linkedEntityCellValue?: LinkedEntityCellValue;' + return: + type: + - name: source + uid: excel!Excel.LinkedEntityCellValueLoadedEventArgs#source:member + package: excel! + fullName: source + summary: Gets the source of the event. See `Excel.EventSource` for details. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'source: Excel.EventSource | "Local" | "Remote";' + return: + type: | "Local" | "Remote" + - name: type + uid: excel!Excel.LinkedEntityCellValueLoadedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'type: "LinkedEntityDataDomainLinkedEntityCellValueLoaded";' + return: + type: '"LinkedEntityDataDomainLinkedEntityCellValueLoaded"' diff --git a/docs/docs-ref-autogen/excel/excel/excel.linkedentitydatadomaincollection.yml b/docs/docs-ref-autogen/excel/excel/excel.linkedentitydatadomaincollection.yml index 47fc179701..87990048c2 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.linkedentitydatadomaincollection.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.linkedentitydatadomaincollection.yml @@ -241,6 +241,24 @@ methods: return: type: description: '' + - name: loadLinkedEntityCellValue(id) + uid: excel!Excel.LinkedEntityDataDomainCollection#loadLinkedEntityCellValue:member(1) + package: excel! + fullName: loadLinkedEntityCellValue(id) + summary: Submits a request to load the `LinkedEntityCellValue` object with the specified `LinkedEntityId`. If found, the `LinkedEntityCellValue` object will be returned through the `LinkedEntityCellValueLoaded` event. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'loadLinkedEntityCellValue(id: LinkedEntityId): void;' + parameters: + - id: id + description: A specific `LinkedEntityId` + type: + return: + type: void + description: '' - name: refreshAll() uid: excel!Excel.LinkedEntityDataDomainCollection#refreshAll:member(1) package: excel! @@ -273,6 +291,19 @@ methods: type: description: '' events: + - name: onLinkedEntityCellValueLoaded + uid: excel!Excel.LinkedEntityDataDomainCollection#onLinkedEntityCellValueLoaded:member + package: excel! + fullName: onLinkedEntityCellValueLoaded + summary: Occurs when the request to load a `LinkedEntityCellValue` is completed. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly onLinkedEntityCellValueLoaded: OfficeExtension.EventHandlers;' + return: + type: <> - name: onLinkedEntityDataDomainAdded uid: excel!Excel.LinkedEntityDataDomainCollection#onLinkedEntityDataDomainAdded:member package: excel! diff --git a/docs/docs-ref-autogen/excel/excel/excel.linkedentityid.yml b/docs/docs-ref-autogen/excel/excel/excel.linkedentityid.yml index e1669a0f24..9f24698cf2 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.linkedentityid.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.linkedentityid.yml @@ -10,6 +10,8 @@ remarks: |- #### Used by - [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue): [id](/javascript/api/excel/excel.linkedentitycellvalue#excel-excel-linkedentitycellvalue-id-member) + - [Excel.LinkedEntityCellValueLoadedEventArgs](/javascript/api/excel/excel.linkedentitycellvalueloadedeventargs): [id](/javascript/api/excel/excel.linkedentitycellvalueloadedeventargs#excel-excel-linkedentitycellvalueloadedeventargs-id-member) + - [Excel.LinkedEntityDataDomainCollection](/javascript/api/excel/excel.linkedentitydatadomaincollection): [loadLinkedEntityCellValue](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-loadlinkedentitycellvalue-member(1)) - [Excel.Workbook](/javascript/api/excel/excel.workbook): [getLinkedEntityCellValue](/javascript/api/excel/excel.workbook#excel-excel-workbook-getlinkedentitycellvalue-member(1)) isPreview: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.requestcontext.yml b/docs/docs-ref-autogen/excel/excel/excel.requestcontext.yml index 3eac839f38..867b6f14b1 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.requestcontext.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.requestcontext.yml @@ -163,6 +163,10 @@ remarks: |- - [Excel.RowColumnPivotHierarchy](/javascript/api/excel/excel.rowcolumnpivothierarchy): [context](/javascript/api/excel/excel.rowcolumnpivothierarchy#excel-excel-rowcolumnpivothierarchy-context-member) - [Excel.RowColumnPivotHierarchyCollection](/javascript/api/excel/excel.rowcolumnpivothierarchycollection): [context](/javascript/api/excel/excel.rowcolumnpivothierarchycollection#excel-excel-rowcolumnpivothierarchycollection-context-member) - [Excel.Runtime](/javascript/api/excel/excel.runtime): [context](/javascript/api/excel/excel.runtime#excel-excel-runtime-context-member) + - [Excel.SensitivityLabel](/javascript/api/excel/excel.sensitivitylabel): [context](/javascript/api/excel/excel.sensitivitylabel#excel-excel-sensitivitylabel-context-member) + - [Excel.SensitivityLabelDetails](/javascript/api/excel/excel.sensitivitylabeldetails): [context](/javascript/api/excel/excel.sensitivitylabeldetails#excel-excel-sensitivitylabeldetails-context-member) + - [Excel.SensitivityLabelDetailsCollection](/javascript/api/excel/excel.sensitivitylabeldetailscollection): [context](/javascript/api/excel/excel.sensitivitylabeldetailscollection#excel-excel-sensitivitylabeldetailscollection-context-member) + - [Excel.SensitivityLabelsCatalog](/javascript/api/excel/excel.sensitivitylabelscatalog): [context](/javascript/api/excel/excel.sensitivitylabelscatalog#excel-excel-sensitivitylabelscatalog-context-member) - [Excel.Setting](/javascript/api/excel/excel.setting): [context](/javascript/api/excel/excel.setting#excel-excel-setting-context-member) - [Excel.SettingCollection](/javascript/api/excel/excel.settingcollection): [context](/javascript/api/excel/excel.settingcollection#excel-excel-settingcollection-context-member) - [Excel.Shape](/javascript/api/excel/excel.shape): [context](/javascript/api/excel/excel.shape#excel-excel-shape-context-member) @@ -279,6 +283,19 @@ properties: content: 'readonly runtime: Runtime;' return: type: + - name: sensitivityLabelsCatalog + uid: excel!Excel.RequestContext#sensitivityLabelsCatalog:member + package: excel! + fullName: sensitivityLabelsCatalog + summary: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly sensitivityLabelsCatalog: SensitivityLabelsCatalog;' + return: + type: - name: workbook uid: excel!Excel.RequestContext#workbook:member package: excel! diff --git a/docs/docs-ref-autogen/excel/excel/excel.sensitivitylabel.yml b/docs/docs-ref-autogen/excel/excel/excel.sensitivitylabel.yml new file mode 100644 index 0000000000..7e9b2d44a0 --- /dev/null +++ b/docs/docs-ref-autogen/excel/excel/excel.sensitivitylabel.yml @@ -0,0 +1,84 @@ +### YamlMime:TSType +name: Excel.SensitivityLabel +uid: excel!Excel.SensitivityLabel:class +package: excel! +fullName: Excel.SensitivityLabel +summary: Represents the sensitivity label on the workbook. +remarks: |- + [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + + #### Used by + + - [Excel.Workbook](/javascript/api/excel/excel.workbook): [sensitivityLabel](/javascript/api/excel/excel.workbook#excel-excel-workbook-sensitivitylabel-member) + +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.SensitivityLabel#context:member + package: excel! + fullName: context + summary: The request context associated with the object. This connects the add-in's process to the Office host application's process. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: +methods: + - name: getCurrentOrNullObject() + uid: excel!Excel.SensitivityLabel#getCurrentOrNullObject:member(1) + package: excel! + fullName: getCurrentOrNullObject() + summary: Gets the current label information that exists on the workbook for the user. If there's no sensitivity label on the current workbook, an object with an `isNullObject` property set to `true` is returned. For further information, see [*OrNullObject methods and properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'getCurrentOrNullObject(): Excel.SensitivityLabelDetails;' + return: + type: + description: The current `SensitivityLabelDetails` object. + - name: toJSON() + uid: excel!Excel.SensitivityLabel#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: 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.SensitivityLabel` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.SensitivityLabelData`) that contains shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: |- + toJSON(): { + [key: string]: string; + }; + return: + type: |- + { + [key: string]: string; + } + description: '' + - name: tryToUpdate(labelId) + uid: excel!Excel.SensitivityLabel#tryToUpdate:member(1) + package: excel! + fullName: tryToUpdate(labelId) + summary: Tries to update to the provided sensitivity label on the workbook for the user. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'tryToUpdate(labelId: string): OfficeExtension.ClientResult;' + parameters: + - id: labelId + description: The ID of the label to apply. + type: string + return: + type: <> + description: The `SensitivityLabelUpdateResult` object. +extends: diff --git a/docs/docs-ref-autogen/excel/excel/excel.sensitivitylabeldetails.yml b/docs/docs-ref-autogen/excel/excel/excel.sensitivitylabeldetails.yml new file mode 100644 index 0000000000..4e6f468b2a --- /dev/null +++ b/docs/docs-ref-autogen/excel/excel/excel.sensitivitylabeldetails.yml @@ -0,0 +1,226 @@ +### YamlMime:TSType +name: Excel.SensitivityLabelDetails +uid: excel!Excel.SensitivityLabelDetails:class +package: excel! +fullName: Excel.SensitivityLabelDetails +summary: Represents the properties of available sensitivity labels in Excel. +remarks: |- + [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + + #### Used by + + - [Excel.SensitivityLabel](/javascript/api/excel/excel.sensitivitylabel): [getCurrentOrNullObject](/javascript/api/excel/excel.sensitivitylabel#excel-excel-sensitivitylabel-getcurrentornullobject-member(1)) + - [Excel.SensitivityLabelDetailsCollection](/javascript/api/excel/excel.sensitivitylabeldetailscollection): [getFirst](/javascript/api/excel/excel.sensitivitylabeldetailscollection#excel-excel-sensitivitylabeldetailscollection-getfirst-member(1)), [items](/javascript/api/excel/excel.sensitivitylabeldetailscollection#excel-excel-sensitivitylabeldetailscollection-items-member) + +isPreview: true +isDeprecated: false +type: class +properties: + - name: children + uid: excel!Excel.SensitivityLabelDetails#children:member + package: excel! + fullName: children + summary: Gets the sublabels of the sensitivity label. Returns `null` if a label doesn't have any sublabels. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly children: SensitivityLabelDetailsCollection | null;' + return: + type: | null + - name: color + uid: excel!Excel.SensitivityLabelDetails#color:member + package: excel! + fullName: color + summary: Gets the color of the sensitivity label. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly color: string;' + return: + type: string + - name: context + uid: excel!Excel.SensitivityLabelDetails#context:member + package: excel! + fullName: context + summary: The request context associated with the object. This connects the add-in's process to the Office host application's process. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: id + uid: excel!Excel.SensitivityLabelDetails#id:member + package: excel! + fullName: id + summary: Gets the unique identifier (GUID) of the sensitivity label. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly id: string;' + return: + type: string + - name: isEnabled + uid: excel!Excel.SensitivityLabelDetails#isEnabled:member + package: excel! + fullName: isEnabled + summary: Gets a value indicating whether the label is enabled. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly isEnabled: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.SensitivityLabelDetails#name:member + package: excel! + fullName: name + summary: Gets the name of the sensitivity label. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly name: string;' + return: + type: string + - name: order + uid: excel!Excel.SensitivityLabelDetails#order:member + package: excel! + fullName: order + summary: Gets the priority of the sensitivity label, with 0 as lowest priority. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly order: number;' + return: + type: number + - name: protectionType + uid: excel!Excel.SensitivityLabelDetails#protectionType:member + package: excel! + fullName: protectionType + summary: Gets a value indicating the protection type provided by this label. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly protectionType: Excel.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined";' + return: + type: | "NoProtection" | "AdminDefined" | "UserDefined" + - name: siteId + uid: excel!Excel.SensitivityLabelDetails#siteId:member + package: excel! + fullName: siteId + summary: Gets the unique identifier (GUID) of the tenant which the sensitivity label is belonged. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly siteId: string;' + return: + type: string + - name: tooltip + uid: excel!Excel.SensitivityLabelDetails#tooltip:member + package: excel! + fullName: tooltip + summary: Gets the description of the sensitivity label. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly tooltip: string;' + return: + type: string +methods: + - name: load(options) + uid: excel!Excel.SensitivityLabelDetails#load:member(1) + package: excel! + fullName: load(options) + summary: Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.SensitivityLabelDetailsLoadOptions): Excel.SensitivityLabelDetails;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.SensitivityLabelDetails#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.SensitivityLabelDetails;' + parameters: + - id: propertyNames + description: A comma-delimited string or an array of strings that specify the properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.SensitivityLabelDetails#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.SensitivityLabelDetails; + parameters: + - id: propertyNamesAndPaths + description: '`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.' + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.SensitivityLabelDetails#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: 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.SensitivityLabelDetails` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.SensitivityLabelDetailsData`) that contains shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.SensitivityLabelDetailsData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel/excel/excel.sensitivitylabeldetailscollection.yml b/docs/docs-ref-autogen/excel/excel/excel.sensitivitylabeldetailscollection.yml new file mode 100644 index 0000000000..33e6e30706 --- /dev/null +++ b/docs/docs-ref-autogen/excel/excel/excel.sensitivitylabeldetailscollection.yml @@ -0,0 +1,142 @@ +### YamlMime:TSType +name: Excel.SensitivityLabelDetailsCollection +uid: excel!Excel.SensitivityLabelDetailsCollection:class +package: excel! +fullName: Excel.SensitivityLabelDetailsCollection +summary: Represents the collection of [Excel.SensitivityLabelDetails](xref:excel!Excel.SensitivityLabelDetails:class) objects. +remarks: |- + [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + + #### Used by + + - [Excel.SensitivityLabelDetails](/javascript/api/excel/excel.sensitivitylabeldetails): [children](/javascript/api/excel/excel.sensitivitylabeldetails#excel-excel-sensitivitylabeldetails-children-member) + - [Excel.SensitivityLabelsCatalog](/javascript/api/excel/excel.sensitivitylabelscatalog): [getLabels](/javascript/api/excel/excel.sensitivitylabelscatalog#excel-excel-sensitivitylabelscatalog-getlabels-member(1)) + +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.SensitivityLabelDetailsCollection#context:member + package: excel! + fullName: context + summary: The request context associated with the object. This connects the add-in's process to the Office host application's process. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.SensitivityLabelDetailsCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly items: Excel.SensitivityLabelDetails[];' + return: + type: [] +methods: + - name: getFirst() + uid: excel!Excel.SensitivityLabelDetailsCollection#getFirst:member(1) + package: excel! + fullName: getFirst() + summary: Gets the first `SensitivityLabelDetails` object in this collection. Throws an `ItemNotFound` error if this collection is empty. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'getFirst(): Excel.SensitivityLabelDetails;' + return: + type: + description: A new `SensitivityLabelDetails` object. + - name: getFirstOrNullObject() + uid: excel!Excel.SensitivityLabelDetailsCollection#getFirstOrNullObject:member(1) + package: excel! + fullName: getFirstOrNullObject() + summary: 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](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'getFirstOrNullObject(): OfficeExtension.ClientResult;' + return: + type: <any> + description: The new `SensitivityLabelDetails` object. + - name: load(options) + uid: excel!Excel.SensitivityLabelDetailsCollection#load:member(1) + package: excel! + fullName: load(options) + summary: Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.SensitivityLabelDetailsCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SensitivityLabelDetailsCollection;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.SensitivityLabelDetailsCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.SensitivityLabelDetailsCollection;' + parameters: + - id: propertyNames + description: A comma-delimited string or an array of strings that specify the properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.SensitivityLabelDetailsCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.SensitivityLabelDetailsCollection;' + parameters: + - id: propertyNamesAndPaths + description: '`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.' + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.SensitivityLabelDetailsCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: 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. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.SensitivityLabelDetailsCollectionData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel/excel/excel.sensitivitylabelprotectiontype.yml b/docs/docs-ref-autogen/excel/excel/excel.sensitivitylabelprotectiontype.yml new file mode 100644 index 0000000000..80592240b3 --- /dev/null +++ b/docs/docs-ref-autogen/excel/excel/excel.sensitivitylabelprotectiontype.yml @@ -0,0 +1,40 @@ +### YamlMime:TSEnum +name: Excel.SensitivityLabelProtectionType +uid: excel!Excel.SensitivityLabelProtectionType:enum +package: excel! +fullName: Excel.SensitivityLabelProtectionType +summary: Represents the protection type. +remarks: |- + [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + + #### Used by + + - [Excel.SensitivityLabelDetails](/javascript/api/excel/excel.sensitivitylabeldetails): [protectionType](/javascript/api/excel/excel.sensitivitylabeldetails#excel-excel-sensitivitylabeldetails-protectiontype-member) + +isPreview: true +isDeprecated: false +fields: + - name: adminDefined + uid: excel!Excel.SensitivityLabelProtectionType.adminDefined:member + package: excel! + summary: |- + Protection is defined by an administrator. + + * [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + value: '"AdminDefined"' + - name: noProtection + uid: excel!Excel.SensitivityLabelProtectionType.noProtection:member + package: excel! + summary: |- + No protection is applied by this label. + + * [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + value: '"NoProtection"' + - name: userDefined + uid: excel!Excel.SensitivityLabelProtectionType.userDefined:member + package: excel! + summary: |- + Protection is defined by the user. + + * [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + value: '"UserDefined"' diff --git a/docs/docs-ref-autogen/excel/excel/excel.sensitivitylabelscatalog.yml b/docs/docs-ref-autogen/excel/excel/excel.sensitivitylabelscatalog.yml new file mode 100644 index 0000000000..0a37d6db0c --- /dev/null +++ b/docs/docs-ref-autogen/excel/excel/excel.sensitivitylabelscatalog.yml @@ -0,0 +1,135 @@ +### YamlMime:TSType +name: Excel.SensitivityLabelsCatalog +uid: excel!Excel.SensitivityLabelsCatalog:class +package: excel! +fullName: Excel.SensitivityLabelsCatalog +summary: Provides methods to check the status of the catalog of sensitivity labels in Excel and retrieve all available sensitivity labels if the catalog is enabled. +remarks: |- + [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + + #### Used by + + - [Excel.RequestContext](/javascript/api/excel/excel.requestcontext): [sensitivityLabelsCatalog](/javascript/api/excel/excel.requestcontext#excel-excel-requestcontext-sensitivitylabelscatalog-member) + +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.SensitivityLabelsCatalog#context:member + package: excel! + fullName: context + summary: The request context associated with the object. This connects the add-in's process to the Office host application's process. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: getLabelingCapability + uid: excel!Excel.SensitivityLabelsCatalog#getLabelingCapability:member + package: excel! + fullName: getLabelingCapability + summary: Gets whether the catalog of sensitivity labels is enabled in Excel. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly getLabelingCapability: Excel.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled";' + return: + type: | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled" +methods: + - name: getLabels() + uid: excel!Excel.SensitivityLabelsCatalog#getLabels:member(1) + package: excel! + fullName: getLabels() + summary: Gets sensitivity labels that are available to the current user. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'getLabels(): Excel.SensitivityLabelDetailsCollection;' + return: + type: + description: The current `SensitivityLabelDetailsCollection` object. + - name: load(options) + uid: excel!Excel.SensitivityLabelsCatalog#load:member(1) + package: excel! + fullName: load(options) + summary: Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.SensitivityLabelsCatalogLoadOptions): Excel.SensitivityLabelsCatalog;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.SensitivityLabelsCatalog#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.SensitivityLabelsCatalog;' + parameters: + - id: propertyNames + description: A comma-delimited string or an array of strings that specify the properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.SensitivityLabelsCatalog#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.SensitivityLabelsCatalog; + parameters: + - id: propertyNamesAndPaths + description: '`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.' + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.SensitivityLabelsCatalog#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: 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.SensitivityLabelsCatalog` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.SensitivityLabelsCatalogData`) that contains shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.SensitivityLabelsCatalogData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel/excel/excel.sensitivitylabelupdateresult.yml b/docs/docs-ref-autogen/excel/excel/excel.sensitivitylabelupdateresult.yml new file mode 100644 index 0000000000..3c70cd1de0 --- /dev/null +++ b/docs/docs-ref-autogen/excel/excel/excel.sensitivitylabelupdateresult.yml @@ -0,0 +1,104 @@ +### YamlMime:TSEnum +name: Excel.SensitivityLabelUpdateResult +uid: excel!Excel.SensitivityLabelUpdateResult:enum +package: excel! +fullName: Excel.SensitivityLabelUpdateResult +summary: Represents the result of updating the sensitivity label on the workbook. +remarks: |- + [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + + #### Used by + + - [Excel.SensitivityLabel](/javascript/api/excel/excel.sensitivitylabel): [tryToUpdate](/javascript/api/excel/excel.sensitivitylabel#excel-excel-sensitivitylabel-trytoupdate-member(1)) + +isPreview: true +isDeprecated: false +fields: + - name: crossTenant + uid: excel!Excel.SensitivityLabelUpdateResult.crossTenant:member + package: excel! + summary: |- + The label update failed because the document doesn't belong to the same tenant as the user. + + * [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + value: '"CrossTenant"' + - name: documentReadOnly + uid: excel!Excel.SensitivityLabelUpdateResult.documentReadOnly:member + package: excel! + summary: |- + The document is read-only and cannot be modified. + + * [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + value: '"DocumentReadOnly"' + - name: insufficientPermission + uid: excel!Excel.SensitivityLabelUpdateResult.insufficientPermission:member + package: excel! + summary: |- + The user does not have sufficient permissions to update the label. + + * [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + value: '"InsufficientPermission"' + - name: labelingDisabled + uid: excel!Excel.SensitivityLabelUpdateResult.labelingDisabled:member + package: excel! + summary: |- + The label update failed because native labeling is not enabled for the user or installed SKU. + + * [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + value: '"LabelingDisabled"' + - name: labelNotFound + uid: excel!Excel.SensitivityLabelUpdateResult.labelNotFound:member + package: excel! + summary: |- + The specified sensitivity label could not be found. + + * [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + value: '"LabelNotFound"' + - name: parentLabelNotSupported + uid: excel!Excel.SensitivityLabelUpdateResult.parentLabelNotSupported:member + package: excel! + summary: |- + The label update failed because the specified label is a parent label, which cannot be applied. + + * [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + value: '"ParentLabelNotSupported"' + - name: success + uid: excel!Excel.SensitivityLabelUpdateResult.success:member + package: excel! + summary: |- + The sensitivity label was successfully updated. + + * [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + value: '"Success"' + - name: unspecifiedFailure + uid: excel!Excel.SensitivityLabelUpdateResult.unspecifiedFailure:member + package: excel! + summary: |- + The update failed due to an unspecified error. + + * [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + value: '"UnspecifiedFailure"' + - name: unsupportedDoubleKeyEncryption + uid: excel!Excel.SensitivityLabelUpdateResult.unsupportedDoubleKeyEncryption:member + package: excel! + summary: |- + The label update failed due to unsupported Double Key Encryption (DKE). + + * [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + value: '"UnsupportedDoubleKeyEncryption"' + - name: unsupportedUdp + uid: excel!Excel.SensitivityLabelUpdateResult.unsupportedUdp:member + package: excel! + summary: |- + The label update failed due to unsupported User Defined Permissions (UDP). + + * [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + value: '"UnsupportedUdp"' + - name: userNotFound + uid: excel!Excel.SensitivityLabelUpdateResult.userNotFound:member + package: excel! + summary: |- + The label update failed because the user's identity is not valid for applying a label. + + * [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + value: '"UserNotFound"' diff --git a/docs/docs-ref-autogen/excel/excel/excel.workbook.yml b/docs/docs-ref-autogen/excel/excel/excel.workbook.yml index 468d3db070..4f8d8030f9 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.workbook.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.workbook.yml @@ -410,6 +410,19 @@ properties: content: 'readonly readOnly: boolean;' return: type: boolean + - name: sensitivityLabel + uid: excel!Excel.Workbook#sensitivityLabel:member + package: excel! + fullName: sensitivityLabel + summary: Returns the sensitivity label of the workbook. + remarks: '[API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly sensitivityLabel: Excel.SensitivityLabel;' + return: + type: - name: settings uid: excel!Excel.Workbook#settings:member package: excel! diff --git a/docs/docs-ref-autogen/excel/toc.yml b/docs/docs-ref-autogen/excel/toc.yml index c5112ffbe7..796557c069 100644 --- a/docs/docs-ref-autogen/excel/toc.yml +++ b/docs/docs-ref-autogen/excel/toc.yml @@ -260,6 +260,8 @@ items: uid: excel!Excel.KeyboardDirection:enum - name: LabelFilterCondition uid: excel!Excel.LabelFilterCondition:enum + - name: LabelingCapability + uid: excel!Excel.LabelingCapability:enum - name: LinkedDataTypeState uid: excel!Excel.LinkedDataTypeState:enum - name: LinkedEntityDataDomainRefreshMode @@ -334,6 +336,10 @@ items: uid: excel!Excel.ScrollWorkbookTabPosition:enum - name: SearchDirection uid: excel!Excel.SearchDirection:enum + - name: SensitivityLabelProtectionType + uid: excel!Excel.SensitivityLabelProtectionType:enum + - name: SensitivityLabelUpdateResult + uid: excel!Excel.SensitivityLabelUpdateResult:enum - name: ShapeAutoSize uid: excel!Excel.ShapeAutoSize:enum - name: ShapeFillType @@ -867,6 +873,8 @@ items: uid: excel!Excel.Line:class - name: LinkedEntityCellValue uid: excel!Excel.LinkedEntityCellValue:interface + - name: LinkedEntityCellValueLoadedEventArgs + uid: excel!Excel.LinkedEntityCellValueLoadedEventArgs:interface - name: LinkedEntityDataDomain uid: excel!Excel.LinkedEntityDataDomain:class - name: LinkedEntityDataDomainAddedEventArgs @@ -1045,6 +1053,14 @@ items: uid: excel!Excel.SearchCriteria:interface - name: SelectionChangedEventArgs uid: excel!Excel.SelectionChangedEventArgs:interface + - name: SensitivityLabel + uid: excel!Excel.SensitivityLabel:class + - name: SensitivityLabelDetails + uid: excel!Excel.SensitivityLabelDetails:class + - name: SensitivityLabelDetailsCollection + uid: excel!Excel.SensitivityLabelDetailsCollection:class + - name: SensitivityLabelsCatalog + uid: excel!Excel.SensitivityLabelsCatalog:class - name: Session uid: excel!Excel.Session:interface - name: SettableCellProperties diff --git a/docs/docs-ref-autogen/office/office/officeextension.clientrequestcontext.yml b/docs/docs-ref-autogen/office/office/officeextension.clientrequestcontext.yml index 5cda884291..bba9867366 100644 --- a/docs/docs-ref-autogen/office/office/officeextension.clientrequestcontext.yml +++ b/docs/docs-ref-autogen/office/office/officeextension.clientrequestcontext.yml @@ -18,6 +18,7 @@ remarks: |- - [Visio](/javascript/api/visio): [run](/javascript/api/visio#visio-visio-run-function(4)) - [Word.Application](/javascript/api/word/word.application): [newObject](/javascript/api/word/word.application#word-word-application-newobject-member(1)) - [Word.SearchOptions](/javascript/api/word/word.searchoptions): [newObject](/javascript/api/word/word.searchoptions#word-word-searchoptions-newobject-member(1)) + - [Word.SensitivityLabelsCatalog](/javascript/api/word/word.sensitivitylabelscatalog): [newObject](/javascript/api/word/word.sensitivitylabelscatalog#word-word-sensitivitylabelscatalog-newobject-member(1)) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/office/office/officeextension.clientresult.yml b/docs/docs-ref-autogen/office/office/officeextension.clientresult.yml index 26f343d0f8..03f3513448 100644 --- a/docs/docs-ref-autogen/office/office/officeextension.clientresult.yml +++ b/docs/docs-ref-autogen/office/office/officeextension.clientresult.yml @@ -54,6 +54,8 @@ remarks: |- - [Excel.RangeCollection](/javascript/api/excel/excel.rangecollection): [getCount](/javascript/api/excel/excel.rangecollection#excel-excel-rangecollection-getcount-member(1)) - [Excel.RangeViewCollection](/javascript/api/excel/excel.rangeviewcollection): [getCount](/javascript/api/excel/excel.rangeviewcollection#excel-excel-rangeviewcollection-getcount-member(1)) - [Excel.RowColumnPivotHierarchyCollection](/javascript/api/excel/excel.rowcolumnpivothierarchycollection): [getCount](/javascript/api/excel/excel.rowcolumnpivothierarchycollection#excel-excel-rowcolumnpivothierarchycollection-getcount-member(1)) + - [Excel.SensitivityLabel](/javascript/api/excel/excel.sensitivitylabel): [tryToUpdate](/javascript/api/excel/excel.sensitivitylabel#excel-excel-sensitivitylabel-trytoupdate-member(1)) + - [Excel.SensitivityLabelDetailsCollection](/javascript/api/excel/excel.sensitivitylabeldetailscollection): [getFirstOrNullObject](/javascript/api/excel/excel.sensitivitylabeldetailscollection#excel-excel-sensitivitylabeldetailscollection-getfirstornullobject-member(1)) - [Excel.SettingCollection](/javascript/api/excel/excel.settingcollection): [getCount](/javascript/api/excel/excel.settingcollection#excel-excel-settingcollection-getcount-member(1)) - [Excel.Shape](/javascript/api/excel/excel.shape): [getAsImage](/javascript/api/excel/excel.shape#excel-excel-shape-getasimage-member(1)) - [Excel.ShapeCollection](/javascript/api/excel/excel.shapecollection): [getCount](/javascript/api/excel/excel.shapecollection#excel-excel-shapecollection-getcount-member(1)) @@ -144,6 +146,7 @@ remarks: |- - [Word.Paragraph](/javascript/api/word/word.paragraph): [getHtml](/javascript/api/word/word.paragraph#word-word-paragraph-gethtml-member(1)), [getOoxml](/javascript/api/word/word.paragraph#word-word-paragraph-getooxml-member(1)), [getReviewedText](/javascript/api/word/word.paragraph#word-word-paragraph-getreviewedtext-member(1)), [getText](/javascript/api/word/word.paragraph#word-word-paragraph-gettext-member(1)), [insertAnnotations](/javascript/api/word/word.paragraph#word-word-paragraph-insertannotations-member(1)) - [Word.Range](/javascript/api/word/word.range): [compareLocationWith](/javascript/api/word/word.range#word-word-range-comparelocationwith-member(1)), [detectLanguage](/javascript/api/word/word.range#word-word-range-detectlanguage-member(1)), [getBookmarks](/javascript/api/word/word.range#word-word-range-getbookmarks-member(1)), [getHtml](/javascript/api/word/word.range#word-word-range-gethtml-member(1)), [getOoxml](/javascript/api/word/word.range#word-word-range-getooxml-member(1)), [getReviewedText](/javascript/api/word/word.range#word-word-range-getreviewedtext-member(1)) - [Word.Selection](/javascript/api/word/word.selection): [calculate](/javascript/api/word/word.selection#word-word-selection-calculate-member(1)), [delete](/javascript/api/word/word.selection#word-word-selection-delete-member(1)), [expand](/javascript/api/word/word.selection#word-word-selection-expand-member(1)), [isEqual](/javascript/api/word/word.selection#word-word-selection-isequal-member(1)), [isInRange](/javascript/api/word/word.selection#word-word-selection-isinrange-member(1)), [isInStory](/javascript/api/word/word.selection#word-word-selection-isinstory-member(1)), [move](/javascript/api/word/word.selection#word-word-selection-move-member(1)), [moveDown](/javascript/api/word/word.selection#word-word-selection-movedown-member(1)), [moveEnd](/javascript/api/word/word.selection#word-word-selection-moveend-member(1)), [moveEndUntil](/javascript/api/word/word.selection#word-word-selection-moveenduntil-member(1)), [moveEndWhile](/javascript/api/word/word.selection#word-word-selection-moveendwhile-member(1)), [moveLeft](/javascript/api/word/word.selection#word-word-selection-moveleft-member(1)), [moveRight](/javascript/api/word/word.selection#word-word-selection-moveright-member(1)), [moveStart](/javascript/api/word/word.selection#word-word-selection-movestart-member(1)), [moveStartUntil](/javascript/api/word/word.selection#word-word-selection-movestartuntil-member(1)), [moveStartWhile](/javascript/api/word/word.selection#word-word-selection-movestartwhile-member(1)), [moveUntil](/javascript/api/word/word.selection#word-word-selection-moveuntil-member(1)), [moveUp](/javascript/api/word/word.selection#word-word-selection-moveup-member(1)), [moveWhile](/javascript/api/word/word.selection#word-word-selection-movewhile-member(1)) + - [Word.SensitivityLabel](/javascript/api/word/word.sensitivitylabel): [tryToUpdate](/javascript/api/word/word.sensitivitylabel#word-word-sensitivitylabel-trytoupdate-member(1)) - [Word.SettingCollection](/javascript/api/word/word.settingcollection): [getCount](/javascript/api/word/word.settingcollection#word-word-settingcollection-getcount-member(1)) - [Word.Source](/javascript/api/word/word.source): [getFieldByName](/javascript/api/word/word.source#word-word-source-getfieldbyname-member(1)) - [Word.StyleCollection](/javascript/api/word/word.stylecollection): [getCount](/javascript/api/word/word.stylecollection#word-word-stylecollection-getcount-member(1)) diff --git a/docs/docs-ref-autogen/office/office/officeextension.eventhandlers.yml b/docs/docs-ref-autogen/office/office/officeextension.eventhandlers.yml index 415ba926a2..33f78b7696 100644 --- a/docs/docs-ref-autogen/office/office/officeextension.eventhandlers.yml +++ b/docs/docs-ref-autogen/office/office/officeextension.eventhandlers.yml @@ -11,7 +11,7 @@ remarks: |- - [Excel.Chart](/javascript/api/excel/excel.chart): [onActivated](/javascript/api/excel/excel.chart#excel-excel-chart-onactivated-member), [onDeactivated](/javascript/api/excel/excel.chart#excel-excel-chart-ondeactivated-member) - [Excel.ChartCollection](/javascript/api/excel/excel.chartcollection): [onActivated](/javascript/api/excel/excel.chartcollection#excel-excel-chartcollection-onactivated-member), [onAdded](/javascript/api/excel/excel.chartcollection#excel-excel-chartcollection-onadded-member), [onDeactivated](/javascript/api/excel/excel.chartcollection#excel-excel-chartcollection-ondeactivated-member), [onDeleted](/javascript/api/excel/excel.chartcollection#excel-excel-chartcollection-ondeleted-member) - [Excel.CommentCollection](/javascript/api/excel/excel.commentcollection): [onAdded](/javascript/api/excel/excel.commentcollection#excel-excel-commentcollection-onadded-member), [onChanged](/javascript/api/excel/excel.commentcollection#excel-excel-commentcollection-onchanged-member), [onDeleted](/javascript/api/excel/excel.commentcollection#excel-excel-commentcollection-ondeleted-member) - - [Excel.LinkedEntityDataDomainCollection](/javascript/api/excel/excel.linkedentitydatadomaincollection): [onLinkedEntityDataDomainAdded](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-onlinkedentitydatadomainadded-member), [onRefreshCompleted](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-onrefreshcompleted-member), [onRefreshModeChanged](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-onrefreshmodechanged-member) + - [Excel.LinkedEntityDataDomainCollection](/javascript/api/excel/excel.linkedentitydatadomaincollection): [onLinkedEntityCellValueLoaded](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-onlinkedentitycellvalueloaded-member), [onLinkedEntityDataDomainAdded](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-onlinkedentitydatadomainadded-member), [onRefreshCompleted](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-onrefreshcompleted-member), [onRefreshModeChanged](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-onrefreshmodechanged-member) - [Excel.SettingCollection](/javascript/api/excel/excel.settingcollection): [onSettingsChanged](/javascript/api/excel/excel.settingcollection#excel-excel-settingcollection-onsettingschanged-member) - [Excel.Shape](/javascript/api/excel/excel.shape): [onActivated](/javascript/api/excel/excel.shape#excel-excel-shape-onactivated-member), [onDeactivated](/javascript/api/excel/excel.shape#excel-excel-shape-ondeactivated-member) - [Excel.Table](/javascript/api/excel/excel.table): [onChanged](/javascript/api/excel/excel.table#excel-excel-table-onchanged-member), [onFiltered](/javascript/api/excel/excel.table#excel-excel-table-onfiltered-member), [onSelectionChanged](/javascript/api/excel/excel.table#excel-excel-table-onselectionchanged-member) diff --git a/docs/docs-ref-autogen/office/office/officeextension.loadoption.yml b/docs/docs-ref-autogen/office/office/officeextension.loadoption.yml index 3c392bee70..c2eede5341 100644 --- a/docs/docs-ref-autogen/office/office/officeextension.loadoption.yml +++ b/docs/docs-ref-autogen/office/office/officeextension.loadoption.yml @@ -59,6 +59,7 @@ remarks: |- - [Excel.RangeCollection](/javascript/api/excel/excel.rangecollection): [load](/javascript/api/excel/excel.rangecollection#excel-excel-rangecollection-load-member(3)) - [Excel.RangeViewCollection](/javascript/api/excel/excel.rangeviewcollection): [load](/javascript/api/excel/excel.rangeviewcollection#excel-excel-rangeviewcollection-load-member(3)) - [Excel.RowColumnPivotHierarchyCollection](/javascript/api/excel/excel.rowcolumnpivothierarchycollection): [load](/javascript/api/excel/excel.rowcolumnpivothierarchycollection#excel-excel-rowcolumnpivothierarchycollection-load-member(3)) + - [Excel.SensitivityLabelDetailsCollection](/javascript/api/excel/excel.sensitivitylabeldetailscollection): [load](/javascript/api/excel/excel.sensitivitylabeldetailscollection#excel-excel-sensitivitylabeldetailscollection-load-member(3)) - [Excel.SettingCollection](/javascript/api/excel/excel.settingcollection): [load](/javascript/api/excel/excel.settingcollection#excel-excel-settingcollection-load-member(3)) - [Excel.ShapeCollection](/javascript/api/excel/excel.shapecollection): [load](/javascript/api/excel/excel.shapecollection#excel-excel-shapecollection-load-member(3)) - [Excel.SlicerCollection](/javascript/api/excel/excel.slicercollection): [load](/javascript/api/excel/excel.slicercollection#excel-excel-slicercollection-load-member(3)) @@ -153,6 +154,7 @@ remarks: |- - [Word.ReviewerCollection](/javascript/api/word/word.reviewercollection): [load](/javascript/api/word/word.reviewercollection#word-word-reviewercollection-load-member(3)) - [Word.RevisionCollection](/javascript/api/word/word.revisioncollection): [load](/javascript/api/word/word.revisioncollection#word-word-revisioncollection-load-member(3)) - [Word.SectionCollection](/javascript/api/word/word.sectioncollection): [load](/javascript/api/word/word.sectioncollection#word-word-sectioncollection-load-member(3)) + - [Word.SensitivityLabelDetailsCollection](/javascript/api/word/word.sensitivitylabeldetailscollection): [load](/javascript/api/word/word.sensitivitylabeldetailscollection#word-word-sensitivitylabeldetailscollection-load-member(3)) - [Word.SettingCollection](/javascript/api/word/word.settingcollection): [load](/javascript/api/word/word.settingcollection#word-word-settingcollection-load-member(3)) - [Word.ShapeCollection](/javascript/api/word/word.shapecollection): [load](/javascript/api/word/word.shapecollection#word-word-shapecollection-load-member(3)) - [Word.SourceCollection](/javascript/api/word/word.sourcecollection): [load](/javascript/api/word/word.sourcecollection#word-word-sourcecollection-load-member(3)) diff --git a/docs/docs-ref-autogen/office_release/office/officeextension.clientrequestcontext.yml b/docs/docs-ref-autogen/office_release/office/officeextension.clientrequestcontext.yml index 5cda884291..bba9867366 100644 --- a/docs/docs-ref-autogen/office_release/office/officeextension.clientrequestcontext.yml +++ b/docs/docs-ref-autogen/office_release/office/officeextension.clientrequestcontext.yml @@ -18,6 +18,7 @@ remarks: |- - [Visio](/javascript/api/visio): [run](/javascript/api/visio#visio-visio-run-function(4)) - [Word.Application](/javascript/api/word/word.application): [newObject](/javascript/api/word/word.application#word-word-application-newobject-member(1)) - [Word.SearchOptions](/javascript/api/word/word.searchoptions): [newObject](/javascript/api/word/word.searchoptions#word-word-searchoptions-newobject-member(1)) + - [Word.SensitivityLabelsCatalog](/javascript/api/word/word.sensitivitylabelscatalog): [newObject](/javascript/api/word/word.sensitivitylabelscatalog#word-word-sensitivitylabelscatalog-newobject-member(1)) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/office_release/office/officeextension.clientresult.yml b/docs/docs-ref-autogen/office_release/office/officeextension.clientresult.yml index 26f343d0f8..03f3513448 100644 --- a/docs/docs-ref-autogen/office_release/office/officeextension.clientresult.yml +++ b/docs/docs-ref-autogen/office_release/office/officeextension.clientresult.yml @@ -54,6 +54,8 @@ remarks: |- - [Excel.RangeCollection](/javascript/api/excel/excel.rangecollection): [getCount](/javascript/api/excel/excel.rangecollection#excel-excel-rangecollection-getcount-member(1)) - [Excel.RangeViewCollection](/javascript/api/excel/excel.rangeviewcollection): [getCount](/javascript/api/excel/excel.rangeviewcollection#excel-excel-rangeviewcollection-getcount-member(1)) - [Excel.RowColumnPivotHierarchyCollection](/javascript/api/excel/excel.rowcolumnpivothierarchycollection): [getCount](/javascript/api/excel/excel.rowcolumnpivothierarchycollection#excel-excel-rowcolumnpivothierarchycollection-getcount-member(1)) + - [Excel.SensitivityLabel](/javascript/api/excel/excel.sensitivitylabel): [tryToUpdate](/javascript/api/excel/excel.sensitivitylabel#excel-excel-sensitivitylabel-trytoupdate-member(1)) + - [Excel.SensitivityLabelDetailsCollection](/javascript/api/excel/excel.sensitivitylabeldetailscollection): [getFirstOrNullObject](/javascript/api/excel/excel.sensitivitylabeldetailscollection#excel-excel-sensitivitylabeldetailscollection-getfirstornullobject-member(1)) - [Excel.SettingCollection](/javascript/api/excel/excel.settingcollection): [getCount](/javascript/api/excel/excel.settingcollection#excel-excel-settingcollection-getcount-member(1)) - [Excel.Shape](/javascript/api/excel/excel.shape): [getAsImage](/javascript/api/excel/excel.shape#excel-excel-shape-getasimage-member(1)) - [Excel.ShapeCollection](/javascript/api/excel/excel.shapecollection): [getCount](/javascript/api/excel/excel.shapecollection#excel-excel-shapecollection-getcount-member(1)) @@ -144,6 +146,7 @@ remarks: |- - [Word.Paragraph](/javascript/api/word/word.paragraph): [getHtml](/javascript/api/word/word.paragraph#word-word-paragraph-gethtml-member(1)), [getOoxml](/javascript/api/word/word.paragraph#word-word-paragraph-getooxml-member(1)), [getReviewedText](/javascript/api/word/word.paragraph#word-word-paragraph-getreviewedtext-member(1)), [getText](/javascript/api/word/word.paragraph#word-word-paragraph-gettext-member(1)), [insertAnnotations](/javascript/api/word/word.paragraph#word-word-paragraph-insertannotations-member(1)) - [Word.Range](/javascript/api/word/word.range): [compareLocationWith](/javascript/api/word/word.range#word-word-range-comparelocationwith-member(1)), [detectLanguage](/javascript/api/word/word.range#word-word-range-detectlanguage-member(1)), [getBookmarks](/javascript/api/word/word.range#word-word-range-getbookmarks-member(1)), [getHtml](/javascript/api/word/word.range#word-word-range-gethtml-member(1)), [getOoxml](/javascript/api/word/word.range#word-word-range-getooxml-member(1)), [getReviewedText](/javascript/api/word/word.range#word-word-range-getreviewedtext-member(1)) - [Word.Selection](/javascript/api/word/word.selection): [calculate](/javascript/api/word/word.selection#word-word-selection-calculate-member(1)), [delete](/javascript/api/word/word.selection#word-word-selection-delete-member(1)), [expand](/javascript/api/word/word.selection#word-word-selection-expand-member(1)), [isEqual](/javascript/api/word/word.selection#word-word-selection-isequal-member(1)), [isInRange](/javascript/api/word/word.selection#word-word-selection-isinrange-member(1)), [isInStory](/javascript/api/word/word.selection#word-word-selection-isinstory-member(1)), [move](/javascript/api/word/word.selection#word-word-selection-move-member(1)), [moveDown](/javascript/api/word/word.selection#word-word-selection-movedown-member(1)), [moveEnd](/javascript/api/word/word.selection#word-word-selection-moveend-member(1)), [moveEndUntil](/javascript/api/word/word.selection#word-word-selection-moveenduntil-member(1)), [moveEndWhile](/javascript/api/word/word.selection#word-word-selection-moveendwhile-member(1)), [moveLeft](/javascript/api/word/word.selection#word-word-selection-moveleft-member(1)), [moveRight](/javascript/api/word/word.selection#word-word-selection-moveright-member(1)), [moveStart](/javascript/api/word/word.selection#word-word-selection-movestart-member(1)), [moveStartUntil](/javascript/api/word/word.selection#word-word-selection-movestartuntil-member(1)), [moveStartWhile](/javascript/api/word/word.selection#word-word-selection-movestartwhile-member(1)), [moveUntil](/javascript/api/word/word.selection#word-word-selection-moveuntil-member(1)), [moveUp](/javascript/api/word/word.selection#word-word-selection-moveup-member(1)), [moveWhile](/javascript/api/word/word.selection#word-word-selection-movewhile-member(1)) + - [Word.SensitivityLabel](/javascript/api/word/word.sensitivitylabel): [tryToUpdate](/javascript/api/word/word.sensitivitylabel#word-word-sensitivitylabel-trytoupdate-member(1)) - [Word.SettingCollection](/javascript/api/word/word.settingcollection): [getCount](/javascript/api/word/word.settingcollection#word-word-settingcollection-getcount-member(1)) - [Word.Source](/javascript/api/word/word.source): [getFieldByName](/javascript/api/word/word.source#word-word-source-getfieldbyname-member(1)) - [Word.StyleCollection](/javascript/api/word/word.stylecollection): [getCount](/javascript/api/word/word.stylecollection#word-word-stylecollection-getcount-member(1)) diff --git a/docs/docs-ref-autogen/office_release/office/officeextension.eventhandlers.yml b/docs/docs-ref-autogen/office_release/office/officeextension.eventhandlers.yml index 415ba926a2..33f78b7696 100644 --- a/docs/docs-ref-autogen/office_release/office/officeextension.eventhandlers.yml +++ b/docs/docs-ref-autogen/office_release/office/officeextension.eventhandlers.yml @@ -11,7 +11,7 @@ remarks: |- - [Excel.Chart](/javascript/api/excel/excel.chart): [onActivated](/javascript/api/excel/excel.chart#excel-excel-chart-onactivated-member), [onDeactivated](/javascript/api/excel/excel.chart#excel-excel-chart-ondeactivated-member) - [Excel.ChartCollection](/javascript/api/excel/excel.chartcollection): [onActivated](/javascript/api/excel/excel.chartcollection#excel-excel-chartcollection-onactivated-member), [onAdded](/javascript/api/excel/excel.chartcollection#excel-excel-chartcollection-onadded-member), [onDeactivated](/javascript/api/excel/excel.chartcollection#excel-excel-chartcollection-ondeactivated-member), [onDeleted](/javascript/api/excel/excel.chartcollection#excel-excel-chartcollection-ondeleted-member) - [Excel.CommentCollection](/javascript/api/excel/excel.commentcollection): [onAdded](/javascript/api/excel/excel.commentcollection#excel-excel-commentcollection-onadded-member), [onChanged](/javascript/api/excel/excel.commentcollection#excel-excel-commentcollection-onchanged-member), [onDeleted](/javascript/api/excel/excel.commentcollection#excel-excel-commentcollection-ondeleted-member) - - [Excel.LinkedEntityDataDomainCollection](/javascript/api/excel/excel.linkedentitydatadomaincollection): [onLinkedEntityDataDomainAdded](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-onlinkedentitydatadomainadded-member), [onRefreshCompleted](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-onrefreshcompleted-member), [onRefreshModeChanged](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-onrefreshmodechanged-member) + - [Excel.LinkedEntityDataDomainCollection](/javascript/api/excel/excel.linkedentitydatadomaincollection): [onLinkedEntityCellValueLoaded](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-onlinkedentitycellvalueloaded-member), [onLinkedEntityDataDomainAdded](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-onlinkedentitydatadomainadded-member), [onRefreshCompleted](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-onrefreshcompleted-member), [onRefreshModeChanged](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-onrefreshmodechanged-member) - [Excel.SettingCollection](/javascript/api/excel/excel.settingcollection): [onSettingsChanged](/javascript/api/excel/excel.settingcollection#excel-excel-settingcollection-onsettingschanged-member) - [Excel.Shape](/javascript/api/excel/excel.shape): [onActivated](/javascript/api/excel/excel.shape#excel-excel-shape-onactivated-member), [onDeactivated](/javascript/api/excel/excel.shape#excel-excel-shape-ondeactivated-member) - [Excel.Table](/javascript/api/excel/excel.table): [onChanged](/javascript/api/excel/excel.table#excel-excel-table-onchanged-member), [onFiltered](/javascript/api/excel/excel.table#excel-excel-table-onfiltered-member), [onSelectionChanged](/javascript/api/excel/excel.table#excel-excel-table-onselectionchanged-member) diff --git a/docs/docs-ref-autogen/office_release/office/officeextension.loadoption.yml b/docs/docs-ref-autogen/office_release/office/officeextension.loadoption.yml index 3c392bee70..c2eede5341 100644 --- a/docs/docs-ref-autogen/office_release/office/officeextension.loadoption.yml +++ b/docs/docs-ref-autogen/office_release/office/officeextension.loadoption.yml @@ -59,6 +59,7 @@ remarks: |- - [Excel.RangeCollection](/javascript/api/excel/excel.rangecollection): [load](/javascript/api/excel/excel.rangecollection#excel-excel-rangecollection-load-member(3)) - [Excel.RangeViewCollection](/javascript/api/excel/excel.rangeviewcollection): [load](/javascript/api/excel/excel.rangeviewcollection#excel-excel-rangeviewcollection-load-member(3)) - [Excel.RowColumnPivotHierarchyCollection](/javascript/api/excel/excel.rowcolumnpivothierarchycollection): [load](/javascript/api/excel/excel.rowcolumnpivothierarchycollection#excel-excel-rowcolumnpivothierarchycollection-load-member(3)) + - [Excel.SensitivityLabelDetailsCollection](/javascript/api/excel/excel.sensitivitylabeldetailscollection): [load](/javascript/api/excel/excel.sensitivitylabeldetailscollection#excel-excel-sensitivitylabeldetailscollection-load-member(3)) - [Excel.SettingCollection](/javascript/api/excel/excel.settingcollection): [load](/javascript/api/excel/excel.settingcollection#excel-excel-settingcollection-load-member(3)) - [Excel.ShapeCollection](/javascript/api/excel/excel.shapecollection): [load](/javascript/api/excel/excel.shapecollection#excel-excel-shapecollection-load-member(3)) - [Excel.SlicerCollection](/javascript/api/excel/excel.slicercollection): [load](/javascript/api/excel/excel.slicercollection#excel-excel-slicercollection-load-member(3)) @@ -153,6 +154,7 @@ remarks: |- - [Word.ReviewerCollection](/javascript/api/word/word.reviewercollection): [load](/javascript/api/word/word.reviewercollection#word-word-reviewercollection-load-member(3)) - [Word.RevisionCollection](/javascript/api/word/word.revisioncollection): [load](/javascript/api/word/word.revisioncollection#word-word-revisioncollection-load-member(3)) - [Word.SectionCollection](/javascript/api/word/word.sectioncollection): [load](/javascript/api/word/word.sectioncollection#word-word-sectioncollection-load-member(3)) + - [Word.SensitivityLabelDetailsCollection](/javascript/api/word/word.sensitivitylabeldetailscollection): [load](/javascript/api/word/word.sensitivitylabeldetailscollection#word-word-sensitivitylabeldetailscollection-load-member(3)) - [Word.SettingCollection](/javascript/api/word/word.settingcollection): [load](/javascript/api/word/word.settingcollection#word-word-settingcollection-load-member(3)) - [Word.ShapeCollection](/javascript/api/word/word.shapecollection): [load](/javascript/api/word/word.shapecollection#word-word-shapecollection-load-member(3)) - [Word.SourceCollection](/javascript/api/word/word.sourcecollection): [load](/javascript/api/word/word.sourcecollection#word-word-sourcecollection-load-member(3)) diff --git a/docs/docs-ref-autogen/word/toc.yml b/docs/docs-ref-autogen/word/toc.yml index e1d9f1efa0..53fa157d23 100644 --- a/docs/docs-ref-autogen/word/toc.yml +++ b/docs/docs-ref-autogen/word/toc.yml @@ -215,6 +215,8 @@ items: uid: word!Word.JustificationMode:enum - name: Kana uid: word!Word.Kana:enum + - name: LabelingCapability + uid: word!Word.LabelingCapability:enum - name: LanguageId uid: word!Word.LanguageId:enum - name: LayoutMode @@ -359,6 +361,10 @@ items: uid: word!Word.SelectionMode:enum - name: SelectionType uid: word!Word.SelectionType:enum + - name: SensitivityLabelProtectionType + uid: word!Word.SensitivityLabelProtectionType:enum + - name: SensitivityLabelUpdateResult + uid: word!Word.SensitivityLabelUpdateResult:enum - name: ShadingTextureType uid: word!Word.ShadingTextureType:enum - name: ShadowStyle @@ -847,6 +853,14 @@ items: uid: word!Word.SelectNodesOptions:interface - name: SelectSingleNodeOptions uid: word!Word.SelectSingleNodeOptions:interface + - name: SensitivityLabel + uid: word!Word.SensitivityLabel:class + - name: SensitivityLabelDetails + uid: word!Word.SensitivityLabelDetails:class + - name: SensitivityLabelDetailsCollection + uid: word!Word.SensitivityLabelDetailsCollection:class + - name: SensitivityLabelsCatalog + uid: word!Word.SensitivityLabelsCatalog:class - name: Setting uid: word!Word.Setting:class - name: SettingCollection diff --git a/docs/docs-ref-autogen/word/word.yml b/docs/docs-ref-autogen/word/word.yml index b0ad3e054b..41a8c09b23 100644 --- a/docs/docs-ref-autogen/word/word.yml +++ b/docs/docs-ref-autogen/word/word.yml @@ -102,6 +102,7 @@ enums: - word!Word.InsertLocation:enum - word!Word.JustificationMode:enum - word!Word.Kana:enum + - word!Word.LabelingCapability:enum - word!Word.LanguageId:enum - word!Word.LayoutMode:enum - word!Word.Ligature:enum @@ -174,6 +175,8 @@ enums: - word!Word.SeekView:enum - word!Word.SelectionMode:enum - word!Word.SelectionType:enum + - word!Word.SensitivityLabelProtectionType:enum + - word!Word.SensitivityLabelUpdateResult:enum - word!Word.ShadingTextureType:enum - word!Word.ShadowStyle:enum - word!Word.ShadowType:enum @@ -350,6 +353,10 @@ classes: - word!Word.Section:class - word!Word.SectionCollection:class - word!Word.Selection:class + - word!Word.SensitivityLabel:class + - word!Word.SensitivityLabelDetails:class + - word!Word.SensitivityLabelDetailsCollection:class + - word!Word.SensitivityLabelsCatalog:class - word!Word.Setting:class - word!Word.SettingCollection:class - word!Word.Shading:class @@ -799,6 +806,13 @@ interfaces: - word!Word.Interfaces.SelectionData:interface - word!Word.Interfaces.SelectionLoadOptions:interface - word!Word.Interfaces.SelectionUpdateData:interface + - word!Word.Interfaces.SensitivityLabelDetailsCollectionData:interface + - word!Word.Interfaces.SensitivityLabelDetailsCollectionLoadOptions:interface + - word!Word.Interfaces.SensitivityLabelDetailsCollectionUpdateData:interface + - word!Word.Interfaces.SensitivityLabelDetailsData:interface + - word!Word.Interfaces.SensitivityLabelDetailsLoadOptions:interface + - word!Word.Interfaces.SensitivityLabelsCatalogData:interface + - word!Word.Interfaces.SensitivityLabelsCatalogLoadOptions:interface - word!Word.Interfaces.SettingCollectionData:interface - word!Word.Interfaces.SettingCollectionLoadOptions:interface - word!Word.Interfaces.SettingCollectionUpdateData:interface diff --git a/docs/docs-ref-autogen/word/word/word.document.yml b/docs/docs-ref-autogen/word/word/word.document.yml index eecec6735f..1dfc33ec27 100644 --- a/docs/docs-ref-autogen/word/word/word.document.yml +++ b/docs/docs-ref-autogen/word/word/word.document.yml @@ -1674,6 +1674,19 @@ properties: content: 'readonly selection: Word.Selection;' return: type: + - name: sensitivityLabel + uid: word!Word.Document#sensitivityLabel:member + package: word! + fullName: sensitivityLabel + summary: Returns the sensitivity label of the document. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly sensitivityLabel: Word.SensitivityLabel;' + return: + type: - name: sentences uid: word!Word.Document#sentences:member package: word! diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.collectionloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.collectionloadoptions.yml index c3f1b6bf17..b31f9b7970 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.collectionloadoptions.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.collectionloadoptions.yml @@ -48,6 +48,7 @@ remarks: |- - [Word.ReviewerCollection](/javascript/api/word/word.reviewercollection): [load](/javascript/api/word/word.reviewercollection#word-word-reviewercollection-load-member(1)) - [Word.RevisionCollection](/javascript/api/word/word.revisioncollection): [load](/javascript/api/word/word.revisioncollection#word-word-revisioncollection-load-member(1)) - [Word.SectionCollection](/javascript/api/word/word.sectioncollection): [load](/javascript/api/word/word.sectioncollection#word-word-sectioncollection-load-member(1)) + - [Word.SensitivityLabelDetailsCollection](/javascript/api/word/word.sensitivitylabeldetailscollection): [load](/javascript/api/word/word.sensitivitylabeldetailscollection#word-word-sensitivitylabeldetailscollection-load-member(1)) - [Word.SettingCollection](/javascript/api/word/word.settingcollection): [load](/javascript/api/word/word.settingcollection#word-word-settingcollection-load-member(1)) - [Word.ShapeCollection](/javascript/api/word/word.shapecollection): [load](/javascript/api/word/word.shapecollection#word-word-shapecollection-load-member(1)) - [Word.SourceCollection](/javascript/api/word/word.sourcecollection): [load](/javascript/api/word/word.sourcecollection#word-word-sourcecollection-load-member(1)) diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.sensitivitylabeldetailscollectiondata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.sensitivitylabeldetailscollectiondata.yml new file mode 100644 index 0000000000..eba0d994e1 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.sensitivitylabeldetailscollectiondata.yml @@ -0,0 +1,28 @@ +### YamlMime:TSType +name: Word.Interfaces.SensitivityLabelDetailsCollectionData +uid: word!Word.Interfaces.SensitivityLabelDetailsCollectionData:interface +package: word! +fullName: Word.Interfaces.SensitivityLabelDetailsCollectionData +summary: An interface describing the data returned by calling `sensitivityLabelDetailsCollection.toJSON()`. +remarks: |- + #### Used by + + - [Word.SensitivityLabelDetailsCollection](/javascript/api/word/word.sensitivitylabeldetailscollection): [toJSON](/javascript/api/word/word.sensitivitylabeldetailscollection#word-word-sensitivitylabeldetailscollection-tojson-member(1)) + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.SensitivityLabelDetailsCollectionData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.SensitivityLabelDetailsData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.sensitivitylabeldetailscollectionloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.sensitivitylabeldetailscollectionloadoptions.yml new file mode 100644 index 0000000000..26b4a8647f --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.sensitivitylabeldetailscollectionloadoptions.yml @@ -0,0 +1,134 @@ +### YamlMime:TSType +name: Word.Interfaces.SensitivityLabelDetailsCollectionLoadOptions +uid: word!Word.Interfaces.SensitivityLabelDetailsCollectionLoadOptions:interface +package: word! +fullName: Word.Interfaces.SensitivityLabelDetailsCollectionLoadOptions +summary: Represents the collection of [Word.SensitivityLabelDetails](xref:word!Word.SensitivityLabelDetails:class) objects. +remarks: |- + [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) + + #### Used by + + - [Word.SensitivityLabelDetailsCollection](/javascript/api/word/word.sensitivitylabeldetailscollection): [load](/javascript/api/word/word.sensitivitylabeldetailscollection#word-word-sensitivitylabeldetailscollection-load-member(1)) + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.SensitivityLabelDetailsCollectionLoadOptions#$all:member + package: word! + fullName: $all + summary: 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`). + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: color + uid: word!Word.Interfaces.SensitivityLabelDetailsCollectionLoadOptions#color:member + package: word! + fullName: color + summary: 'For EACH ITEM in the collection: The color of the sensitivity label.' + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'color?: boolean;' + return: + type: boolean + - name: id + uid: word!Word.Interfaces.SensitivityLabelDetailsCollectionLoadOptions#id:member + package: word! + fullName: id + summary: 'For EACH ITEM in the collection: The unique identifier (GUID) of the sensitivity label.' + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: isEnabled + uid: word!Word.Interfaces.SensitivityLabelDetailsCollectionLoadOptions#isEnabled:member + package: word! + fullName: isEnabled + summary: 'For EACH ITEM in the collection: Gets a value indicating whether the label is enabled.' + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'isEnabled?: boolean;' + return: + type: boolean + - name: name + uid: word!Word.Interfaces.SensitivityLabelDetailsCollectionLoadOptions#name:member + package: word! + fullName: name + summary: 'For EACH ITEM in the collection: The name of the sensitivity label.' + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: order + uid: word!Word.Interfaces.SensitivityLabelDetailsCollectionLoadOptions#order:member + package: word! + fullName: order + summary: 'For EACH ITEM in the collection: The order of the sensitivity label.' + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'order?: boolean;' + return: + type: boolean + - name: protectionType + uid: word!Word.Interfaces.SensitivityLabelDetailsCollectionLoadOptions#protectionType:member + package: word! + fullName: protectionType + summary: 'For EACH ITEM in the collection: Gets a value indicating the protection type provided by this label.' + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'protectionType?: boolean;' + return: + type: boolean + - name: siteId + uid: word!Word.Interfaces.SensitivityLabelDetailsCollectionLoadOptions#siteId:member + package: word! + fullName: siteId + summary: 'For EACH ITEM in the collection: The unique identifier (GUID) of the tenant which the sensitivity label is belonged.' + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'siteId?: boolean;' + return: + type: boolean + - name: tooltip + uid: word!Word.Interfaces.SensitivityLabelDetailsCollectionLoadOptions#tooltip:member + package: word! + fullName: tooltip + summary: 'For EACH ITEM in the collection: The description of the sensitivity label.' + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'tooltip?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.sensitivitylabeldetailscollectionupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.sensitivitylabeldetailscollectionupdatedata.yml new file mode 100644 index 0000000000..9c15c08e16 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.sensitivitylabeldetailscollectionupdatedata.yml @@ -0,0 +1,25 @@ +### YamlMime:TSType +name: Word.Interfaces.SensitivityLabelDetailsCollectionUpdateData +uid: word!Word.Interfaces.SensitivityLabelDetailsCollectionUpdateData:interface +package: word! +fullName: Word.Interfaces.SensitivityLabelDetailsCollectionUpdateData +summary: An interface for updating data on the `SensitivityLabelDetailsCollection` object, for use in `sensitivityLabelDetailsCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.SensitivityLabelDetailsCollectionUpdateData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.SensitivityLabelDetailsData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.sensitivitylabeldetailsdata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.sensitivitylabeldetailsdata.yml new file mode 100644 index 0000000000..73646e4467 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.sensitivitylabeldetailsdata.yml @@ -0,0 +1,132 @@ +### YamlMime:TSType +name: Word.Interfaces.SensitivityLabelDetailsData +uid: word!Word.Interfaces.SensitivityLabelDetailsData:interface +package: word! +fullName: Word.Interfaces.SensitivityLabelDetailsData +summary: An interface describing the data returned by calling `sensitivityLabelDetails.toJSON()`. +remarks: |- + #### Used by + + - [Word.SensitivityLabelDetails](/javascript/api/word/word.sensitivitylabeldetails): [toJSON](/javascript/api/word/word.sensitivitylabeldetails#word-word-sensitivitylabeldetails-tojson-member(1)) + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: children + uid: word!Word.Interfaces.SensitivityLabelDetailsData#children:member + package: word! + fullName: children + summary: The sublabels of the sensitivity label. Returns null if a label doesn't have any sublabels. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'children?: Word.Interfaces.SensitivityLabelDetailsData[];' + return: + type: [] + - name: color + uid: word!Word.Interfaces.SensitivityLabelDetailsData#color:member + package: word! + fullName: color + summary: The color of the sensitivity label. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'color?: string;' + return: + type: string + - name: id + uid: word!Word.Interfaces.SensitivityLabelDetailsData#id:member + package: word! + fullName: id + summary: The unique identifier (GUID) of the sensitivity label. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: isEnabled + uid: word!Word.Interfaces.SensitivityLabelDetailsData#isEnabled:member + package: word! + fullName: isEnabled + summary: Gets a value indicating whether the label is enabled. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'isEnabled?: boolean;' + return: + type: boolean + - name: name + uid: word!Word.Interfaces.SensitivityLabelDetailsData#name:member + package: word! + fullName: name + summary: The name of the sensitivity label. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: order + uid: word!Word.Interfaces.SensitivityLabelDetailsData#order:member + package: word! + fullName: order + summary: The order of the sensitivity label. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'order?: number;' + return: + type: number + - name: protectionType + uid: word!Word.Interfaces.SensitivityLabelDetailsData#protectionType:member + package: word! + fullName: protectionType + summary: Gets a value indicating the protection type provided by this label. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'protectionType?: Word.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined";' + return: + type: | "NoProtection" | "AdminDefined" | "UserDefined" + - name: siteId + uid: word!Word.Interfaces.SensitivityLabelDetailsData#siteId:member + package: word! + fullName: siteId + summary: The unique identifier (GUID) of the tenant which the sensitivity label is belonged. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'siteId?: string;' + return: + type: string + - name: tooltip + uid: word!Word.Interfaces.SensitivityLabelDetailsData#tooltip:member + package: word! + fullName: tooltip + summary: The description of the sensitivity label. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'tooltip?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.sensitivitylabeldetailsloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.sensitivitylabeldetailsloadoptions.yml new file mode 100644 index 0000000000..54289e1327 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.sensitivitylabeldetailsloadoptions.yml @@ -0,0 +1,134 @@ +### YamlMime:TSType +name: Word.Interfaces.SensitivityLabelDetailsLoadOptions +uid: word!Word.Interfaces.SensitivityLabelDetailsLoadOptions:interface +package: word! +fullName: Word.Interfaces.SensitivityLabelDetailsLoadOptions +summary: Represents the properties of available sensitivity labels in Word. +remarks: |- + [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) + + #### Used by + + - [Word.SensitivityLabelDetails](/javascript/api/word/word.sensitivitylabeldetails): [load](/javascript/api/word/word.sensitivitylabeldetails#word-word-sensitivitylabeldetails-load-member(1)) + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.SensitivityLabelDetailsLoadOptions#$all:member + package: word! + fullName: $all + summary: 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`). + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: color + uid: word!Word.Interfaces.SensitivityLabelDetailsLoadOptions#color:member + package: word! + fullName: color + summary: The color of the sensitivity label. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'color?: boolean;' + return: + type: boolean + - name: id + uid: word!Word.Interfaces.SensitivityLabelDetailsLoadOptions#id:member + package: word! + fullName: id + summary: The unique identifier (GUID) of the sensitivity label. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: isEnabled + uid: word!Word.Interfaces.SensitivityLabelDetailsLoadOptions#isEnabled:member + package: word! + fullName: isEnabled + summary: Gets a value indicating whether the label is enabled. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'isEnabled?: boolean;' + return: + type: boolean + - name: name + uid: word!Word.Interfaces.SensitivityLabelDetailsLoadOptions#name:member + package: word! + fullName: name + summary: The name of the sensitivity label. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: order + uid: word!Word.Interfaces.SensitivityLabelDetailsLoadOptions#order:member + package: word! + fullName: order + summary: The order of the sensitivity label. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'order?: boolean;' + return: + type: boolean + - name: protectionType + uid: word!Word.Interfaces.SensitivityLabelDetailsLoadOptions#protectionType:member + package: word! + fullName: protectionType + summary: Gets a value indicating the protection type provided by this label. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'protectionType?: boolean;' + return: + type: boolean + - name: siteId + uid: word!Word.Interfaces.SensitivityLabelDetailsLoadOptions#siteId:member + package: word! + fullName: siteId + summary: The unique identifier (GUID) of the tenant which the sensitivity label is belonged. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'siteId?: boolean;' + return: + type: boolean + - name: tooltip + uid: word!Word.Interfaces.SensitivityLabelDetailsLoadOptions#tooltip:member + package: word! + fullName: tooltip + summary: The description of the sensitivity label. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'tooltip?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.sensitivitylabelscatalogdata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.sensitivitylabelscatalogdata.yml new file mode 100644 index 0000000000..74dacbb01e --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.sensitivitylabelscatalogdata.yml @@ -0,0 +1,28 @@ +### YamlMime:TSType +name: Word.Interfaces.SensitivityLabelsCatalogData +uid: word!Word.Interfaces.SensitivityLabelsCatalogData:interface +package: word! +fullName: Word.Interfaces.SensitivityLabelsCatalogData +summary: An interface describing the data returned by calling `sensitivityLabelsCatalog.toJSON()`. +remarks: |- + #### Used by + + - [Word.SensitivityLabelsCatalog](/javascript/api/word/word.sensitivitylabelscatalog): [toJSON](/javascript/api/word/word.sensitivitylabelscatalog#word-word-sensitivitylabelscatalog-tojson-member(1)) + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: getLabelingCapability + uid: word!Word.Interfaces.SensitivityLabelsCatalogData#getLabelingCapability:member + package: word! + fullName: getLabelingCapability + summary: Gets the labeling capability status of the sensitivity label catalog in Word. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'getLabelingCapability?: Word.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled";' + return: + type: | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled" diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.sensitivitylabelscatalogloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.sensitivitylabelscatalogloadoptions.yml new file mode 100644 index 0000000000..de423d3bb2 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.sensitivitylabelscatalogloadoptions.yml @@ -0,0 +1,43 @@ +### YamlMime:TSType +name: Word.Interfaces.SensitivityLabelsCatalogLoadOptions +uid: word!Word.Interfaces.SensitivityLabelsCatalogLoadOptions:interface +package: word! +fullName: Word.Interfaces.SensitivityLabelsCatalogLoadOptions +summary: Provides methods to check the status of the catalog of sensitivity labels in Word and retrieve all available sensitivity labels if the catalog is enabled. +remarks: |- + [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) + + #### Used by + + - [Word.SensitivityLabelsCatalog](/javascript/api/word/word.sensitivitylabelscatalog): [load](/javascript/api/word/word.sensitivitylabelscatalog#word-word-sensitivitylabelscatalog-load-member(1)) + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.SensitivityLabelsCatalogLoadOptions#$all:member + package: word! + fullName: $all + summary: 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`). + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: getLabelingCapability + uid: word!Word.Interfaces.SensitivityLabelsCatalogLoadOptions#getLabelingCapability:member + package: word! + fullName: getLabelingCapability + summary: Gets the labeling capability status of the sensitivity label catalog in Word. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'getLabelingCapability?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.labelingcapability.yml b/docs/docs-ref-autogen/word/word/word.labelingcapability.yml new file mode 100644 index 0000000000..c67fb66b03 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.labelingcapability.yml @@ -0,0 +1,48 @@ +### YamlMime:TSEnum +name: Word.LabelingCapability +uid: word!Word.LabelingCapability:enum +package: word! +fullName: Word.LabelingCapability +summary: Represents the labeling capability status of the sensitivity label catalog. +remarks: |- + [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) + + #### Used by + + - [Word.SensitivityLabelsCatalog](/javascript/api/word/word.sensitivitylabelscatalog): [getLabelingCapability](/javascript/api/word/word.sensitivitylabelscatalog#word-word-sensitivitylabelscatalog-getlabelingcapability-member) + +isPreview: true +isDeprecated: false +fields: + - name: labelingDisabled + uid: word!Word.LabelingCapability.labelingDisabled:member + package: word! + summary: |- + Sensitivity labeling is disabled for the user or tenant. + + * [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) + value: '"LabelingDisabled"' + - name: labelingEnabled + uid: word!Word.LabelingCapability.labelingEnabled:member + package: word! + summary: |- + Sensitivity labeling is fully enabled. + + * [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) + value: '"LabelingEnabled"' + - name: labelingPolicyNotFound + uid: word!Word.LabelingCapability.labelingPolicyNotFound:member + package: word! + summary: |- + No labeling policy was found for the user. + + * [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) + value: '"LabelingPolicyNotFound"' + - name: noLicense + uid: word!Word.LabelingCapability.noLicense:member + package: word! + summary: |- + No valid license is available for sensitivity labeling. + + * [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) + value: '"NoLicense"' diff --git a/docs/docs-ref-autogen/word/word/word.requestcontext.yml b/docs/docs-ref-autogen/word/word/word.requestcontext.yml index b0442d2d33..bc9892631d 100644 --- a/docs/docs-ref-autogen/word/word/word.requestcontext.yml +++ b/docs/docs-ref-autogen/word/word/word.requestcontext.yml @@ -140,6 +140,10 @@ remarks: |- - [Word.Section](/javascript/api/word/word.section): [context](/javascript/api/word/word.section#word-word-section-context-member) - [Word.SectionCollection](/javascript/api/word/word.sectioncollection): [context](/javascript/api/word/word.sectioncollection#word-word-sectioncollection-context-member) - [Word.Selection](/javascript/api/word/word.selection): [context](/javascript/api/word/word.selection#word-word-selection-context-member) + - [Word.SensitivityLabel](/javascript/api/word/word.sensitivitylabel): [context](/javascript/api/word/word.sensitivitylabel#word-word-sensitivitylabel-context-member) + - [Word.SensitivityLabelDetails](/javascript/api/word/word.sensitivitylabeldetails): [context](/javascript/api/word/word.sensitivitylabeldetails#word-word-sensitivitylabeldetails-context-member) + - [Word.SensitivityLabelDetailsCollection](/javascript/api/word/word.sensitivitylabeldetailscollection): [context](/javascript/api/word/word.sensitivitylabeldetailscollection#word-word-sensitivitylabeldetailscollection-context-member) + - [Word.SensitivityLabelsCatalog](/javascript/api/word/word.sensitivitylabelscatalog): [context](/javascript/api/word/word.sensitivitylabelscatalog#word-word-sensitivitylabelscatalog-context-member) - [Word.Setting](/javascript/api/word/word.setting): [context](/javascript/api/word/word.setting#word-word-setting-context-member) - [Word.SettingCollection](/javascript/api/word/word.settingcollection): [context](/javascript/api/word/word.settingcollection#word-word-settingcollection-context-member) - [Word.Shading](/javascript/api/word/word.shading): [context](/javascript/api/word/word.shading#word-word-shading-context-member) @@ -247,4 +251,17 @@ properties: content: 'readonly document: Document;' return: type: + - name: sensitivityLabelsCatalog + uid: word!Word.RequestContext#sensitivityLabelsCatalog:member + package: word! + fullName: sensitivityLabelsCatalog + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly sensitivityLabelsCatalog: SensitivityLabelsCatalog;' + return: + type: extends: diff --git a/docs/docs-ref-autogen/word/word/word.sensitivitylabel.yml b/docs/docs-ref-autogen/word/word/word.sensitivitylabel.yml new file mode 100644 index 0000000000..4fa0f41aba --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.sensitivitylabel.yml @@ -0,0 +1,159 @@ +### YamlMime:TSType +name: Word.SensitivityLabel +uid: word!Word.SensitivityLabel:class +package: word! +fullName: Word.SensitivityLabel +summary: Represents the sensitivity label on the document. +remarks: |- + [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) + + #### Used by + + - [Word.Document](/javascript/api/word/word.document): [sensitivityLabel](/javascript/api/word/word.document#word-word-document-sensitivitylabel-member) + +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.SensitivityLabel#context:member + package: word! + fullName: context + summary: The request context associated with the object. This connects the add-in's process to the Office host application's process. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: +methods: + - name: getCurrentOrNullObject() + uid: word!Word.SensitivityLabel#getCurrentOrNullObject:member(1) + package: word! + fullName: getCurrentOrNullObject() + summary: Gets the current label information that exists on the document for the user. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'getCurrentOrNullObject(): Word.SensitivityLabelDetails;' + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.SensitivityLabel#load:member(1) + package: word! + fullName: load(propertyNames) + summary: Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.SensitivityLabel;' + parameters: + - id: propertyNames + description: A comma-delimited string or an array of strings that specify the properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: word!Word.SensitivityLabel#load:member(2) + package: word! + fullName: load(propertyNamesAndPaths) + summary: Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.SensitivityLabel; + parameters: + - id: propertyNamesAndPaths + description: '`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.' + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: toJSON() + uid: word!Word.SensitivityLabel#toJSON:member(1) + package: word! + fullName: toJSON() + summary: 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 `Word.SensitivityLabel` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SensitivityLabelData`) that contains shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: |- + toJSON(): { + [key: string]: string; + }; + return: + type: |- + { + [key: string]: string; + } + description: '' + - name: track() + uid: word!Word.SensitivityLabel#track:member(1) + package: word! + fullName: track() + summary: Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.SensitivityLabel;' + return: + type: + description: '' + - name: tryToUpdate(LabelId, Justification) + uid: word!Word.SensitivityLabel#tryToUpdate:member(1) + package: word! + fullName: tryToUpdate(LabelId, Justification) + summary: Try to update to the provided sensitivity label on the document for the user. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'tryToUpdate(LabelId: string, Justification?: string): OfficeExtension.ClientResult;' + parameters: + - id: LabelId + description: The label information that needs to be set on the document. + type: string + - id: Justification + description: Optional. The justification of changing the label. + type: string + return: + type: <> + description: '' + - name: untrack() + uid: word!Word.SensitivityLabel#untrack:member(1) + package: word! + fullName: untrack() + summary: Release the memory associated with this object, if it has previously been tracked. This call is shorthand for [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.SensitivityLabel;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.sensitivitylabeldetails.yml b/docs/docs-ref-autogen/word/word/word.sensitivitylabeldetails.yml new file mode 100644 index 0000000000..ab1838bfa3 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.sensitivitylabeldetails.yml @@ -0,0 +1,254 @@ +### YamlMime:TSType +name: Word.SensitivityLabelDetails +uid: word!Word.SensitivityLabelDetails:class +package: word! +fullName: Word.SensitivityLabelDetails +summary: Represents the properties of available sensitivity labels in Word. +remarks: |- + [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) + + #### Used by + + - [Word.SensitivityLabel](/javascript/api/word/word.sensitivitylabel): [getCurrentOrNullObject](/javascript/api/word/word.sensitivitylabel#word-word-sensitivitylabel-getcurrentornullobject-member(1)) + - [Word.SensitivityLabelDetailsCollection](/javascript/api/word/word.sensitivitylabeldetailscollection): [getFirst](/javascript/api/word/word.sensitivitylabeldetailscollection#word-word-sensitivitylabeldetailscollection-getfirst-member(1)), [getFirstOrNullObject](/javascript/api/word/word.sensitivitylabeldetailscollection#word-word-sensitivitylabeldetailscollection-getfirstornullobject-member(1)), [getItem](/javascript/api/word/word.sensitivitylabeldetailscollection#word-word-sensitivitylabeldetailscollection-getitem-member(1)), [items](/javascript/api/word/word.sensitivitylabeldetailscollection#word-word-sensitivitylabeldetailscollection-items-member) + +isPreview: true +isDeprecated: false +type: class +properties: + - name: children + uid: word!Word.SensitivityLabelDetails#children:member + package: word! + fullName: children + summary: The sublabels of the sensitivity label. Returns null if a label doesn't have any sublabels. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly children: Word.SensitivityLabelDetailsCollection;' + return: + type: + - name: color + uid: word!Word.SensitivityLabelDetails#color:member + package: word! + fullName: color + summary: The color of the sensitivity label. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly color: string;' + return: + type: string + - name: context + uid: word!Word.SensitivityLabelDetails#context:member + package: word! + fullName: context + summary: The request context associated with the object. This connects the add-in's process to the Office host application's process. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: id + uid: word!Word.SensitivityLabelDetails#id:member + package: word! + fullName: id + summary: The unique identifier (GUID) of the sensitivity label. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly id: string;' + return: + type: string + - name: isEnabled + uid: word!Word.SensitivityLabelDetails#isEnabled:member + package: word! + fullName: isEnabled + summary: Gets a value indicating whether the label is enabled. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly isEnabled: boolean;' + return: + type: boolean + - name: name + uid: word!Word.SensitivityLabelDetails#name:member + package: word! + fullName: name + summary: The name of the sensitivity label. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly name: string;' + return: + type: string + - name: order + uid: word!Word.SensitivityLabelDetails#order:member + package: word! + fullName: order + summary: The order of the sensitivity label. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly order: number;' + return: + type: number + - name: protectionType + uid: word!Word.SensitivityLabelDetails#protectionType:member + package: word! + fullName: protectionType + summary: Gets a value indicating the protection type provided by this label. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly protectionType: Word.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined";' + return: + type: | "NoProtection" | "AdminDefined" | "UserDefined" + - name: siteId + uid: word!Word.SensitivityLabelDetails#siteId:member + package: word! + fullName: siteId + summary: The unique identifier (GUID) of the tenant which the sensitivity label is belonged. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly siteId: string;' + return: + type: string + - name: tooltip + uid: word!Word.SensitivityLabelDetails#tooltip:member + package: word! + fullName: tooltip + summary: The description of the sensitivity label. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly tooltip: string;' + return: + type: string +methods: + - name: load(options) + uid: word!Word.SensitivityLabelDetails#load:member(1) + package: word! + fullName: load(options) + summary: Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'load(options?: Word.Interfaces.SensitivityLabelDetailsLoadOptions): Word.SensitivityLabelDetails;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.SensitivityLabelDetails#load:member(2) + package: word! + fullName: load(propertyNames) + summary: Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.SensitivityLabelDetails;' + parameters: + - id: propertyNames + description: A comma-delimited string or an array of strings that specify the properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: word!Word.SensitivityLabelDetails#load:member(3) + package: word! + fullName: load(propertyNamesAndPaths) + summary: Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.SensitivityLabelDetails; + parameters: + - id: propertyNamesAndPaths + description: '`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.' + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: toJSON() + uid: word!Word.SensitivityLabelDetails#toJSON:member(1) + package: word! + fullName: toJSON() + summary: 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 `Word.SensitivityLabelDetails` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SensitivityLabelDetailsData`) that contains shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.SensitivityLabelDetailsData;' + return: + type: + description: '' + - name: track() + uid: word!Word.SensitivityLabelDetails#track:member(1) + package: word! + fullName: track() + summary: Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.SensitivityLabelDetails;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.SensitivityLabelDetails#untrack:member(1) + package: word! + fullName: untrack() + summary: Release the memory associated with this object, if it has previously been tracked. This call is shorthand for [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.SensitivityLabelDetails;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.sensitivitylabeldetailscollection.yml b/docs/docs-ref-autogen/word/word/word.sensitivitylabeldetailscollection.yml new file mode 100644 index 0000000000..69c0030ea5 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.sensitivitylabeldetailscollection.yml @@ -0,0 +1,188 @@ +### YamlMime:TSType +name: Word.SensitivityLabelDetailsCollection +uid: word!Word.SensitivityLabelDetailsCollection:class +package: word! +fullName: Word.SensitivityLabelDetailsCollection +summary: Represents the collection of [Word.SensitivityLabelDetails](xref:word!Word.SensitivityLabelDetails:class) objects. +remarks: |- + [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) + + #### Used by + + - [Word.SensitivityLabelDetails](/javascript/api/word/word.sensitivitylabeldetails): [children](/javascript/api/word/word.sensitivitylabeldetails#word-word-sensitivitylabeldetails-children-member) + - [Word.SensitivityLabelsCatalog](/javascript/api/word/word.sensitivitylabelscatalog): [getLabels](/javascript/api/word/word.sensitivitylabelscatalog#word-word-sensitivitylabelscatalog-getlabels-member(1)) + +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.SensitivityLabelDetailsCollection#context:member + package: word! + fullName: context + summary: The request context associated with the object. This connects the add-in's process to the Office host application's process. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: word!Word.SensitivityLabelDetailsCollection#items:member + package: word! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly items: Word.SensitivityLabelDetails[];' + return: + type: [] +methods: + - name: getFirst() + uid: word!Word.SensitivityLabelDetailsCollection#getFirst:member(1) + package: word! + fullName: getFirst() + summary: Gets the first `SensitivityLabelDetails` object in this collection. Throws an `ItemNotFound` error if this collection is empty. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'getFirst(): Word.SensitivityLabelDetails;' + return: + type: + description: '' + - name: getFirstOrNullObject() + uid: word!Word.SensitivityLabelDetailsCollection#getFirstOrNullObject:member(1) + package: word! + fullName: getFirstOrNullObject() + summary: 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](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'getFirstOrNullObject(): Word.SensitivityLabelDetails;' + return: + type: + description: '' + - name: getItem(index) + uid: word!Word.SensitivityLabelDetailsCollection#getItem:member(1) + package: word! + fullName: getItem(index) + summary: Gets a `SensitivityLabelDetails` object by its index in the collection. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'getItem(index: number): Word.SensitivityLabelDetails;' + parameters: + - id: index + description: A number that identifies the index location of a `SensitivityLabelDetails` object. + type: number + return: + type: + description: '' + - name: load(options) + uid: word!Word.SensitivityLabelDetailsCollection#load:member(1) + package: word! + fullName: load(options) + summary: Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'load(options?: Word.Interfaces.SensitivityLabelDetailsCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SensitivityLabelDetailsCollection;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: & + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.SensitivityLabelDetailsCollection#load:member(2) + package: word! + fullName: load(propertyNames) + summary: Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.SensitivityLabelDetailsCollection;' + parameters: + - id: propertyNames + description: A comma-delimited string or an array of strings that specify the properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: word!Word.SensitivityLabelDetailsCollection#load:member(3) + package: word! + fullName: load(propertyNamesAndPaths) + summary: Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.SensitivityLabelDetailsCollection;' + parameters: + - id: propertyNamesAndPaths + description: '`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.' + type: + return: + type: + description: '' + - name: toJSON() + uid: word!Word.SensitivityLabelDetailsCollection#toJSON:member(1) + package: word! + fullName: toJSON() + summary: 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 `Word.SensitivityLabelDetailsCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SensitivityLabelDetailsCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.SensitivityLabelDetailsCollectionData;' + return: + type: + description: '' + - name: track() + uid: word!Word.SensitivityLabelDetailsCollection#track:member(1) + package: word! + fullName: track() + summary: Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.SensitivityLabelDetailsCollection;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.SensitivityLabelDetailsCollection#untrack:member(1) + package: word! + fullName: untrack() + summary: Release the memory associated with this object, if it has previously been tracked. This call is shorthand for [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.SensitivityLabelDetailsCollection;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.sensitivitylabelprotectiontype.yml b/docs/docs-ref-autogen/word/word/word.sensitivitylabelprotectiontype.yml new file mode 100644 index 0000000000..f4d4bed944 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.sensitivitylabelprotectiontype.yml @@ -0,0 +1,40 @@ +### YamlMime:TSEnum +name: Word.SensitivityLabelProtectionType +uid: word!Word.SensitivityLabelProtectionType:enum +package: word! +fullName: Word.SensitivityLabelProtectionType +summary: Specifies the type of protection applied by a sensitivity label. +remarks: |- + [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) + + #### Used by + + - [Word.SensitivityLabelDetails](/javascript/api/word/word.sensitivitylabeldetails): [protectionType](/javascript/api/word/word.sensitivitylabeldetails#word-word-sensitivitylabeldetails-protectiontype-member) + +isPreview: true +isDeprecated: false +fields: + - name: adminDefined + uid: word!Word.SensitivityLabelProtectionType.adminDefined:member + package: word! + summary: |- + The label applies admin-defined protection. + + * [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) + value: '"AdminDefined"' + - name: noProtection + uid: word!Word.SensitivityLabelProtectionType.noProtection:member + package: word! + summary: |- + The label applies no protection. + + * [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) + value: '"NoProtection"' + - name: userDefined + uid: word!Word.SensitivityLabelProtectionType.userDefined:member + package: word! + summary: |- + The label applies user-defined protection. + + * [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) + value: '"UserDefined"' diff --git a/docs/docs-ref-autogen/word/word/word.sensitivitylabelscatalog.yml b/docs/docs-ref-autogen/word/word/word.sensitivitylabelscatalog.yml new file mode 100644 index 0000000000..1c89b26fd1 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.sensitivitylabelscatalog.yml @@ -0,0 +1,181 @@ +### YamlMime:TSType +name: Word.SensitivityLabelsCatalog +uid: word!Word.SensitivityLabelsCatalog:class +package: word! +fullName: Word.SensitivityLabelsCatalog +summary: Provides methods to check the status of the catalog of sensitivity labels in Word and retrieve all available sensitivity labels if the catalog is enabled. +remarks: |- + [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) + + #### Used by + + - [Word.RequestContext](/javascript/api/word/word.requestcontext): [sensitivityLabelsCatalog](/javascript/api/word/word.requestcontext#word-word-requestcontext-sensitivitylabelscatalog-member) + +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.SensitivityLabelsCatalog#context:member + package: word! + fullName: context + summary: The request context associated with the object. This connects the add-in's process to the Office host application's process. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: getLabelingCapability + uid: word!Word.SensitivityLabelsCatalog#getLabelingCapability:member + package: word! + fullName: getLabelingCapability + summary: Gets the labeling capability status of the sensitivity label catalog in Word. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly getLabelingCapability: Word.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled";' + return: + type: | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled" +methods: + - name: getLabels() + uid: word!Word.SensitivityLabelsCatalog#getLabels:member(1) + package: word! + fullName: getLabels() + summary: Gets all the sensitivity labels that are enabled in Word. + remarks: '[API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets)' + + isPreview: true + isDeprecated: false + syntax: + content: 'getLabels(): Word.SensitivityLabelDetailsCollection;' + return: + type: + description: '' + - name: load(options) + uid: word!Word.SensitivityLabelsCatalog#load:member(1) + package: word! + fullName: load(options) + summary: Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'load(options?: Word.Interfaces.SensitivityLabelsCatalogLoadOptions): Word.SensitivityLabelsCatalog;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.SensitivityLabelsCatalog#load:member(2) + package: word! + fullName: load(propertyNames) + summary: Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.SensitivityLabelsCatalog;' + parameters: + - id: propertyNames + description: A comma-delimited string or an array of strings that specify the properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: word!Word.SensitivityLabelsCatalog#load:member(3) + package: word! + fullName: load(propertyNamesAndPaths) + summary: Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.SensitivityLabelsCatalog; + parameters: + - id: propertyNamesAndPaths + description: '`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.' + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: newObject(context) + uid: word!Word.SensitivityLabelsCatalog.newObject:member(1) + package: word! + fullName: newObject(context) + summary: Create a new instance of the `Word.SensitivityLabelsCatalog` object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'static newObject(context: OfficeExtension.ClientRequestContext): Word.SensitivityLabelsCatalog;' + parameters: + - id: context + description: '' + type: + return: + type: + description: '' + - name: toJSON() + uid: word!Word.SensitivityLabelsCatalog#toJSON:member(1) + package: word! + fullName: toJSON() + summary: 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 `Word.SensitivityLabelsCatalog` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SensitivityLabelsCatalogData`) that contains shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.SensitivityLabelsCatalogData;' + return: + type: + description: '' + - name: track() + uid: word!Word.SensitivityLabelsCatalog#track:member(1) + package: word! + fullName: track() + summary: Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.SensitivityLabelsCatalog;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.SensitivityLabelsCatalog#untrack:member(1) + package: word! + fullName: untrack() + summary: Release the memory associated with this object, if it has previously been tracked. This call is shorthand for [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.SensitivityLabelsCatalog;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.sensitivitylabelupdateresult.yml b/docs/docs-ref-autogen/word/word/word.sensitivitylabelupdateresult.yml new file mode 100644 index 0000000000..2ed4fa740e --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.sensitivitylabelupdateresult.yml @@ -0,0 +1,104 @@ +### YamlMime:TSEnum +name: Word.SensitivityLabelUpdateResult +uid: word!Word.SensitivityLabelUpdateResult:enum +package: word! +fullName: Word.SensitivityLabelUpdateResult +summary: Represents the result of updating the sensitivity label on the document. +remarks: |- + [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) + + #### Used by + + - [Word.SensitivityLabel](/javascript/api/word/word.sensitivitylabel): [tryToUpdate](/javascript/api/word/word.sensitivitylabel#word-word-sensitivitylabel-trytoupdate-member(1)) + +isPreview: true +isDeprecated: false +fields: + - name: crossTenant + uid: word!Word.SensitivityLabelUpdateResult.crossTenant:member + package: word! + summary: |- + The label update failed because the document doesn't belong to the same tenant as the user. + + * [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) + value: '"CrossTenant"' + - name: documentReadOnly + uid: word!Word.SensitivityLabelUpdateResult.documentReadOnly:member + package: word! + summary: |- + The document is read-only and cannot be modified. + + * [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) + value: '"DocumentReadOnly"' + - name: insufficientPermission + uid: word!Word.SensitivityLabelUpdateResult.insufficientPermission:member + package: word! + summary: |- + The user does not have sufficient permissions to update the label. + + * [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) + value: '"InsufficientPermission"' + - name: labelingDisabled + uid: word!Word.SensitivityLabelUpdateResult.labelingDisabled:member + package: word! + summary: |- + The label update failed because native labeling is not enabled for the user or installed SKU. + + * [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) + value: '"LabelingDisabled"' + - name: labelNotFound + uid: word!Word.SensitivityLabelUpdateResult.labelNotFound:member + package: word! + summary: |- + The specified sensitivity label could not be found. + + * [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) + value: '"LabelNotFound"' + - name: parentLabelNotSupported + uid: word!Word.SensitivityLabelUpdateResult.parentLabelNotSupported:member + package: word! + summary: |- + The label update failed because the specified label is a parent label, which cannot be applied. + + * [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) + value: '"ParentLabelNotSupported"' + - name: success + uid: word!Word.SensitivityLabelUpdateResult.success:member + package: word! + summary: |- + The sensitivity label was successfully updated. + + * [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) + value: '"Success"' + - name: unspecifiedFailure + uid: word!Word.SensitivityLabelUpdateResult.unspecifiedFailure:member + package: word! + summary: |- + The update failed due to an unspecified error. + + * [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) + value: '"UnspecifiedFailure"' + - name: unsupportedDoubleKeyEncryption + uid: word!Word.SensitivityLabelUpdateResult.unsupportedDoubleKeyEncryption:member + package: word! + summary: |- + The label update failed due to unsupported Double Key Encryption (DKE). + + * [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) + value: '"UnsupportedDoubleKeyEncryption"' + - name: unsupportedUdp + uid: word!Word.SensitivityLabelUpdateResult.unsupportedUdp:member + package: word! + summary: |- + The label update failed due to unsupported Universal Data Protection (UDP). + + * [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) + value: '"UnsupportedUdp"' + - name: userNotFound + uid: word!Word.SensitivityLabelUpdateResult.userNotFound:member + package: word! + summary: |- + The label update failed because the user's identity is not valid for applying a label. + + * [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) + value: '"UserNotFound"' diff --git a/docs/includes/excel-preview.md b/docs/includes/excel-preview.md index 82b1a4d318..2169a47065 100644 --- a/docs/includes/excel-preview.md +++ b/docs/includes/excel-preview.md @@ -72,6 +72,13 @@ ||[type](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue#excel-excel-externalcodeserviceobjectcellvalue-type-member)|Represents the type of this cell value.| |[Identity](/javascript/api/excel/excel.identity)|[displayName](/javascript/api/excel/excel.identity#excel-excel-identity-displayname-member)|Represents the user's display name.| ||[id](/javascript/api/excel/excel.identity#excel-excel-identity-id-member)|Represents the user's unique ID.| +|[LinkedEntityCellValueLoadedEventArgs](/javascript/api/excel/excel.linkedentitycellvalueloadedeventargs)|[error](/javascript/api/excel/excel.linkedentitycellvalueloadedeventargs#excel-excel-linkedentitycellvalueloadedeventargs-error-member)|Any error encountered during the request to load the `LinkedEntityCellValue`.| +||[id](/javascript/api/excel/excel.linkedentitycellvalueloadedeventargs#excel-excel-linkedentitycellvalueloadedeventargs-id-member)|Gets the `LinkedEntityId` of the requested `LinkedEntityCellValue`.| +||[linkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalueloadedeventargs#excel-excel-linkedentitycellvalueloadedeventargs-linkedentitycellvalue-member)|Gets the `LinkedEntityCellValue` of the requested `LinkedEntityId`.| +||[source](/javascript/api/excel/excel.linkedentitycellvalueloadedeventargs#excel-excel-linkedentitycellvalueloadedeventargs-source-member)|Gets the source of the event.| +||[type](/javascript/api/excel/excel.linkedentitycellvalueloadedeventargs#excel-excel-linkedentitycellvalueloadedeventargs-type-member)|Gets the type of the event.| +|[LinkedEntityDataDomainCollection](/javascript/api/excel/excel.linkedentitydatadomaincollection)|[loadLinkedEntityCellValue(id: LinkedEntityId)](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-loadlinkedentitycellvalue-member(1))|Submits a request to load the `LinkedEntityCellValue` object with the specified `LinkedEntityId`.| +||[onLinkedEntityCellValueLoaded](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-onlinkedentitycellvalueloaded-member)|Occurs when the request to load a `LinkedEntityCellValue` is completed.| |[LocalImage](/javascript/api/excel/excel.localimage)|[getBase64EncodedImageData(cacheUid: string)](/javascript/api/excel/excel.localimage#excel-excel-localimage-getbase64encodedimagedata-member(1))|Gets the Base64-encoded image data stored in the shared image cache with the cache unique identifier (UID).| |[LocalImageCellValue](/javascript/api/excel/excel.localimagecellvalue)|[altText](/javascript/api/excel/excel.localimagecellvalue#excel-excel-localimagecellvalue-alttext-member)|Represents the alternate text used in accessibility scenarios to describe what the image represents.| ||[attribution](/javascript/api/excel/excel.localimagecellvalue#excel-excel-localimagecellvalue-attribution-member)|Represents attribution information to describe the source and license requirements for this image.| @@ -95,7 +102,24 @@ |[Query](/javascript/api/excel/excel.query)|[delete()](/javascript/api/excel/excel.query#excel-excel-query-delete-member(1))|Deletes the query and associated connection.| |[QueryCollection](/javascript/api/excel/excel.querycollection)|[refreshAll()](/javascript/api/excel/excel.querycollection#excel-excel-querycollection-refreshall-member(1))|Refresh all queries.| |[Range](/javascript/api/excel/excel.range)|[togglePythonMarshalMode(marshalMode?: Excel.PythonMarshalMode)](/javascript/api/excel/excel.range#excel-excel-range-togglepythonmarshalmode-member(1))|Sets the marshaling mode of the Python in Excel formula =PY.| -|[RequestContext](/javascript/api/excel/excel.requestcontext)|[setInvocation(invocation: { invocationId: number isInSyncExecution: boolean })](/javascript/api/excel/excel.requestcontext#excel-excel-requestcontext-setinvocation-member(1))|| +|[RequestContext](/javascript/api/excel/excel.requestcontext)|[sensitivityLabelsCatalog](/javascript/api/excel/excel.requestcontext#excel-excel-requestcontext-sensitivitylabelscatalog-member)|[Api set: ExcelApi BETA (PREVIEW ONLY)]| +||[setInvocation(invocation: { invocationId: number isInSyncExecution: boolean })](/javascript/api/excel/excel.requestcontext#excel-excel-requestcontext-setinvocation-member(1))|| +|[SensitivityLabel](/javascript/api/excel/excel.sensitivitylabel)|[getCurrentOrNullObject()](/javascript/api/excel/excel.sensitivitylabel#excel-excel-sensitivitylabel-getcurrentornullobject-member(1))|Gets the current label information that exists on the workbook for the user.| +||[tryToUpdate(labelId: string)](/javascript/api/excel/excel.sensitivitylabel#excel-excel-sensitivitylabel-trytoupdate-member(1))|Tries to update to the provided sensitivity label on the workbook for the user.| +|[SensitivityLabelDetails](/javascript/api/excel/excel.sensitivitylabeldetails)|[children](/javascript/api/excel/excel.sensitivitylabeldetails#excel-excel-sensitivitylabeldetails-children-member)|Gets the sublabels of the sensitivity label.| +||[color](/javascript/api/excel/excel.sensitivitylabeldetails#excel-excel-sensitivitylabeldetails-color-member)|Gets the color of the sensitivity label.| +||[id](/javascript/api/excel/excel.sensitivitylabeldetails#excel-excel-sensitivitylabeldetails-id-member)|Gets the unique identifier (GUID) of the sensitivity label.| +||[isEnabled](/javascript/api/excel/excel.sensitivitylabeldetails#excel-excel-sensitivitylabeldetails-isenabled-member)|Gets a value indicating whether the label is enabled.| +||[name](/javascript/api/excel/excel.sensitivitylabeldetails#excel-excel-sensitivitylabeldetails-name-member)|Gets the name of the sensitivity label.| +||[order](/javascript/api/excel/excel.sensitivitylabeldetails#excel-excel-sensitivitylabeldetails-order-member)|Gets the priority of the sensitivity label, with 0 as lowest priority.| +||[protectionType](/javascript/api/excel/excel.sensitivitylabeldetails#excel-excel-sensitivitylabeldetails-protectiontype-member)|Gets a value indicating the protection type provided by this label.| +||[siteId](/javascript/api/excel/excel.sensitivitylabeldetails#excel-excel-sensitivitylabeldetails-siteid-member)|Gets the unique identifier (GUID) of the tenant which the sensitivity label is belonged.| +||[tooltip](/javascript/api/excel/excel.sensitivitylabeldetails#excel-excel-sensitivitylabeldetails-tooltip-member)|Gets the description of the sensitivity label.| +|[SensitivityLabelDetailsCollection](/javascript/api/excel/excel.sensitivitylabeldetailscollection)|[getFirst()](/javascript/api/excel/excel.sensitivitylabeldetailscollection#excel-excel-sensitivitylabeldetailscollection-getfirst-member(1))|Gets the first `SensitivityLabelDetails` object in this collection.| +||[getFirstOrNullObject()](/javascript/api/excel/excel.sensitivitylabeldetailscollection#excel-excel-sensitivitylabeldetailscollection-getfirstornullobject-member(1))|Gets the first `SensitivityLabelDetails` object in this collection.| +||[items](/javascript/api/excel/excel.sensitivitylabeldetailscollection#excel-excel-sensitivitylabeldetailscollection-items-member)|Gets the loaded child items in this collection.| +|[SensitivityLabelsCatalog](/javascript/api/excel/excel.sensitivitylabelscatalog)|[getLabelingCapability](/javascript/api/excel/excel.sensitivitylabelscatalog#excel-excel-sensitivitylabelscatalog-getlabelingcapability-member)|Gets whether the catalog of sensitivity labels is enabled in Excel.| +||[getLabels()](/javascript/api/excel/excel.sensitivitylabelscatalog#excel-excel-sensitivitylabelscatalog-getlabels-member(1))|Gets sensitivity labels that are available to the current user.| |[ShapeCollection](/javascript/api/excel/excel.shapecollection)|[addLocalImageReference(address: string)](/javascript/api/excel/excel.shapecollection#excel-excel-shapecollection-addlocalimagereference-member(1))|Creates a reference for the local image stored in the cell address and displays it as a floating shape over cells.| ||[addSvg(xml: string)](/javascript/api/excel/excel.shapecollection#excel-excel-shapecollection-addsvg-member(1))|Creates a scalable vector graphic (SVG) from an XML string and adds it to the worksheet.| |[ShapeFont](/javascript/api/excel/excel.shapefont)|[strikethrough](/javascript/api/excel/excel.shapefont#excel-excel-shapefont-strikethrough-member)|Specifies the strikethrough status of font.| @@ -128,6 +152,7 @@ ||[externalCodeServiceTimeout](/javascript/api/excel/excel.workbook#excel-excel-workbook-externalcodeservicetimeout-member)|Specifies the maximum length of time, in seconds, allotted for a formula that depends on an external code service to complete.| ||[inPreviewMode()](/javascript/api/excel/excel.workbook#excel-excel-workbook-inpreviewmode-member(1))|Returns whether the workbook is currently in preview mode.| ||[localImage](/javascript/api/excel/excel.workbook#excel-excel-workbook-localimage-member)|Returns the `LocalImage` object associated with the workbook.| +||[sensitivityLabel](/javascript/api/excel/excel.workbook#excel-excel-workbook-sensitivitylabel-member)|Returns the sensitivity label of the workbook.| ||[showPivotFieldList](/javascript/api/excel/excel.workbook#excel-excel-workbook-showpivotfieldlist-member)|Specifies whether the PivotTable's field list pane is shown at the workbook level.| ||[tasks](/javascript/api/excel/excel.workbook#excel-excel-workbook-tasks-member)|Returns a collection of tasks that are present in the workbook.| ||[use1904DateSystem](/javascript/api/excel/excel.workbook#excel-excel-workbook-use1904datesystem-member)|True if the workbook uses the 1904 date system.| diff --git a/docs/includes/word-preview.md b/docs/includes/word-preview.md index a9ad0475f7..468f784555 100644 --- a/docs/includes/word-preview.md +++ b/docs/includes/word-preview.md @@ -55,6 +55,7 @@ ||[replyWithChanges(options?: Word.DocumentReplyWithChangesOptions)](/javascript/api/word/word.document#word-word-document-replywithchanges-member(1))|Sends an email message to the author of the document that has been sent out for review, notifying them that a reviewer has completed review of the document.| ||[sendFaxOverInternet(options?: Word.DocumentSendFaxOverInternetOptions)](/javascript/api/word/word.document#word-word-document-sendfaxoverinternet-member(1))|Sends the document to a fax service provider, who faxes the document to one or more specified recipients.| ||[sendForReview(options?: Word.DocumentSendForReviewOptions)](/javascript/api/word/word.document#word-word-document-sendforreview-member(1))|Sends the document in an email message for review by the specified recipients.| +||[sensitivityLabel](/javascript/api/word/word.document#word-word-document-sensitivitylabel-member)|Returns the sensitivity label of the document.| |[DocumentCheckInOptions](/javascript/api/word/word.documentcheckinoptions)|[comment](/javascript/api/word/word.documentcheckinoptions#word-word-documentcheckinoptions-comment-member)|If provided, specifies a comment for the check-in operation.| ||[makePublic](/javascript/api/word/word.documentcheckinoptions#word-word-documentcheckinoptions-makepublic-member)|If provided, specifies whether to make the document public after check-in.| ||[saveChanges](/javascript/api/word/word.documentcheckinoptions#word-word-documentcheckinoptions-savechanges-member)|If provided, specifies whether to save changes before checking in.| @@ -187,6 +188,7 @@ ||[underline](/javascript/api/word/word.range#word-word-range-underline-member)|Specifies the type of underline applied to the range.| |[RangeScopedCollection](/javascript/api/word/word.rangescopedcollection)|[getItem(index: number)](/javascript/api/word/word.rangescopedcollection#word-word-rangescopedcollection-getitem-member(1))|Gets a `Range` object by its index in the collection.| |[RepeatingSectionContentControl](/javascript/api/word/word.repeatingsectioncontentcontrol)|[xmlMapping](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-xmlmapping-member)|Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document.| +|[RequestContext](/javascript/api/word/word.requestcontext)|[sensitivityLabelsCatalog](/javascript/api/word/word.requestcontext#word-word-requestcontext-sensitivitylabelscatalog-member)|| |[ReviewerCollection](/javascript/api/word/word.reviewercollection)|[getItem(index: number)](/javascript/api/word/word.reviewercollection#word-word-reviewercollection-getitem-member(1))|Returns a `Reviewer` object that represents the specified item in the collection.| |[RevisionCollection](/javascript/api/word/word.revisioncollection)|[getItem(index: number)](/javascript/api/word/word.revisioncollection#word-word-revisioncollection-getitem-member(1))|Returns a `Revision` object that represents the specified item in the collection.| |[Selection](/javascript/api/word/word.selection)|[convertToTable(options?: Word.SelectionConvertToTableOptions)](/javascript/api/word/word.selection#word-word-selection-converttotable-member(1))|Converts text within a range to a table.| @@ -207,6 +209,23 @@ ||[numColumns](/javascript/api/word/word.selectionconverttotableoptions#word-word-selectionconverttotableoptions-numcolumns-member)|If provided, specifies the number of columns in the table.| ||[numRows](/javascript/api/word/word.selectionconverttotableoptions#word-word-selectionconverttotableoptions-numrows-member)|If provided, specifies the number of rows in the table.| ||[separator](/javascript/api/word/word.selectionconverttotableoptions#word-word-selectionconverttotableoptions-separator-member)|If provided, specifies the character used to separate text into cells.| +|[SensitivityLabel](/javascript/api/word/word.sensitivitylabel)|[getCurrentOrNullObject()](/javascript/api/word/word.sensitivitylabel#word-word-sensitivitylabel-getcurrentornullobject-member(1))|Gets the current label information that exists on the document for the user.| +||[tryToUpdate(LabelId: string, Justification?: string)](/javascript/api/word/word.sensitivitylabel#word-word-sensitivitylabel-trytoupdate-member(1))|Try to update to the provided sensitivity label on the document for the user.| +|[SensitivityLabelDetails](/javascript/api/word/word.sensitivitylabeldetails)|[children](/javascript/api/word/word.sensitivitylabeldetails#word-word-sensitivitylabeldetails-children-member)|The sublabels of the sensitivity label.| +||[color](/javascript/api/word/word.sensitivitylabeldetails#word-word-sensitivitylabeldetails-color-member)|The color of the sensitivity label.| +||[id](/javascript/api/word/word.sensitivitylabeldetails#word-word-sensitivitylabeldetails-id-member)|The unique identifier (GUID) of the sensitivity label.| +||[isEnabled](/javascript/api/word/word.sensitivitylabeldetails#word-word-sensitivitylabeldetails-isenabled-member)|Gets a value indicating whether the label is enabled.| +||[name](/javascript/api/word/word.sensitivitylabeldetails#word-word-sensitivitylabeldetails-name-member)|The name of the sensitivity label.| +||[order](/javascript/api/word/word.sensitivitylabeldetails#word-word-sensitivitylabeldetails-order-member)|The order of the sensitivity label.| +||[protectionType](/javascript/api/word/word.sensitivitylabeldetails#word-word-sensitivitylabeldetails-protectiontype-member)|Gets a value indicating the protection type provided by this label.| +||[siteId](/javascript/api/word/word.sensitivitylabeldetails#word-word-sensitivitylabeldetails-siteid-member)|The unique identifier (GUID) of the tenant which the sensitivity label is belonged.| +||[tooltip](/javascript/api/word/word.sensitivitylabeldetails#word-word-sensitivitylabeldetails-tooltip-member)|The description of the sensitivity label.| +|[SensitivityLabelDetailsCollection](/javascript/api/word/word.sensitivitylabeldetailscollection)|[getFirst()](/javascript/api/word/word.sensitivitylabeldetailscollection#word-word-sensitivitylabeldetailscollection-getfirst-member(1))|Gets the first `SensitivityLabelDetails` object in this collection.| +||[getFirstOrNullObject()](/javascript/api/word/word.sensitivitylabeldetailscollection#word-word-sensitivitylabeldetailscollection-getfirstornullobject-member(1))|Gets the first `SensitivityLabelDetails` object in this collection.| +||[getItem(index: number)](/javascript/api/word/word.sensitivitylabeldetailscollection#word-word-sensitivitylabeldetailscollection-getitem-member(1))|Gets a `SensitivityLabelDetails` object by its index in the collection.| +||[items](/javascript/api/word/word.sensitivitylabeldetailscollection#word-word-sensitivitylabeldetailscollection-items-member)|Gets the loaded child items in this collection.| +|[SensitivityLabelsCatalog](/javascript/api/word/word.sensitivitylabelscatalog)|[getLabelingCapability](/javascript/api/word/word.sensitivitylabelscatalog#word-word-sensitivitylabelscatalog-getlabelingcapability-member)|Gets the labeling capability status of the sensitivity label catalog in Word.| +||[getLabels()](/javascript/api/word/word.sensitivitylabelscatalog#word-word-sensitivitylabelscatalog-getlabels-member(1))|Gets all the sensitivity labels that are enabled in Word.| |[SourceCollection](/javascript/api/word/word.sourcecollection)|[getItem(index: number)](/javascript/api/word/word.sourcecollection#word-word-sourcecollection-getitem-member(1))|Gets a `Source` by its index in the collection.| |[Style](/javascript/api/word/word.style)|[description](/javascript/api/word/word.style#word-word-style-description-member)|Gets the description of the style.| |[TabStopCollection](/javascript/api/word/word.tabstopcollection)|[getItem(index: number)](/javascript/api/word/word.tabstopcollection#word-word-tabstopcollection-getitem-member(1))|Gets a `TabStop` object by its index in the collection.| diff --git a/docs/requirement-sets/excel/excel-preview-apis.md b/docs/requirement-sets/excel/excel-preview-apis.md index f573ca57c7..a8dcc312b2 100644 --- a/docs/requirement-sets/excel/excel-preview-apis.md +++ b/docs/requirement-sets/excel/excel-preview-apis.md @@ -1,7 +1,7 @@ --- title: Excel JavaScript preview APIs description: Details about upcoming Excel JavaScript APIs. -ms.date: 05/12/2026 +ms.date: 06/26/2026 ms.topic: whats-new ms.localizationpriority: medium --- diff --git a/docs/requirement-sets/word/word-preview-apis.md b/docs/requirement-sets/word/word-preview-apis.md index 592ee0926c..3fa776428a 100644 --- a/docs/requirement-sets/word/word-preview-apis.md +++ b/docs/requirement-sets/word/word-preview-apis.md @@ -1,7 +1,7 @@ --- title: Word JavaScript preview APIs description: Details about upcoming Word JavaScript APIs. -ms.date: 04/26/2026 +ms.date: 06/26/2026 ms.topic: whats-new ms.localizationpriority: medium --- diff --git a/generate-docs/API Coverage Report.csv b/generate-docs/API Coverage Report.csv index 77fda3134d..de33496db4 100644 --- a/generate-docs/API Coverage Report.csv +++ b/generate-docs/API Coverage Report.csv @@ -4419,6 +4419,11 @@ excel,Excel.LabelFilterCondition,"greaterThanOrEqualTo",EnumField,Excellent,fals excel,Excel.LabelFilterCondition,"lessThan",EnumField,Excellent,false excel,Excel.LabelFilterCondition,"lessThanOrEqualTo",EnumField,Excellent,false excel,Excel.LabelFilterCondition,"unknown",EnumField,Excellent,false +excel,Excel.LabelingCapability,N/A,Enum,Great,false +excel,Excel.LabelingCapability,"labelingDisabled",EnumField,Great,false +excel,Excel.LabelingCapability,"labelingEnabled",EnumField,Great,false +excel,Excel.LabelingCapability,"labelingPolicyNotFound",EnumField,Great,false +excel,Excel.LabelingCapability,"noLicense",EnumField,Great,false excel,Excel.Line,N/A,Class,Good,false excel,Excel.Line,"beginArrowheadLength",Property,Great,false excel,Excel.Line,"beginArrowheadStyle",Property,Great,false @@ -4461,6 +4466,12 @@ excel,Excel.LinkedEntityCellValue,"properties",Property,Great,false excel,Excel.LinkedEntityCellValue,"provider",Property,Excellent,false excel,Excel.LinkedEntityCellValue,"text",Property,Great,false excel,Excel.LinkedEntityCellValue,"type",Property,Good,false +excel,Excel.LinkedEntityCellValueLoadedEventArgs,N/A,Interface,Good,false +excel,Excel.LinkedEntityCellValueLoadedEventArgs,"error",Property,Excellent,false +excel,Excel.LinkedEntityCellValueLoadedEventArgs,"id",Property,Great,false +excel,Excel.LinkedEntityCellValueLoadedEventArgs,"linkedEntityCellValue",Property,Excellent,false +excel,Excel.LinkedEntityCellValueLoadedEventArgs,"source",Property,Great,false +excel,Excel.LinkedEntityCellValueLoadedEventArgs,"type",Property,Great,false excel,Excel.LinkedEntityDataDomain,N/A,Class,Great,false excel,Excel.LinkedEntityDataDomain,"context",Property,Excellent,false excel,Excel.LinkedEntityDataDomain,"dataProvider",Property,Excellent,false @@ -4496,6 +4507,7 @@ excel,Excel.LinkedEntityDataDomainCollection,"getItemOrNullObject(id)",Method,Ex excel,Excel.LinkedEntityDataDomainCollection,"load(options)",Method,Great,false excel,Excel.LinkedEntityDataDomainCollection,"load(propertyNames)",Method,Great,false excel,Excel.LinkedEntityDataDomainCollection,"load(propertyNamesAndPaths)",Method,Great,false +excel,Excel.LinkedEntityDataDomainCollection,"loadLinkedEntityCellValue(id)",Method,Excellent,false excel,Excel.LinkedEntityDataDomainCollection,"refreshAll()",Method,Great,false excel,Excel.LinkedEntityDataDomainCollection,"toJSON()",Method,Excellent,false excel,Excel.LinkedEntityDataDomainCreateOptions,N/A,Interface,Good,false @@ -5618,6 +5630,7 @@ excel,Excel.ReplaceCriteria,"matchCase",Property,Excellent,false excel,Excel.RequestContext,N/A,Class,Great,true excel,Excel.RequestContext,"application",Property,Missing,false excel,Excel.RequestContext,"runtime",Property,Great,false +excel,Excel.RequestContext,"sensitivityLabelsCatalog",Property,Great,false excel,Excel.RequestContext,"workbook",Property,Missing,false excel,Excel.RequestContext,"setInvocation(invocation)",Method,Missing,false excel,Excel.RibbonTab,N/A,Enum,Missing,false @@ -5700,6 +5713,59 @@ excel,Excel.SearchDirection,"backwards",EnumField,Great,false excel,Excel.SearchDirection,"forward",EnumField,Great,false excel,Excel.SelectionChangedEventArgs,N/A,Interface,Fine,false excel,Excel.SelectionChangedEventArgs,"workbook",Property,Great,false +excel,Excel.SensitivityLabel,N/A,Class,Fine,false +excel,Excel.SensitivityLabel,"context",Property,Excellent,false +excel,Excel.SensitivityLabel,"getCurrentOrNullObject()",Method,Excellent,false +excel,Excel.SensitivityLabel,"toJSON()",Method,Excellent,false +excel,Excel.SensitivityLabel,"tryToUpdate(labelId)",Method,Fine,false +excel,Excel.SensitivityLabelDetails,N/A,Class,Fine,false +excel,Excel.SensitivityLabelDetails,"children",Property,Excellent,false +excel,Excel.SensitivityLabelDetails,"color",Property,Great,false +excel,Excel.SensitivityLabelDetails,"context",Property,Excellent,false +excel,Excel.SensitivityLabelDetails,"id",Property,Great,false +excel,Excel.SensitivityLabelDetails,"isEnabled",Property,Great,false +excel,Excel.SensitivityLabelDetails,"name",Property,Good,false +excel,Excel.SensitivityLabelDetails,"order",Property,Great,false +excel,Excel.SensitivityLabelDetails,"protectionType",Property,Great,false +excel,Excel.SensitivityLabelDetails,"siteId",Property,Excellent,false +excel,Excel.SensitivityLabelDetails,"tooltip",Property,Great,false +excel,Excel.SensitivityLabelDetails,"load(options)",Method,Great,false +excel,Excel.SensitivityLabelDetails,"load(propertyNames)",Method,Great,false +excel,Excel.SensitivityLabelDetails,"load(propertyNamesAndPaths)",Method,Great,false +excel,Excel.SensitivityLabelDetails,"toJSON()",Method,Excellent,false +excel,Excel.SensitivityLabelDetailsCollection,N/A,Class,Good,false +excel,Excel.SensitivityLabelDetailsCollection,"context",Property,Excellent,false +excel,Excel.SensitivityLabelDetailsCollection,"items",Property,Great,false +excel,Excel.SensitivityLabelDetailsCollection,"getFirst()",Method,Excellent,false +excel,Excel.SensitivityLabelDetailsCollection,"getFirstOrNullObject()",Method,Excellent,false +excel,Excel.SensitivityLabelDetailsCollection,"load(options)",Method,Great,false +excel,Excel.SensitivityLabelDetailsCollection,"load(propertyNames)",Method,Great,false +excel,Excel.SensitivityLabelDetailsCollection,"load(propertyNamesAndPaths)",Method,Great,false +excel,Excel.SensitivityLabelDetailsCollection,"toJSON()",Method,Excellent,false +excel,Excel.SensitivityLabelProtectionType,N/A,Enum,Good,false +excel,Excel.SensitivityLabelProtectionType,"adminDefined",EnumField,Great,false +excel,Excel.SensitivityLabelProtectionType,"noProtection",EnumField,Great,false +excel,Excel.SensitivityLabelProtectionType,"userDefined",EnumField,Great,false +excel,Excel.SensitivityLabelsCatalog,N/A,Class,Great,false +excel,Excel.SensitivityLabelsCatalog,"context",Property,Excellent,false +excel,Excel.SensitivityLabelsCatalog,"getLabelingCapability",Property,Great,false +excel,Excel.SensitivityLabelsCatalog,"getLabels()",Method,Fine,false +excel,Excel.SensitivityLabelsCatalog,"load(options)",Method,Great,false +excel,Excel.SensitivityLabelsCatalog,"load(propertyNames)",Method,Great,false +excel,Excel.SensitivityLabelsCatalog,"load(propertyNamesAndPaths)",Method,Great,false +excel,Excel.SensitivityLabelsCatalog,"toJSON()",Method,Excellent,false +excel,Excel.SensitivityLabelUpdateResult,N/A,Enum,Great,false +excel,Excel.SensitivityLabelUpdateResult,"crossTenant",EnumField,Great,false +excel,Excel.SensitivityLabelUpdateResult,"documentReadOnly",EnumField,Great,false +excel,Excel.SensitivityLabelUpdateResult,"insufficientPermission",EnumField,Great,false +excel,Excel.SensitivityLabelUpdateResult,"labelingDisabled",EnumField,Great,false +excel,Excel.SensitivityLabelUpdateResult,"labelNotFound",EnumField,Great,false +excel,Excel.SensitivityLabelUpdateResult,"parentLabelNotSupported",EnumField,Great,false +excel,Excel.SensitivityLabelUpdateResult,"success",EnumField,Great,false +excel,Excel.SensitivityLabelUpdateResult,"unspecifiedFailure",EnumField,Excellent,false +excel,Excel.SensitivityLabelUpdateResult,"unsupportedDoubleKeyEncryption",EnumField,Great,false +excel,Excel.SensitivityLabelUpdateResult,"unsupportedUdp",EnumField,Great,false +excel,Excel.SensitivityLabelUpdateResult,"userNotFound",EnumField,Great,false excel,Excel.Session,N/A,Interface,Missing,false excel,Excel.SettableCellProperties,N/A,Interface,Great,false excel,Excel.SettableCellProperties,"format",Property,Great,false @@ -6814,6 +6880,7 @@ excel,Excel.Workbook,"properties",Property,Good,true excel,Excel.Workbook,"protection",Property,Great,false excel,Excel.Workbook,"queries",Property,Great,false excel,Excel.Workbook,"readOnly",Property,Great,false +excel,Excel.Workbook,"sensitivityLabel",Property,Great,false excel,Excel.Workbook,"settings",Property,Great,false excel,Excel.Workbook,"showPivotFieldList",Property,Excellent,false excel,Excel.Workbook,"slicers",Property,Great,false @@ -7138,8 +7205,6 @@ excel,Excel.WorksheetVisibilityChangedEventArgs,"visibilityBefore",Property,Exce excel,Excel.WorksheetVisibilityChangedEventArgs,"worksheetId",Property,Great,false excel,N/A,N/A,Package,Missing,false excel,N/A,"Excel.createWorkbook(base64)",Method,Excellent,true -excel,N/A,"Excel.getDataCommonPostprocess(response, callArgs)",Method,Missing,false -excel,N/A,"Excel.postprocessBindingDescriptor(response)",Method,Missing,false excel,N/A,"Excel.run(batch)",Method,Excellent,true excel,N/A,"Excel.run(object, batch)",Method,Excellent,false excel,N/A,"Excel.run(objects, batch)",Method,Great,false @@ -13606,6 +13671,7 @@ word,Word.Document,"saveEncoding",Property,Great,false word,Word.Document,"saveFormat",Property,Good,false word,Word.Document,"sections",Property,Great,false word,Word.Document,"selection",Property,Excellent,true +word,Word.Document,"sensitivityLabel",Property,Great,false word,Word.Document,"sentences",Property,Excellent,false word,Word.Document,"settings",Property,Great,true word,Word.Document,"spellingErrors",Property,Excellent,false @@ -15154,6 +15220,11 @@ word,Word.JustificationMode,"expand",EnumField,Great,false word,Word.Kana,N/A,Enum,Fine,false word,Word.Kana,"hiragana",EnumField,Great,false word,Word.Kana,"katakana",EnumField,Great,false +word,Word.LabelingCapability,N/A,Enum,Great,false +word,Word.LabelingCapability,"labelingDisabled",EnumField,Great,false +word,Word.LabelingCapability,"labelingEnabled",EnumField,Great,false +word,Word.LabelingCapability,"labelingPolicyNotFound",EnumField,Great,false +word,Word.LabelingCapability,"noLicense",EnumField,Great,false word,Word.LanguageId,N/A,Enum,Good,true word,Word.LanguageId,"afrikaans",EnumField,Great,false word,Word.LanguageId,"albanian",EnumField,Great,false @@ -17035,6 +17106,7 @@ word,Word.RepeatingSectionItemCollection,"untrack()",Method,Excellent,false word,Word.RequestContext,N/A,Class,Great,true word,Word.RequestContext,"application",Property,Great,false word,Word.RequestContext,"document",Property,Missing,false +word,Word.RequestContext,"sensitivityLabelsCatalog",Property,Missing,false word,Word.Reviewer,N/A,Class,Good,false word,Word.Reviewer,"context",Property,Excellent,false word,Word.Reviewer,"isVisible",Property,Great,false @@ -17441,6 +17513,71 @@ word,Word.SelectNodesOptions,"prefixMapping",Property,Excellent,false word,Word.SelectSingleNodeOptions,N/A,Interface,Good,false word,Word.SelectSingleNodeOptions,"fastSearchSkippingTextNodes",Property,Excellent,false word,Word.SelectSingleNodeOptions,"prefixMapping",Property,Excellent,false +word,Word.SensitivityLabel,N/A,Class,Fine,false +word,Word.SensitivityLabel,"context",Property,Excellent,false +word,Word.SensitivityLabel,"getCurrentOrNullObject()",Method,Fine,false +word,Word.SensitivityLabel,"load(propertyNames)",Method,Great,false +word,Word.SensitivityLabel,"load(propertyNamesAndPaths)",Method,Great,false +word,Word.SensitivityLabel,"toJSON()",Method,Excellent,false +word,Word.SensitivityLabel,"track()",Method,Excellent,false +word,Word.SensitivityLabel,"tryToUpdate(LabelId, Justification)",Method,Fine,false +word,Word.SensitivityLabel,"untrack()",Method,Excellent,false +word,Word.SensitivityLabelDetails,N/A,Class,Fine,false +word,Word.SensitivityLabelDetails,"children",Property,Excellent,false +word,Word.SensitivityLabelDetails,"color",Property,Good,false +word,Word.SensitivityLabelDetails,"context",Property,Excellent,false +word,Word.SensitivityLabelDetails,"id",Property,Great,false +word,Word.SensitivityLabelDetails,"isEnabled",Property,Great,false +word,Word.SensitivityLabelDetails,"name",Property,Good,false +word,Word.SensitivityLabelDetails,"order",Property,Good,false +word,Word.SensitivityLabelDetails,"protectionType",Property,Great,false +word,Word.SensitivityLabelDetails,"siteId",Property,Excellent,false +word,Word.SensitivityLabelDetails,"tooltip",Property,Great,false +word,Word.SensitivityLabelDetails,"load(options)",Method,Great,false +word,Word.SensitivityLabelDetails,"load(propertyNames)",Method,Great,false +word,Word.SensitivityLabelDetails,"load(propertyNamesAndPaths)",Method,Great,false +word,Word.SensitivityLabelDetails,"toJSON()",Method,Excellent,false +word,Word.SensitivityLabelDetails,"track()",Method,Excellent,false +word,Word.SensitivityLabelDetails,"untrack()",Method,Excellent,false +word,Word.SensitivityLabelDetailsCollection,N/A,Class,Good,false +word,Word.SensitivityLabelDetailsCollection,"context",Property,Excellent,false +word,Word.SensitivityLabelDetailsCollection,"items",Property,Great,false +word,Word.SensitivityLabelDetailsCollection,"getFirst()",Method,Excellent,false +word,Word.SensitivityLabelDetailsCollection,"getFirstOrNullObject()",Method,Excellent,false +word,Word.SensitivityLabelDetailsCollection,"getItem(index)",Method,Fine,false +word,Word.SensitivityLabelDetailsCollection,"load(options)",Method,Great,false +word,Word.SensitivityLabelDetailsCollection,"load(propertyNames)",Method,Great,false +word,Word.SensitivityLabelDetailsCollection,"load(propertyNamesAndPaths)",Method,Great,false +word,Word.SensitivityLabelDetailsCollection,"toJSON()",Method,Excellent,false +word,Word.SensitivityLabelDetailsCollection,"track()",Method,Excellent,false +word,Word.SensitivityLabelDetailsCollection,"untrack()",Method,Excellent,false +word,Word.SensitivityLabelProtectionType,N/A,Enum,Good,false +word,Word.SensitivityLabelProtectionType,"adminDefined",EnumField,Great,false +word,Word.SensitivityLabelProtectionType,"noProtection",EnumField,Great,false +word,Word.SensitivityLabelProtectionType,"userDefined",EnumField,Great,false +word,Word.SensitivityLabelsCatalog,N/A,Class,Great,false +word,Word.SensitivityLabelsCatalog,"context",Property,Excellent,false +word,Word.SensitivityLabelsCatalog,"getLabelingCapability",Property,Great,false +word,Word.SensitivityLabelsCatalog,"getLabels()",Method,Fine,false +word,Word.SensitivityLabelsCatalog,"load(options)",Method,Great,false +word,Word.SensitivityLabelsCatalog,"load(propertyNames)",Method,Great,false +word,Word.SensitivityLabelsCatalog,"load(propertyNamesAndPaths)",Method,Great,false +word,Word.SensitivityLabelsCatalog,"newObject(context)",Method,Fine,false +word,Word.SensitivityLabelsCatalog,"toJSON()",Method,Excellent,false +word,Word.SensitivityLabelsCatalog,"track()",Method,Excellent,false +word,Word.SensitivityLabelsCatalog,"untrack()",Method,Excellent,false +word,Word.SensitivityLabelUpdateResult,N/A,Enum,Great,false +word,Word.SensitivityLabelUpdateResult,"crossTenant",EnumField,Great,false +word,Word.SensitivityLabelUpdateResult,"documentReadOnly",EnumField,Great,false +word,Word.SensitivityLabelUpdateResult,"insufficientPermission",EnumField,Great,false +word,Word.SensitivityLabelUpdateResult,"labelingDisabled",EnumField,Great,false +word,Word.SensitivityLabelUpdateResult,"labelNotFound",EnumField,Great,false +word,Word.SensitivityLabelUpdateResult,"parentLabelNotSupported",EnumField,Great,false +word,Word.SensitivityLabelUpdateResult,"success",EnumField,Great,false +word,Word.SensitivityLabelUpdateResult,"unspecifiedFailure",EnumField,Excellent,false +word,Word.SensitivityLabelUpdateResult,"unsupportedDoubleKeyEncryption",EnumField,Great,false +word,Word.SensitivityLabelUpdateResult,"unsupportedUdp",EnumField,Great,false +word,Word.SensitivityLabelUpdateResult,"userNotFound",EnumField,Great,false word,Word.Setting,N/A,Class,Fine,true word,Word.Setting,"context",Property,Excellent,false word,Word.Setting,"key",Property,Good,true diff --git a/generate-docs/api-extractor-inputs-excel/excel.d.ts b/generate-docs/api-extractor-inputs-excel/excel.d.ts index 0c86aa8796..32f5595acf 100644 --- a/generate-docs/api-extractor-inputs-excel/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel/excel.d.ts @@ -4,7 +4,6 @@ import { Office as Outlook} from "../api-extractor-inputs-outlook/outlook" /////////////////////// Begin Excel APIs /////////////////////// //////////////////////////////////////////////////////////////// - export declare namespace Excel { /** * Represents an unknown cell control. @@ -9177,6 +9176,10 @@ export declare namespace Excel { * [Api set: ExcelApi 1.5] */ readonly runtime: Runtime; + /** + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + */ + readonly sensitivityLabelsCatalog: SensitivityLabelsCatalog; } export interface RunOptions extends OfficeExtension.RunOptions { /** @@ -9227,8 +9230,416 @@ export declare namespace Excel { * @param batch - A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the RequestContext is required to get access to the Excel object model from the add-in. */ export function run(context: OfficeExtension.ClientRequestContext, batch: (context: Excel.RequestContext) => Promise): Promise; - export function postprocessBindingDescriptor(response: any): any; - export function getDataCommonPostprocess(response: any, callArgs: any): any; + /** + * Represents the labeling capability status of the sensitivity label catalog. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LabelingCapability { + /** + * No valid license is available for sensitivity labeling. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + noLicense = "NoLicense", + /** + * Sensitivity labeling is disabled for the user or tenant. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + labelingDisabled = "LabelingDisabled", + /** + * No labeling policy was found for the user. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + labelingPolicyNotFound = "LabelingPolicyNotFound", + /** + * Sensitivity labeling is fully enabled. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + labelingEnabled = "LabelingEnabled" + } + /** + * Represents the sensitivity label on the workbook. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + export class SensitivityLabel extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets the current label information that exists on the workbook for the user. + If there's no sensitivity label on the current workbook, an object with an `isNullObject` property set to `true` is returned. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + * @returns The current `SensitivityLabelDetails` object. + */ + getCurrentOrNullObject(): Excel.SensitivityLabelDetails; + /** + * Tries to update to the provided sensitivity label on the workbook for the user. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + * + * @param labelId - The ID of the label to apply. + * @returns The `SensitivityLabelUpdateResult` object. + */ + tryToUpdate(labelId: string): OfficeExtension.ClientResult; + /** + * 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.SensitivityLabel` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.SensitivityLabelData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): { + [key: string]: string; + }; + } + /** + * Represents the properties of available sensitivity labels in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + export class SensitivityLabelDetails extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets the sublabels of the sensitivity label. Returns `null` if a label doesn't have any sublabels. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly children: SensitivityLabelDetailsCollection | null; + /** + * Gets the color of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly color: string; + /** + * Gets the unique identifier (GUID) of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly id: string; + /** + * Gets a value indicating whether the label is enabled. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isEnabled: boolean; + /** + * Gets the name of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly name: string; + /** + * Gets the priority of the sensitivity label, with 0 as lowest priority. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly order: number; + /** + * Gets a value indicating the protection type provided by this label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly protectionType: Excel.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined"; + /** + * Gets the unique identifier (GUID) of the tenant which the sensitivity label is belonged. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly siteId: string; + /** + * Gets the description of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly tooltip: string; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.SensitivityLabelDetailsLoadOptions): Excel.SensitivityLabelDetails; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.SensitivityLabelDetails; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `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. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.SensitivityLabelDetails; + /** + * 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.SensitivityLabelDetails` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.SensitivityLabelDetailsData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.SensitivityLabelDetailsData; + } + /** + * Represents the collection of {@link Excel.SensitivityLabelDetails} objects. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + export class SensitivityLabelDetailsCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.SensitivityLabelDetails[]; + /** + * Gets the first `SensitivityLabelDetails` object in this collection. Throws an `ItemNotFound` error if this collection is empty. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + * @returns A new `SensitivityLabelDetails` object. + */ + getFirst(): Excel.SensitivityLabelDetails; + /** + * 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 {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + * @returns The new `SensitivityLabelDetails` object. + */ + getFirstOrNullObject(): OfficeExtension.ClientResult; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.SensitivityLabelDetailsCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SensitivityLabelDetailsCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.SensitivityLabelDetailsCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.SensitivityLabelDetailsCollection; + /** + * 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; + } + /** + * Represents the protection type. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SensitivityLabelProtectionType { + /** + * No protection is applied by this label. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + noProtection = "NoProtection", + /** + * Protection is defined by an administrator. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + adminDefined = "AdminDefined", + /** + * Protection is defined by the user. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + userDefined = "UserDefined" + } + /** + * Represents the result of updating the sensitivity label on the workbook. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SensitivityLabelUpdateResult { + /** + * The sensitivity label was successfully updated. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + success = "Success", + /** + * The update failed due to an unspecified error. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + unspecifiedFailure = "UnspecifiedFailure", + /** + * The specified sensitivity label could not be found. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + labelNotFound = "LabelNotFound", + /** + * The document is read-only and cannot be modified. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + documentReadOnly = "DocumentReadOnly", + /** + * The user does not have sufficient permissions to update the label. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + insufficientPermission = "InsufficientPermission", + /** + * The label update failed due to unsupported Double Key Encryption (DKE). + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + unsupportedDoubleKeyEncryption = "UnsupportedDoubleKeyEncryption", + /** + * The label update failed because native labeling is not enabled for the user or installed SKU. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + labelingDisabled = "LabelingDisabled", + /** + * The label update failed because the user's identity is not valid for applying a label. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + userNotFound = "UserNotFound", + /** + * The label update failed due to unsupported User Defined Permissions (UDP). + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + unsupportedUdp = "UnsupportedUdp", + /** + * The label update failed because the specified label is a parent label, which cannot be applied. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + parentLabelNotSupported = "ParentLabelNotSupported", + /** + * The label update failed because the document doesn't belong to the same tenant as the user. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + crossTenant = "CrossTenant" + } + /** + * Provides methods to check the status of the catalog of sensitivity labels in Excel and retrieve all available sensitivity labels if the catalog is enabled. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + export class SensitivityLabelsCatalog extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets whether the catalog of sensitivity labels is enabled in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly getLabelingCapability: Excel.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled"; + /** + * Gets sensitivity labels that are available to the current user. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + * @returns The current `SensitivityLabelDetailsCollection` object. + */ + getLabels(): Excel.SensitivityLabelDetailsCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.SensitivityLabelsCatalogLoadOptions): Excel.SensitivityLabelsCatalog; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.SensitivityLabelsCatalog; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `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. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.SensitivityLabelsCatalog; + /** + * 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.SensitivityLabelsCatalog` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.SensitivityLabelsCatalogData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.SensitivityLabelsCatalogData; + } /** * Provides information about the ranges that raised the `onCalculationBusy` event, which triggers when the calculation is in progress in a worksheet. * @@ -14508,6 +14919,14 @@ export declare namespace Excel { * [Api set: ExcelApi 1.1] */ readonly worksheets: Excel.WorksheetCollection; + /** + * Returns the sensitivity label of the workbook. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly sensitivityLabel: Excel.SensitivityLabel; /** * Specifies if the workbook is in AutoSave mode. * @@ -35896,6 +36315,55 @@ export declare namespace Excel { */ toJSON(): Excel.Interfaces.SlicerItemCollectionData; } + /** + * Provides information about the `LinkedEntityCellValue` that was requested given a specified `LinkedEntityId`. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface LinkedEntityCellValueLoadedEventArgs { + /** + * Any error encountered during the request to load the `LinkedEntityCellValue`. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + error?: string; + /** + * Gets the `LinkedEntityId` of the requested `LinkedEntityCellValue`. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + id: LinkedEntityId; + /** + * Gets the `LinkedEntityCellValue` of the requested `LinkedEntityId`. If the load operation failed, this property is `null`. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + linkedEntityCellValue?: LinkedEntityCellValue; + /** + * Gets the source of the event. See `Excel.EventSource` for details. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + source: Excel.EventSource | "Local" | "Remote"; + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + type: "LinkedEntityDataDomainLinkedEntityCellValueLoaded"; + } /** * Represents a specific category or field of information that shares some common characteristics or attributes. A data domain is linked to a data provider, that acts as the data source for `LinkedEntityCellValue` objects in the workbook. @@ -36196,6 +36664,17 @@ export declare namespace Excel { * @returns The linked entity data domain with the given `id`. If there are multiple linked entity data domains with the same `id`, the one defined by this Office Add-in will be returned. */ getItemOrNullObject(id: string): Excel.LinkedEntityDataDomain; + /** + * Submits a request to load the `LinkedEntityCellValue` object with the specified `LinkedEntityId`. + If found, the `LinkedEntityCellValue` object will be returned through the `LinkedEntityCellValueLoaded` event. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + * + * @param id - A specific `LinkedEntityId` + */ + loadLinkedEntityCellValue(id: LinkedEntityId): void; /** * Refreshes all `LinkedEntityCellValue` objects of all linked entity data domains in this collection. The refresh request can fail if the data providers are busy or temporarily inaccessible. @@ -36224,6 +36703,16 @@ export declare namespace Excel { * @param propertyNamesAndPaths - `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. */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.LinkedEntityDataDomainCollection; + /** + * Occurs when the request to load a `LinkedEntityCellValue` is completed. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * + * @eventproperty + * @beta + */ + readonly onLinkedEntityCellValueLoaded: OfficeExtension.EventHandlers; /** * Occurs when a new linked entity data domain is added to the workbook. * @@ -48572,6 +49061,10 @@ export declare namespace Excel { */ $skip?: number; } + /** An interface for updating data on the `SensitivityLabelDetailsCollection` object, for use in `sensitivityLabelDetailsCollection.set({ ... })`. */ + export interface SensitivityLabelDetailsCollectionUpdateData { + items?: Excel.Interfaces.SensitivityLabelDetailsData[]; + } /** An interface for updating data on the `AllowEditRange` object, for use in `allowEditRange.set({ ... })`. */ export interface AllowEditRangeUpdateData { /** @@ -54225,6 +54718,96 @@ export declare namespace Excel { export interface PaneCollectionUpdateData { items?: Excel.Interfaces.PaneData[]; } + /** An interface describing the data returned by calling `sensitivityLabelDetails.toJSON()`. */ + export interface SensitivityLabelDetailsData { + /** + * Gets the sublabels of the sensitivity label. Returns `null` if a label doesn't have any sublabels. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + children?: SensitivityLabelDetailsCollection | null; + /** + * Gets the color of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: string; + /** + * Gets the unique identifier (GUID) of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: string; + /** + * Gets a value indicating whether the label is enabled. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + isEnabled?: boolean; + /** + * Gets the name of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: string; + /** + * Gets the priority of the sensitivity label, with 0 as lowest priority. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + order?: number; + /** + * Gets a value indicating the protection type provided by this label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + protectionType?: Excel.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined"; + /** + * Gets the unique identifier (GUID) of the tenant which the sensitivity label is belonged. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + siteId?: string; + /** + * Gets the description of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + tooltip?: string; + } + /** An interface describing the data returned by calling `sensitivityLabelDetailsCollection.toJSON()`. */ + export interface SensitivityLabelDetailsCollectionData { + items?: Excel.Interfaces.SensitivityLabelDetailsData[]; + } + /** An interface describing the data returned by calling `sensitivityLabelsCatalog.toJSON()`. */ + export interface SensitivityLabelsCatalogData { + /** + * Gets whether the catalog of sensitivity labels is enabled in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + getLabelingCapability?: Excel.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled"; + } /** An interface describing the data returned by calling `allowEditRange.toJSON()`. */ export interface AllowEditRangeData { /** @@ -62017,6 +62600,197 @@ export declare namespace Excel { */ value?: T; } + /** + * Represents the properties of available sensitivity labels in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface SensitivityLabelDetailsLoadOptions { + /** + 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; + /** + * Gets the sublabels of the sensitivity label. Returns `null` if a label doesn't have any sublabels. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + children?: boolean; + /** + * Gets the color of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: boolean; + /** + * Gets the unique identifier (GUID) of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: boolean; + /** + * Gets a value indicating whether the label is enabled. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + isEnabled?: boolean; + /** + * Gets the name of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: boolean; + /** + * Gets the priority of the sensitivity label, with 0 as lowest priority. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + order?: boolean; + /** + * Gets a value indicating the protection type provided by this label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + protectionType?: boolean; + /** + * Gets the unique identifier (GUID) of the tenant which the sensitivity label is belonged. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + siteId?: boolean; + /** + * Gets the description of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + tooltip?: boolean; + } + /** + * Represents the collection of {@link Excel.SensitivityLabelDetails} objects. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface SensitivityLabelDetailsCollectionLoadOptions { + /** + 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; + /** + * For EACH ITEM in the collection: Gets the sublabels of the sensitivity label. Returns `null` if a label doesn't have any sublabels. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + children?: boolean; + /** + * For EACH ITEM in the collection: Gets the color of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: boolean; + /** + * For EACH ITEM in the collection: Gets the unique identifier (GUID) of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: boolean; + /** + * For EACH ITEM in the collection: Gets a value indicating whether the label is enabled. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + isEnabled?: boolean; + /** + * For EACH ITEM in the collection: Gets the name of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: boolean; + /** + * For EACH ITEM in the collection: Gets the priority of the sensitivity label, with 0 as lowest priority. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + order?: boolean; + /** + * For EACH ITEM in the collection: Gets a value indicating the protection type provided by this label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + protectionType?: boolean; + /** + * For EACH ITEM in the collection: Gets the unique identifier (GUID) of the tenant which the sensitivity label is belonged. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + siteId?: boolean; + /** + * For EACH ITEM in the collection: Gets the description of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + tooltip?: boolean; + } + /** + * Provides methods to check the status of the catalog of sensitivity labels in Excel and retrieve all available sensitivity labels if the catalog is enabled. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface SensitivityLabelsCatalogLoadOptions { + /** + 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; + /** + * Gets whether the catalog of sensitivity labels is enabled in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + getLabelingCapability?: boolean; + } /** * Represents an `AllowEditRange` object found in a worksheet. This object works with worksheet protection properties. When worksheet protection is enabled, an `AllowEditRange` object can be used to allow editing of a specific range, while maintaining protection on the rest of the worksheet. diff --git a/generate-docs/api-extractor-inputs-word/word.d.ts b/generate-docs/api-extractor-inputs-word/word.d.ts index eceffba0e9..19213b58d7 100644 --- a/generate-docs/api-extractor-inputs-word/word.d.ts +++ b/generate-docs/api-extractor-inputs-word/word.d.ts @@ -6527,6 +6527,14 @@ export declare namespace Word { * [Api set: WordApiDesktop 1.4] */ readonly selection: Word.Selection; + /** + * Returns the sensitivity label of the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly sensitivityLabel: Word.SensitivityLabel; /** * Gets the `RangeScopedCollection` object that represents all the sentences in the document. * @@ -15124,6 +15132,318 @@ export declare namespace Word { */ toJSON(): Word.Interfaces.SectionCollectionData; } + /** + * Represents the sensitivity label on the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class SensitivityLabel extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets the current label information that exists on the document for the user. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getCurrentOrNullObject(): Word.SensitivityLabelDetails; + /** + * Try to update to the provided sensitivity label on the document for the user. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param LabelId - The label information that needs to be set on the document. + * @param Justification - Optional. The justification of changing the label. + */ + tryToUpdate(LabelId: string, Justification?: string): OfficeExtension.ClientResult; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.SensitivityLabel; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `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. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.SensitivityLabel; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.SensitivityLabel; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.SensitivityLabel; + /** + * 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 `Word.SensitivityLabel` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SensitivityLabelData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): { + [key: string]: string; + }; + } + /** + * Provides methods to check the status of the catalog of sensitivity labels in Word and retrieve all available sensitivity labels if the catalog is enabled. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class SensitivityLabelsCatalog extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets the labeling capability status of the sensitivity label catalog in Word. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly getLabelingCapability: Word.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled"; + /** + * Gets all the sensitivity labels that are enabled in Word. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getLabels(): Word.SensitivityLabelDetailsCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.SensitivityLabelsCatalogLoadOptions): Word.SensitivityLabelsCatalog; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.SensitivityLabelsCatalog; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `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. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.SensitivityLabelsCatalog; + /** + * Create a new instance of the `Word.SensitivityLabelsCatalog` object. + */ + static newObject(context: OfficeExtension.ClientRequestContext): Word.SensitivityLabelsCatalog; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.SensitivityLabelsCatalog; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.SensitivityLabelsCatalog; + /** + * 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 `Word.SensitivityLabelsCatalog` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SensitivityLabelsCatalogData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.SensitivityLabelsCatalogData; + } + /** + * Represents the collection of {@link Word.SensitivityLabelDetails} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class SensitivityLabelDetailsCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.SensitivityLabelDetails[]; + /** + * Gets the first `SensitivityLabelDetails` object in this collection. Throws an `ItemNotFound` error if this collection is empty. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getFirst(): Word.SensitivityLabelDetails; + /** + * 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 {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getFirstOrNullObject(): Word.SensitivityLabelDetails; + /** + * Gets a `SensitivityLabelDetails` object by its index in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index - A number that identifies the index location of a `SensitivityLabelDetails` object. + */ + getItem(index: number): Word.SensitivityLabelDetails; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.SensitivityLabelDetailsCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SensitivityLabelDetailsCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.SensitivityLabelDetailsCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.SensitivityLabelDetailsCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.SensitivityLabelDetailsCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.SensitivityLabelDetailsCollection; + /** + * 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 `Word.SensitivityLabelDetailsCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SensitivityLabelDetailsCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.SensitivityLabelDetailsCollectionData; + } + /** + * Represents the properties of available sensitivity labels in Word. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class SensitivityLabelDetails extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * The sublabels of the sensitivity label. Returns null if a label doesn't have any sublabels. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly children: Word.SensitivityLabelDetailsCollection; + /** + * The color of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly color: string; + /** + * The unique identifier (GUID) of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly id: string; + /** + * Gets a value indicating whether the label is enabled. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isEnabled: boolean; + /** + * The name of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly name: string; + /** + * The order of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly order: number; + /** + * Gets a value indicating the protection type provided by this label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly protectionType: Word.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined"; + /** + * The unique identifier (GUID) of the tenant which the sensitivity label is belonged. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly siteId: string; + /** + * The description of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly tooltip: string; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.SensitivityLabelDetailsLoadOptions): Word.SensitivityLabelDetails; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.SensitivityLabelDetails; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `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. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.SensitivityLabelDetails; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.SensitivityLabelDetails; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.SensitivityLabelDetails; + /** + * 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 `Word.SensitivityLabelDetails` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SensitivityLabelDetailsData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.SensitivityLabelDetailsData; + } /** * Represents a setting of the add-in. * @@ -47281,6 +47601,159 @@ export declare namespace Word { */ owners = "Owners", } + /** + * Represents the result of updating the sensitivity label on the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SensitivityLabelUpdateResult { + /** + * The sensitivity label was successfully updated. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + success = "Success", + /** + * The update failed due to an unspecified error. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + unspecifiedFailure = "UnspecifiedFailure", + /** + * The specified sensitivity label could not be found. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + labelNotFound = "LabelNotFound", + /** + * The document is read-only and cannot be modified. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + documentReadOnly = "DocumentReadOnly", + /** + * The user does not have sufficient permissions to update the label. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insufficientPermission = "InsufficientPermission", + /** + * The label update failed due to unsupported Double Key Encryption (DKE). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + unsupportedDoubleKeyEncryption = "UnsupportedDoubleKeyEncryption", + /** + * The label update failed because native labeling is not enabled for the user or installed SKU. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + labelingDisabled = "LabelingDisabled", + /** + * The label update failed because the user's identity is not valid for applying a label. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + userNotFound = "UserNotFound", + /** + * The label update failed due to unsupported Universal Data Protection (UDP). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + unsupportedUdp = "UnsupportedUdp", + /** + * The label update failed because the specified label is a parent label, which cannot be applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + parentLabelNotSupported = "ParentLabelNotSupported", + /** + * The label update failed because the document doesn't belong to the same tenant as the user. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + crossTenant = "CrossTenant", + } + /** + * Represents the labeling capability status of the sensitivity label catalog. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LabelingCapability { + /** + * No valid license is available for sensitivity labeling. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + noLicense = "NoLicense", + /** + * Sensitivity labeling is disabled for the user or tenant. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + labelingDisabled = "LabelingDisabled", + /** + * No labeling policy was found for the user. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + labelingPolicyNotFound = "LabelingPolicyNotFound", + /** + * Sensitivity labeling is fully enabled. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + labelingEnabled = "LabelingEnabled", + } + /** + * Specifies the type of protection applied by a sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SensitivityLabelProtectionType { + /** + * The label applies no protection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + noProtection = "NoProtection", + /** + * The label applies admin-defined protection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + adminDefined = "AdminDefined", + /** + * The label applies user-defined protection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + userDefined = "UserDefined", + } enum ErrorCodes { accessDenied = "AccessDenied", generalException = "GeneralException", @@ -50019,6 +50492,10 @@ export declare namespace Word { export interface SectionCollectionUpdateData { items?: Word.Interfaces.SectionData[]; } + /** An interface for updating data on the `SensitivityLabelDetailsCollection` object, for use in `sensitivityLabelDetailsCollection.set({ ... })`. */ + export interface SensitivityLabelDetailsCollectionUpdateData { + items?: Word.Interfaces.SensitivityLabelDetailsData[]; + } /** An interface for updating data on the `Setting` object, for use in `setting.set({ ... })`. */ export interface SettingUpdateData { /** @@ -57484,6 +57961,96 @@ export declare namespace Word { export interface SectionCollectionData { items?: Word.Interfaces.SectionData[]; } + /** An interface describing the data returned by calling `sensitivityLabelsCatalog.toJSON()`. */ + export interface SensitivityLabelsCatalogData { + /** + * Gets the labeling capability status of the sensitivity label catalog in Word. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getLabelingCapability?: Word.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled"; + } + /** An interface describing the data returned by calling `sensitivityLabelDetailsCollection.toJSON()`. */ + export interface SensitivityLabelDetailsCollectionData { + items?: Word.Interfaces.SensitivityLabelDetailsData[]; + } + /** An interface describing the data returned by calling `sensitivityLabelDetails.toJSON()`. */ + export interface SensitivityLabelDetailsData { + /** + * The sublabels of the sensitivity label. Returns null if a label doesn't have any sublabels. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + children?: Word.Interfaces.SensitivityLabelDetailsData[]; + /** + * The color of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: string; + /** + * The unique identifier (GUID) of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: string; + /** + * Gets a value indicating whether the label is enabled. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isEnabled?: boolean; + /** + * The name of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: string; + /** + * The order of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + order?: number; + /** + * Gets a value indicating the protection type provided by this label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + protectionType?: Word.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined"; + /** + * The unique identifier (GUID) of the tenant which the sensitivity label is belonged. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + siteId?: string; + /** + * The description of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tooltip?: string; + } /** An interface describing the data returned by calling `setting.toJSON()`. */ export interface SettingData { /** @@ -68764,6 +69331,181 @@ export declare namespace Word { */ protectedForForms?: boolean; } + /** + * Provides methods to check the status of the catalog of sensitivity labels in Word and retrieve all available sensitivity labels if the catalog is enabled. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface SensitivityLabelsCatalogLoadOptions { + /** + 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; + /** + * Gets the labeling capability status of the sensitivity label catalog in Word. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getLabelingCapability?: boolean; + } + /** + * Represents the collection of {@link Word.SensitivityLabelDetails} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface SensitivityLabelDetailsCollectionLoadOptions { + /** + 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; + /** + * For EACH ITEM in the collection: The color of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: boolean; + /** + * For EACH ITEM in the collection: The unique identifier (GUID) of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: boolean; + /** + * For EACH ITEM in the collection: Gets a value indicating whether the label is enabled. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isEnabled?: boolean; + /** + * For EACH ITEM in the collection: The name of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: boolean; + /** + * For EACH ITEM in the collection: The order of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + order?: boolean; + /** + * For EACH ITEM in the collection: Gets a value indicating the protection type provided by this label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + protectionType?: boolean; + /** + * For EACH ITEM in the collection: The unique identifier (GUID) of the tenant which the sensitivity label is belonged. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + siteId?: boolean; + /** + * For EACH ITEM in the collection: The description of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tooltip?: boolean; + } + /** + * Represents the properties of available sensitivity labels in Word. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface SensitivityLabelDetailsLoadOptions { + /** + 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; + /** + * The color of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: boolean; + /** + * The unique identifier (GUID) of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: boolean; + /** + * Gets a value indicating whether the label is enabled. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isEnabled?: boolean; + /** + * The name of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: boolean; + /** + * The order of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + order?: boolean; + /** + * Gets a value indicating the protection type provided by this label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + protectionType?: boolean; + /** + * The unique identifier (GUID) of the tenant which the sensitivity label is belonged. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + siteId?: boolean; + /** + * The description of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tooltip?: boolean; + } /** * Represents a setting of the add-in. * @@ -76078,6 +76820,7 @@ export declare namespace Word { readonly document: Document; /** [Api set: WordApi 1.3] **/ readonly application: Application; + readonly sensitivityLabelsCatalog: SensitivityLabelsCatalog; } /** * Executes a batch script that performs actions on the Word object model, using the RequestContext of previously created API objects. diff --git a/generate-docs/script-inputs/include-hashes.json b/generate-docs/script-inputs/include-hashes.json index 568a686421..e87c6798a7 100644 --- a/generate-docs/script-inputs/include-hashes.json +++ b/generate-docs/script-inputs/include-hashes.json @@ -21,7 +21,7 @@ "docs/includes/excel-1_9.md": "56b9861503dbfb184ea037024b5898f18a208742b26fa610626e4a121f3056b7", "docs/includes/excel-desktop-1_1.md": "591413e2368a42df07c084517952d31b1cd9d0918a858604330607be00a50354", "docs/includes/excel-online.md": "199bb50b3b7e587aee3ef861c9e4918bacea6973f01663952ad5a64f329d613c", - "docs/includes/excel-preview.md": "fb05d6464e8fcf8b177cabf8d628270df0d980790029c5ea6f64186de2266519", + "docs/includes/excel-preview.md": "d0fd78d9007d798a930a9d1f1d26d2ee25082f5da5dab53f10fea54928c8c9db", "docs/includes/outlook-1_1.md": "aa79adb10745dbfd377f510a31f82968e63ca5e55307427c3b1b052cf7c97b4e", "docs/includes/outlook-1_10.md": "c3bf50e150cacb94f2b58a032050943a4e094a0b89b7f96462780f9e051d038e", "docs/includes/outlook-1_11.md": "57d4a4eddd23cf3732aa5f33492720060e1d378a9ac2cff637794ffbfa4cb70d", @@ -73,5 +73,5 @@ "docs/includes/word-desktop-1_4.md": "c5e4edd59b4ae08375f036aa6baec9651ba41c9fc44a5babc8ee86c8e06d9ae6", "docs/includes/word-desktop-1_5.md": "ad2b6656b6550fe41baeb535303256d2cf2b3b3643d6450820fb30e3f19f3e57", "docs/includes/word-online.md": "e645b476195fda983b442e3cc9a606eaf83e4ec837ffb32027e1eed326dc4814", - "docs/includes/word-preview.md": "47b20ebc15820d3d9c92cce49e1d792eaded2d12cd82b7beee9262f72b7bfb11" + "docs/includes/word-preview.md": "c5d4fe32fb16159648153c967120c50fcfa41534a3a4cdfb4898a934b23d0ef9" } diff --git a/generate-docs/script-inputs/office_preview.d.ts b/generate-docs/script-inputs/office_preview.d.ts index 2abeb0afd1..2d623f5c32 100644 --- a/generate-docs/script-inputs/office_preview.d.ts +++ b/generate-docs/script-inputs/office_preview.d.ts @@ -26347,7 +26347,6 @@ declare namespace OfficeCore { /////////////////////// Begin Excel APIs /////////////////////// //////////////////////////////////////////////////////////////// - declare namespace Excel { /** * Represents an unknown cell control. @@ -35498,6 +35497,10 @@ declare namespace Excel { * [Api set: ExcelApi 1.5] */ readonly runtime: Runtime; + /** + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + */ + readonly sensitivityLabelsCatalog: SensitivityLabelsCatalog; } interface RunOptions extends OfficeExtension.RunOptions { /** @@ -35548,8 +35551,416 @@ declare namespace Excel { * @param batch - A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the RequestContext is required to get access to the Excel object model from the add-in. */ function run(context: OfficeExtension.ClientRequestContext, batch: (context: Excel.RequestContext) => Promise): Promise; - function postprocessBindingDescriptor(response: any): any; - function getDataCommonPostprocess(response: any, callArgs: any): any; + /** + * Represents the labeling capability status of the sensitivity label catalog. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LabelingCapability { + /** + * No valid license is available for sensitivity labeling. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + noLicense = "NoLicense", + /** + * Sensitivity labeling is disabled for the user or tenant. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + labelingDisabled = "LabelingDisabled", + /** + * No labeling policy was found for the user. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + labelingPolicyNotFound = "LabelingPolicyNotFound", + /** + * Sensitivity labeling is fully enabled. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + labelingEnabled = "LabelingEnabled" + } + /** + * Represents the sensitivity label on the workbook. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + class SensitivityLabel extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets the current label information that exists on the workbook for the user. + If there's no sensitivity label on the current workbook, an object with an `isNullObject` property set to `true` is returned. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + * @returns The current `SensitivityLabelDetails` object. + */ + getCurrentOrNullObject(): Excel.SensitivityLabelDetails; + /** + * Tries to update to the provided sensitivity label on the workbook for the user. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + * + * @param labelId The ID of the label to apply. + * @returns The `SensitivityLabelUpdateResult` object. + */ + tryToUpdate(labelId: string): OfficeExtension.ClientResult; + /** + * 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.SensitivityLabel` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.SensitivityLabelData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): { + [key: string]: string; + }; + } + /** + * Represents the properties of available sensitivity labels in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + class SensitivityLabelDetails extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets the sublabels of the sensitivity label. Returns `null` if a label doesn't have any sublabels. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly children: SensitivityLabelDetailsCollection | null; + /** + * Gets the color of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly color: string; + /** + * Gets the unique identifier (GUID) of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly id: string; + /** + * Gets a value indicating whether the label is enabled. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isEnabled: boolean; + /** + * Gets the name of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly name: string; + /** + * Gets the priority of the sensitivity label, with 0 as lowest priority. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly order: number; + /** + * Gets a value indicating the protection type provided by this label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly protectionType: Excel.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined"; + /** + * Gets the unique identifier (GUID) of the tenant which the sensitivity label is belonged. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly siteId: string; + /** + * Gets the description of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly tooltip: string; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.SensitivityLabelDetailsLoadOptions): Excel.SensitivityLabelDetails; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.SensitivityLabelDetails; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.SensitivityLabelDetails; + /** + * 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.SensitivityLabelDetails` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.SensitivityLabelDetailsData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.SensitivityLabelDetailsData; + } + /** + * Represents the collection of {@link Excel.SensitivityLabelDetails} objects. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + class SensitivityLabelDetailsCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.SensitivityLabelDetails[]; + /** + * Gets the first `SensitivityLabelDetails` object in this collection. Throws an `ItemNotFound` error if this collection is empty. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + * @returns A new `SensitivityLabelDetails` object. + */ + getFirst(): Excel.SensitivityLabelDetails; + /** + * 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 {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + * @returns The new `SensitivityLabelDetails` object. + */ + getFirstOrNullObject(): OfficeExtension.ClientResult; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.SensitivityLabelDetailsCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SensitivityLabelDetailsCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.SensitivityLabelDetailsCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.SensitivityLabelDetailsCollection; + /** + * 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; + } + /** + * Represents the protection type. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SensitivityLabelProtectionType { + /** + * No protection is applied by this label. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + noProtection = "NoProtection", + /** + * Protection is defined by an administrator. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + adminDefined = "AdminDefined", + /** + * Protection is defined by the user. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + userDefined = "UserDefined" + } + /** + * Represents the result of updating the sensitivity label on the workbook. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SensitivityLabelUpdateResult { + /** + * The sensitivity label was successfully updated. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + success = "Success", + /** + * The update failed due to an unspecified error. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + unspecifiedFailure = "UnspecifiedFailure", + /** + * The specified sensitivity label could not be found. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + labelNotFound = "LabelNotFound", + /** + * The document is read-only and cannot be modified. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + documentReadOnly = "DocumentReadOnly", + /** + * The user does not have sufficient permissions to update the label. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + insufficientPermission = "InsufficientPermission", + /** + * The label update failed due to unsupported Double Key Encryption (DKE). + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + unsupportedDoubleKeyEncryption = "UnsupportedDoubleKeyEncryption", + /** + * The label update failed because native labeling is not enabled for the user or installed SKU. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + labelingDisabled = "LabelingDisabled", + /** + * The label update failed because the user's identity is not valid for applying a label. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + userNotFound = "UserNotFound", + /** + * The label update failed due to unsupported User Defined Permissions (UDP). + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + unsupportedUdp = "UnsupportedUdp", + /** + * The label update failed because the specified label is a parent label, which cannot be applied. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + parentLabelNotSupported = "ParentLabelNotSupported", + /** + * The label update failed because the document doesn't belong to the same tenant as the user. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + crossTenant = "CrossTenant" + } + /** + * Provides methods to check the status of the catalog of sensitivity labels in Excel and retrieve all available sensitivity labels if the catalog is enabled. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + class SensitivityLabelsCatalog extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets whether the catalog of sensitivity labels is enabled in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly getLabelingCapability: Excel.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled"; + /** + * Gets sensitivity labels that are available to the current user. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + * @returns The current `SensitivityLabelDetailsCollection` object. + */ + getLabels(): Excel.SensitivityLabelDetailsCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.SensitivityLabelsCatalogLoadOptions): Excel.SensitivityLabelsCatalog; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.SensitivityLabelsCatalog; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.SensitivityLabelsCatalog; + /** + * 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.SensitivityLabelsCatalog` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.SensitivityLabelsCatalogData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.SensitivityLabelsCatalogData; + } /** * Provides information about the ranges that raised the `onCalculationBusy` event, which triggers when the calculation is in progress in a worksheet. * @@ -40829,6 +41240,14 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ readonly worksheets: Excel.WorksheetCollection; + /** + * Returns the sensitivity label of the workbook. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly sensitivityLabel: Excel.SensitivityLabel; /** * Specifies if the workbook is in AutoSave mode. * @@ -62217,6 +62636,55 @@ declare namespace Excel { */ toJSON(): Excel.Interfaces.SlicerItemCollectionData; } + /** + * Provides information about the `LinkedEntityCellValue` that was requested given a specified `LinkedEntityId`. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + interface LinkedEntityCellValueLoadedEventArgs { + /** + * Any error encountered during the request to load the `LinkedEntityCellValue`. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + error?: string; + /** + * Gets the `LinkedEntityId` of the requested `LinkedEntityCellValue`. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + id: LinkedEntityId; + /** + * Gets the `LinkedEntityCellValue` of the requested `LinkedEntityId`. If the load operation failed, this property is `null`. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + linkedEntityCellValue?: LinkedEntityCellValue; + /** + * Gets the source of the event. See `Excel.EventSource` for details. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + source: Excel.EventSource | "Local" | "Remote"; + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + type: "LinkedEntityDataDomainLinkedEntityCellValueLoaded"; + } /** * Represents a specific category or field of information that shares some common characteristics or attributes. A data domain is linked to a data provider, that acts as the data source for `LinkedEntityCellValue` objects in the workbook. @@ -62517,6 +62985,17 @@ declare namespace Excel { * @returns The linked entity data domain with the given `id`. If there are multiple linked entity data domains with the same `id`, the one defined by this Office Add-in will be returned. */ getItemOrNullObject(id: string): Excel.LinkedEntityDataDomain; + /** + * Submits a request to load the `LinkedEntityCellValue` object with the specified `LinkedEntityId`. + If found, the `LinkedEntityCellValue` object will be returned through the `LinkedEntityCellValueLoaded` event. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + * + * @param id A specific `LinkedEntityId` + */ + loadLinkedEntityCellValue(id: LinkedEntityId): void; /** * Refreshes all `LinkedEntityCellValue` objects of all linked entity data domains in this collection. The refresh request can fail if the data providers are busy or temporarily inaccessible. @@ -62545,6 +63024,16 @@ declare namespace Excel { * @param propertyNamesAndPaths `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. */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.LinkedEntityDataDomainCollection; + /** + * Occurs when the request to load a `LinkedEntityCellValue` is completed. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * + * @eventproperty + * @beta + */ + readonly onLinkedEntityCellValueLoaded: OfficeExtension.EventHandlers; /** * Occurs when a new linked entity data domain is added to the workbook. * @@ -74893,6 +75382,10 @@ declare namespace Excel { */ $skip?: number; } + /** An interface for updating data on the `SensitivityLabelDetailsCollection` object, for use in `sensitivityLabelDetailsCollection.set({ ... })`. */ + interface SensitivityLabelDetailsCollectionUpdateData { + items?: Excel.Interfaces.SensitivityLabelDetailsData[]; + } /** An interface for updating data on the `AllowEditRange` object, for use in `allowEditRange.set({ ... })`. */ interface AllowEditRangeUpdateData { /** @@ -80546,6 +81039,96 @@ declare namespace Excel { interface PaneCollectionUpdateData { items?: Excel.Interfaces.PaneData[]; } + /** An interface describing the data returned by calling `sensitivityLabelDetails.toJSON()`. */ + interface SensitivityLabelDetailsData { + /** + * Gets the sublabels of the sensitivity label. Returns `null` if a label doesn't have any sublabels. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + children?: SensitivityLabelDetailsCollection | null; + /** + * Gets the color of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: string; + /** + * Gets the unique identifier (GUID) of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: string; + /** + * Gets a value indicating whether the label is enabled. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + isEnabled?: boolean; + /** + * Gets the name of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: string; + /** + * Gets the priority of the sensitivity label, with 0 as lowest priority. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + order?: number; + /** + * Gets a value indicating the protection type provided by this label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + protectionType?: Excel.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined"; + /** + * Gets the unique identifier (GUID) of the tenant which the sensitivity label is belonged. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + siteId?: string; + /** + * Gets the description of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + tooltip?: string; + } + /** An interface describing the data returned by calling `sensitivityLabelDetailsCollection.toJSON()`. */ + interface SensitivityLabelDetailsCollectionData { + items?: Excel.Interfaces.SensitivityLabelDetailsData[]; + } + /** An interface describing the data returned by calling `sensitivityLabelsCatalog.toJSON()`. */ + interface SensitivityLabelsCatalogData { + /** + * Gets whether the catalog of sensitivity labels is enabled in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + getLabelingCapability?: Excel.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled"; + } /** An interface describing the data returned by calling `allowEditRange.toJSON()`. */ interface AllowEditRangeData { /** @@ -88338,6 +88921,197 @@ declare namespace Excel { */ value?: T; } + /** + * Represents the properties of available sensitivity labels in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + interface SensitivityLabelDetailsLoadOptions { + /** + 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; + /** + * Gets the sublabels of the sensitivity label. Returns `null` if a label doesn't have any sublabels. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + children?: boolean; + /** + * Gets the color of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: boolean; + /** + * Gets the unique identifier (GUID) of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: boolean; + /** + * Gets a value indicating whether the label is enabled. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + isEnabled?: boolean; + /** + * Gets the name of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: boolean; + /** + * Gets the priority of the sensitivity label, with 0 as lowest priority. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + order?: boolean; + /** + * Gets a value indicating the protection type provided by this label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + protectionType?: boolean; + /** + * Gets the unique identifier (GUID) of the tenant which the sensitivity label is belonged. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + siteId?: boolean; + /** + * Gets the description of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + tooltip?: boolean; + } + /** + * Represents the collection of {@link Excel.SensitivityLabelDetails} objects. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + interface SensitivityLabelDetailsCollectionLoadOptions { + /** + 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; + /** + * For EACH ITEM in the collection: Gets the sublabels of the sensitivity label. Returns `null` if a label doesn't have any sublabels. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + children?: boolean; + /** + * For EACH ITEM in the collection: Gets the color of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: boolean; + /** + * For EACH ITEM in the collection: Gets the unique identifier (GUID) of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: boolean; + /** + * For EACH ITEM in the collection: Gets a value indicating whether the label is enabled. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + isEnabled?: boolean; + /** + * For EACH ITEM in the collection: Gets the name of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: boolean; + /** + * For EACH ITEM in the collection: Gets the priority of the sensitivity label, with 0 as lowest priority. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + order?: boolean; + /** + * For EACH ITEM in the collection: Gets a value indicating the protection type provided by this label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + protectionType?: boolean; + /** + * For EACH ITEM in the collection: Gets the unique identifier (GUID) of the tenant which the sensitivity label is belonged. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + siteId?: boolean; + /** + * For EACH ITEM in the collection: Gets the description of the sensitivity label. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + tooltip?: boolean; + } + /** + * Provides methods to check the status of the catalog of sensitivity labels in Excel and retrieve all available sensitivity labels if the catalog is enabled. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + interface SensitivityLabelsCatalogLoadOptions { + /** + 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; + /** + * Gets whether the catalog of sensitivity labels is enabled in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + getLabelingCapability?: boolean; + } /** * Represents an `AllowEditRange` object found in a worksheet. This object works with worksheet protection properties. When worksheet protection is enabled, an `AllowEditRange` object can be used to allow editing of a specific range, while maintaining protection on the rest of the worksheet. @@ -108033,6 +108807,14 @@ declare namespace Word { * [Api set: WordApiDesktop 1.4] */ readonly selection: Word.Selection; + /** + * Returns the sensitivity label of the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly sensitivityLabel: Word.SensitivityLabel; /** * Gets the `RangeScopedCollection` object that represents all the sentences in the document. * @@ -116630,6 +117412,318 @@ declare namespace Word { */ toJSON(): Word.Interfaces.SectionCollectionData; } + /** + * Represents the sensitivity label on the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class SensitivityLabel extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets the current label information that exists on the document for the user. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getCurrentOrNullObject(): Word.SensitivityLabelDetails; + /** + * Try to update to the provided sensitivity label on the document for the user. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param LabelId The label information that needs to be set on the document. + * @param Justification Optional. The justification of changing the label. + */ + tryToUpdate(LabelId: string, Justification?: string): OfficeExtension.ClientResult; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.SensitivityLabel; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.SensitivityLabel; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.SensitivityLabel; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.SensitivityLabel; + /** + * 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 `Word.SensitivityLabel` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SensitivityLabelData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): { + [key: string]: string; + }; + } + /** + * Provides methods to check the status of the catalog of sensitivity labels in Word and retrieve all available sensitivity labels if the catalog is enabled. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class SensitivityLabelsCatalog extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets the labeling capability status of the sensitivity label catalog in Word. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly getLabelingCapability: Word.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled"; + /** + * Gets all the sensitivity labels that are enabled in Word. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getLabels(): Word.SensitivityLabelDetailsCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.SensitivityLabelsCatalogLoadOptions): Word.SensitivityLabelsCatalog; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.SensitivityLabelsCatalog; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.SensitivityLabelsCatalog; + /** + * Create a new instance of the `Word.SensitivityLabelsCatalog` object. + */ + static newObject(context: OfficeExtension.ClientRequestContext): Word.SensitivityLabelsCatalog; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.SensitivityLabelsCatalog; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.SensitivityLabelsCatalog; + /** + * 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 `Word.SensitivityLabelsCatalog` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SensitivityLabelsCatalogData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.SensitivityLabelsCatalogData; + } + /** + * Represents the collection of {@link Word.SensitivityLabelDetails} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class SensitivityLabelDetailsCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.SensitivityLabelDetails[]; + /** + * Gets the first `SensitivityLabelDetails` object in this collection. Throws an `ItemNotFound` error if this collection is empty. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getFirst(): Word.SensitivityLabelDetails; + /** + * 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 {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getFirstOrNullObject(): Word.SensitivityLabelDetails; + /** + * Gets a `SensitivityLabelDetails` object by its index in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index A number that identifies the index location of a `SensitivityLabelDetails` object. + */ + getItem(index: number): Word.SensitivityLabelDetails; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.SensitivityLabelDetailsCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SensitivityLabelDetailsCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.SensitivityLabelDetailsCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.SensitivityLabelDetailsCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.SensitivityLabelDetailsCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.SensitivityLabelDetailsCollection; + /** + * 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 `Word.SensitivityLabelDetailsCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SensitivityLabelDetailsCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.SensitivityLabelDetailsCollectionData; + } + /** + * Represents the properties of available sensitivity labels in Word. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class SensitivityLabelDetails extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * The sublabels of the sensitivity label. Returns null if a label doesn't have any sublabels. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly children: Word.SensitivityLabelDetailsCollection; + /** + * The color of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly color: string; + /** + * The unique identifier (GUID) of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly id: string; + /** + * Gets a value indicating whether the label is enabled. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isEnabled: boolean; + /** + * The name of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly name: string; + /** + * The order of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly order: number; + /** + * Gets a value indicating the protection type provided by this label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly protectionType: Word.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined"; + /** + * The unique identifier (GUID) of the tenant which the sensitivity label is belonged. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly siteId: string; + /** + * The description of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly tooltip: string; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.SensitivityLabelDetailsLoadOptions): Word.SensitivityLabelDetails; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.SensitivityLabelDetails; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `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. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.SensitivityLabelDetails; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.SensitivityLabelDetails; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.SensitivityLabelDetails; + /** + * 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 `Word.SensitivityLabelDetails` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SensitivityLabelDetailsData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.SensitivityLabelDetailsData; + } /** * Represents a setting of the add-in. * @@ -148787,6 +149881,159 @@ declare namespace Word { */ owners = "Owners", } + /** + * Represents the result of updating the sensitivity label on the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SensitivityLabelUpdateResult { + /** + * The sensitivity label was successfully updated. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + success = "Success", + /** + * The update failed due to an unspecified error. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + unspecifiedFailure = "UnspecifiedFailure", + /** + * The specified sensitivity label could not be found. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + labelNotFound = "LabelNotFound", + /** + * The document is read-only and cannot be modified. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + documentReadOnly = "DocumentReadOnly", + /** + * The user does not have sufficient permissions to update the label. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insufficientPermission = "InsufficientPermission", + /** + * The label update failed due to unsupported Double Key Encryption (DKE). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + unsupportedDoubleKeyEncryption = "UnsupportedDoubleKeyEncryption", + /** + * The label update failed because native labeling is not enabled for the user or installed SKU. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + labelingDisabled = "LabelingDisabled", + /** + * The label update failed because the user's identity is not valid for applying a label. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + userNotFound = "UserNotFound", + /** + * The label update failed due to unsupported Universal Data Protection (UDP). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + unsupportedUdp = "UnsupportedUdp", + /** + * The label update failed because the specified label is a parent label, which cannot be applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + parentLabelNotSupported = "ParentLabelNotSupported", + /** + * The label update failed because the document doesn't belong to the same tenant as the user. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + crossTenant = "CrossTenant", + } + /** + * Represents the labeling capability status of the sensitivity label catalog. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LabelingCapability { + /** + * No valid license is available for sensitivity labeling. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + noLicense = "NoLicense", + /** + * Sensitivity labeling is disabled for the user or tenant. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + labelingDisabled = "LabelingDisabled", + /** + * No labeling policy was found for the user. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + labelingPolicyNotFound = "LabelingPolicyNotFound", + /** + * Sensitivity labeling is fully enabled. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + labelingEnabled = "LabelingEnabled", + } + /** + * Specifies the type of protection applied by a sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SensitivityLabelProtectionType { + /** + * The label applies no protection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + noProtection = "NoProtection", + /** + * The label applies admin-defined protection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + adminDefined = "AdminDefined", + /** + * The label applies user-defined protection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + userDefined = "UserDefined", + } enum ErrorCodes { accessDenied = "AccessDenied", generalException = "GeneralException", @@ -151525,6 +152772,10 @@ declare namespace Word { interface SectionCollectionUpdateData { items?: Word.Interfaces.SectionData[]; } + /** An interface for updating data on the `SensitivityLabelDetailsCollection` object, for use in `sensitivityLabelDetailsCollection.set({ ... })`. */ + interface SensitivityLabelDetailsCollectionUpdateData { + items?: Word.Interfaces.SensitivityLabelDetailsData[]; + } /** An interface for updating data on the `Setting` object, for use in `setting.set({ ... })`. */ interface SettingUpdateData { /** @@ -158990,6 +160241,96 @@ declare namespace Word { interface SectionCollectionData { items?: Word.Interfaces.SectionData[]; } + /** An interface describing the data returned by calling `sensitivityLabelsCatalog.toJSON()`. */ + interface SensitivityLabelsCatalogData { + /** + * Gets the labeling capability status of the sensitivity label catalog in Word. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getLabelingCapability?: Word.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled"; + } + /** An interface describing the data returned by calling `sensitivityLabelDetailsCollection.toJSON()`. */ + interface SensitivityLabelDetailsCollectionData { + items?: Word.Interfaces.SensitivityLabelDetailsData[]; + } + /** An interface describing the data returned by calling `sensitivityLabelDetails.toJSON()`. */ + interface SensitivityLabelDetailsData { + /** + * The sublabels of the sensitivity label. Returns null if a label doesn't have any sublabels. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + children?: Word.Interfaces.SensitivityLabelDetailsData[]; + /** + * The color of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: string; + /** + * The unique identifier (GUID) of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: string; + /** + * Gets a value indicating whether the label is enabled. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isEnabled?: boolean; + /** + * The name of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: string; + /** + * The order of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + order?: number; + /** + * Gets a value indicating the protection type provided by this label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + protectionType?: Word.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined"; + /** + * The unique identifier (GUID) of the tenant which the sensitivity label is belonged. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + siteId?: string; + /** + * The description of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tooltip?: string; + } /** An interface describing the data returned by calling `setting.toJSON()`. */ interface SettingData { /** @@ -170270,6 +171611,181 @@ declare namespace Word { */ protectedForForms?: boolean; } + /** + * Provides methods to check the status of the catalog of sensitivity labels in Word and retrieve all available sensitivity labels if the catalog is enabled. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface SensitivityLabelsCatalogLoadOptions { + /** + 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; + /** + * Gets the labeling capability status of the sensitivity label catalog in Word. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getLabelingCapability?: boolean; + } + /** + * Represents the collection of {@link Word.SensitivityLabelDetails} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface SensitivityLabelDetailsCollectionLoadOptions { + /** + 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; + /** + * For EACH ITEM in the collection: The color of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: boolean; + /** + * For EACH ITEM in the collection: The unique identifier (GUID) of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: boolean; + /** + * For EACH ITEM in the collection: Gets a value indicating whether the label is enabled. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isEnabled?: boolean; + /** + * For EACH ITEM in the collection: The name of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: boolean; + /** + * For EACH ITEM in the collection: The order of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + order?: boolean; + /** + * For EACH ITEM in the collection: Gets a value indicating the protection type provided by this label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + protectionType?: boolean; + /** + * For EACH ITEM in the collection: The unique identifier (GUID) of the tenant which the sensitivity label is belonged. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + siteId?: boolean; + /** + * For EACH ITEM in the collection: The description of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tooltip?: boolean; + } + /** + * Represents the properties of available sensitivity labels in Word. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface SensitivityLabelDetailsLoadOptions { + /** + 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; + /** + * The color of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: boolean; + /** + * The unique identifier (GUID) of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: boolean; + /** + * Gets a value indicating whether the label is enabled. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isEnabled?: boolean; + /** + * The name of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: boolean; + /** + * The order of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + order?: boolean; + /** + * Gets a value indicating the protection type provided by this label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + protectionType?: boolean; + /** + * The unique identifier (GUID) of the tenant which the sensitivity label is belonged. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + siteId?: boolean; + /** + * The description of the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tooltip?: boolean; + } /** * Represents a setting of the add-in. * @@ -177583,6 +179099,7 @@ declare namespace Word { constructor(url?: string); readonly document: Document; readonly application: Application; + readonly sensitivityLabelsCatalog: SensitivityLabelsCatalog; } /** * Executes a batch script that performs actions on the Word object model, using the RequestContext of previously created API objects.