@types/office-js-preview 1.0.710 → 1.0.711
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- office-js-preview/README.md +1 -1
- office-js-preview/index.d.ts +1520 -3
- office-js-preview/package.json +2 -2
office-js-preview/index.d.ts
CHANGED
|
@@ -26347,7 +26347,6 @@ declare namespace OfficeCore {
|
|
|
26347
26347
|
/////////////////////// Begin Excel APIs ///////////////////////
|
|
26348
26348
|
////////////////////////////////////////////////////////////////
|
|
26349
26349
|
|
|
26350
|
-
|
|
26351
26350
|
declare namespace Excel {
|
|
26352
26351
|
/**
|
|
26353
26352
|
* Represents an unknown cell control.
|
|
@@ -35498,6 +35497,10 @@ declare namespace Excel {
|
|
|
35498
35497
|
* [Api set: ExcelApi 1.5]
|
|
35499
35498
|
*/
|
|
35500
35499
|
readonly runtime: Runtime;
|
|
35500
|
+
/**
|
|
35501
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35502
|
+
*/
|
|
35503
|
+
readonly sensitivityLabelsCatalog: SensitivityLabelsCatalog;
|
|
35501
35504
|
}
|
|
35502
35505
|
interface RunOptions extends OfficeExtension.RunOptions<Session> {
|
|
35503
35506
|
/**
|
|
@@ -35548,8 +35551,416 @@ declare namespace Excel {
|
|
|
35548
35551
|
* @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.
|
|
35549
35552
|
*/
|
|
35550
35553
|
function run<T>(context: OfficeExtension.ClientRequestContext, batch: (context: Excel.RequestContext) => Promise<T>): Promise<T>;
|
|
35551
|
-
|
|
35552
|
-
|
|
35554
|
+
/**
|
|
35555
|
+
* Represents the labeling capability status of the sensitivity label catalog.
|
|
35556
|
+
*
|
|
35557
|
+
* @remarks
|
|
35558
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35559
|
+
* @beta
|
|
35560
|
+
*/
|
|
35561
|
+
enum LabelingCapability {
|
|
35562
|
+
/**
|
|
35563
|
+
* No valid license is available for sensitivity labeling.
|
|
35564
|
+
* @remarks
|
|
35565
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35566
|
+
* @beta
|
|
35567
|
+
*/
|
|
35568
|
+
noLicense = "NoLicense",
|
|
35569
|
+
/**
|
|
35570
|
+
* Sensitivity labeling is disabled for the user or tenant.
|
|
35571
|
+
* @remarks
|
|
35572
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35573
|
+
* @beta
|
|
35574
|
+
*/
|
|
35575
|
+
labelingDisabled = "LabelingDisabled",
|
|
35576
|
+
/**
|
|
35577
|
+
* No labeling policy was found for the user.
|
|
35578
|
+
* @remarks
|
|
35579
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35580
|
+
* @beta
|
|
35581
|
+
*/
|
|
35582
|
+
labelingPolicyNotFound = "LabelingPolicyNotFound",
|
|
35583
|
+
/**
|
|
35584
|
+
* Sensitivity labeling is fully enabled.
|
|
35585
|
+
* @remarks
|
|
35586
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35587
|
+
* @beta
|
|
35588
|
+
*/
|
|
35589
|
+
labelingEnabled = "LabelingEnabled"
|
|
35590
|
+
}
|
|
35591
|
+
/**
|
|
35592
|
+
* Represents the sensitivity label on the workbook.
|
|
35593
|
+
*
|
|
35594
|
+
* @remarks
|
|
35595
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35596
|
+
* @beta
|
|
35597
|
+
*/
|
|
35598
|
+
class SensitivityLabel extends OfficeExtension.ClientObject {
|
|
35599
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
35600
|
+
context: RequestContext;
|
|
35601
|
+
/**
|
|
35602
|
+
* Gets the current label information that exists on the workbook for the user.
|
|
35603
|
+
If there's no sensitivity label on the current workbook, an object with an `isNullObject` property set to `true` is returned.
|
|
35604
|
+
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}.
|
|
35605
|
+
*
|
|
35606
|
+
* @remarks
|
|
35607
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35608
|
+
* @beta
|
|
35609
|
+
* @returns The current `SensitivityLabelDetails` object.
|
|
35610
|
+
*/
|
|
35611
|
+
getCurrentOrNullObject(): Excel.SensitivityLabelDetails;
|
|
35612
|
+
/**
|
|
35613
|
+
* Tries to update to the provided sensitivity label on the workbook for the user.
|
|
35614
|
+
*
|
|
35615
|
+
* @remarks
|
|
35616
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35617
|
+
* @beta
|
|
35618
|
+
*
|
|
35619
|
+
* @param labelId The ID of the label to apply.
|
|
35620
|
+
* @returns The `SensitivityLabelUpdateResult` object.
|
|
35621
|
+
*/
|
|
35622
|
+
tryToUpdate(labelId: string): OfficeExtension.ClientResult<Excel.SensitivityLabelUpdateResult>;
|
|
35623
|
+
/**
|
|
35624
|
+
* 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.)
|
|
35625
|
+
* 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.
|
|
35626
|
+
*/
|
|
35627
|
+
toJSON(): {
|
|
35628
|
+
[key: string]: string;
|
|
35629
|
+
};
|
|
35630
|
+
}
|
|
35631
|
+
/**
|
|
35632
|
+
* Represents the properties of available sensitivity labels in Excel.
|
|
35633
|
+
*
|
|
35634
|
+
* @remarks
|
|
35635
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35636
|
+
* @beta
|
|
35637
|
+
*/
|
|
35638
|
+
class SensitivityLabelDetails extends OfficeExtension.ClientObject {
|
|
35639
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
35640
|
+
context: RequestContext;
|
|
35641
|
+
/**
|
|
35642
|
+
* Gets the sublabels of the sensitivity label. Returns `null` if a label doesn't have any sublabels.
|
|
35643
|
+
*
|
|
35644
|
+
* @remarks
|
|
35645
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35646
|
+
* @beta
|
|
35647
|
+
*/
|
|
35648
|
+
readonly children: SensitivityLabelDetailsCollection | null;
|
|
35649
|
+
/**
|
|
35650
|
+
* Gets the color of the sensitivity label.
|
|
35651
|
+
*
|
|
35652
|
+
* @remarks
|
|
35653
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35654
|
+
* @beta
|
|
35655
|
+
*/
|
|
35656
|
+
readonly color: string;
|
|
35657
|
+
/**
|
|
35658
|
+
* Gets the unique identifier (GUID) of the sensitivity label.
|
|
35659
|
+
*
|
|
35660
|
+
* @remarks
|
|
35661
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35662
|
+
* @beta
|
|
35663
|
+
*/
|
|
35664
|
+
readonly id: string;
|
|
35665
|
+
/**
|
|
35666
|
+
* Gets a value indicating whether the label is enabled.
|
|
35667
|
+
*
|
|
35668
|
+
* @remarks
|
|
35669
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35670
|
+
* @beta
|
|
35671
|
+
*/
|
|
35672
|
+
readonly isEnabled: boolean;
|
|
35673
|
+
/**
|
|
35674
|
+
* Gets the name of the sensitivity label.
|
|
35675
|
+
*
|
|
35676
|
+
* @remarks
|
|
35677
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35678
|
+
* @beta
|
|
35679
|
+
*/
|
|
35680
|
+
readonly name: string;
|
|
35681
|
+
/**
|
|
35682
|
+
* Gets the priority of the sensitivity label, with 0 as lowest priority.
|
|
35683
|
+
*
|
|
35684
|
+
* @remarks
|
|
35685
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35686
|
+
* @beta
|
|
35687
|
+
*/
|
|
35688
|
+
readonly order: number;
|
|
35689
|
+
/**
|
|
35690
|
+
* Gets a value indicating the protection type provided by this label.
|
|
35691
|
+
*
|
|
35692
|
+
* @remarks
|
|
35693
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35694
|
+
* @beta
|
|
35695
|
+
*/
|
|
35696
|
+
readonly protectionType: Excel.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined";
|
|
35697
|
+
/**
|
|
35698
|
+
* Gets the unique identifier (GUID) of the tenant which the sensitivity label is belonged.
|
|
35699
|
+
*
|
|
35700
|
+
* @remarks
|
|
35701
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35702
|
+
* @beta
|
|
35703
|
+
*/
|
|
35704
|
+
readonly siteId: string;
|
|
35705
|
+
/**
|
|
35706
|
+
* Gets the description of the sensitivity label.
|
|
35707
|
+
*
|
|
35708
|
+
* @remarks
|
|
35709
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35710
|
+
* @beta
|
|
35711
|
+
*/
|
|
35712
|
+
readonly tooltip: string;
|
|
35713
|
+
/**
|
|
35714
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
35715
|
+
*
|
|
35716
|
+
* @param options Provides options for which properties of the object to load.
|
|
35717
|
+
*/
|
|
35718
|
+
load(options?: Excel.Interfaces.SensitivityLabelDetailsLoadOptions): Excel.SensitivityLabelDetails;
|
|
35719
|
+
/**
|
|
35720
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
35721
|
+
*
|
|
35722
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
35723
|
+
*/
|
|
35724
|
+
load(propertyNames?: string | string[]): Excel.SensitivityLabelDetails;
|
|
35725
|
+
/**
|
|
35726
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
35727
|
+
*
|
|
35728
|
+
* @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.
|
|
35729
|
+
*/
|
|
35730
|
+
load(propertyNamesAndPaths?: {
|
|
35731
|
+
select?: string;
|
|
35732
|
+
expand?: string;
|
|
35733
|
+
}): Excel.SensitivityLabelDetails;
|
|
35734
|
+
/**
|
|
35735
|
+
* 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.)
|
|
35736
|
+
* 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.
|
|
35737
|
+
*/
|
|
35738
|
+
toJSON(): Excel.Interfaces.SensitivityLabelDetailsData;
|
|
35739
|
+
}
|
|
35740
|
+
/**
|
|
35741
|
+
* Represents the collection of {@link Excel.SensitivityLabelDetails} objects.
|
|
35742
|
+
*
|
|
35743
|
+
* @remarks
|
|
35744
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35745
|
+
* @beta
|
|
35746
|
+
*/
|
|
35747
|
+
class SensitivityLabelDetailsCollection extends OfficeExtension.ClientObject {
|
|
35748
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
35749
|
+
context: RequestContext;
|
|
35750
|
+
/** Gets the loaded child items in this collection. */
|
|
35751
|
+
readonly items: Excel.SensitivityLabelDetails[];
|
|
35752
|
+
/**
|
|
35753
|
+
* Gets the first `SensitivityLabelDetails` object in this collection. Throws an `ItemNotFound` error if this collection is empty.
|
|
35754
|
+
*
|
|
35755
|
+
* @remarks
|
|
35756
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35757
|
+
* @beta
|
|
35758
|
+
* @returns A new `SensitivityLabelDetails` object.
|
|
35759
|
+
*/
|
|
35760
|
+
getFirst(): Excel.SensitivityLabelDetails;
|
|
35761
|
+
/**
|
|
35762
|
+
* 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}.
|
|
35763
|
+
*
|
|
35764
|
+
* @remarks
|
|
35765
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35766
|
+
* @beta
|
|
35767
|
+
* @returns The new `SensitivityLabelDetails` object.
|
|
35768
|
+
*/
|
|
35769
|
+
getFirstOrNullObject(): OfficeExtension.ClientResult<any>;
|
|
35770
|
+
/**
|
|
35771
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
35772
|
+
*
|
|
35773
|
+
* @param options Provides options for which properties of the object to load.
|
|
35774
|
+
*/
|
|
35775
|
+
load(options?: Excel.Interfaces.SensitivityLabelDetailsCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SensitivityLabelDetailsCollection;
|
|
35776
|
+
/**
|
|
35777
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
35778
|
+
*
|
|
35779
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
35780
|
+
*/
|
|
35781
|
+
load(propertyNames?: string | string[]): Excel.SensitivityLabelDetailsCollection;
|
|
35782
|
+
/**
|
|
35783
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
35784
|
+
*
|
|
35785
|
+
* @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.
|
|
35786
|
+
*/
|
|
35787
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.SensitivityLabelDetailsCollection;
|
|
35788
|
+
/**
|
|
35789
|
+
* 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.)
|
|
35790
|
+
* 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.
|
|
35791
|
+
*/
|
|
35792
|
+
toJSON(): Excel.Interfaces.SensitivityLabelDetailsCollectionData;
|
|
35793
|
+
}
|
|
35794
|
+
/**
|
|
35795
|
+
* Represents the protection type.
|
|
35796
|
+
*
|
|
35797
|
+
* @remarks
|
|
35798
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35799
|
+
* @beta
|
|
35800
|
+
*/
|
|
35801
|
+
enum SensitivityLabelProtectionType {
|
|
35802
|
+
/**
|
|
35803
|
+
* No protection is applied by this label.
|
|
35804
|
+
* @remarks
|
|
35805
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35806
|
+
* @beta
|
|
35807
|
+
*/
|
|
35808
|
+
noProtection = "NoProtection",
|
|
35809
|
+
/**
|
|
35810
|
+
* Protection is defined by an administrator.
|
|
35811
|
+
* @remarks
|
|
35812
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35813
|
+
* @beta
|
|
35814
|
+
*/
|
|
35815
|
+
adminDefined = "AdminDefined",
|
|
35816
|
+
/**
|
|
35817
|
+
* Protection is defined by the user.
|
|
35818
|
+
* @remarks
|
|
35819
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35820
|
+
* @beta
|
|
35821
|
+
*/
|
|
35822
|
+
userDefined = "UserDefined"
|
|
35823
|
+
}
|
|
35824
|
+
/**
|
|
35825
|
+
* Represents the result of updating the sensitivity label on the workbook.
|
|
35826
|
+
*
|
|
35827
|
+
* @remarks
|
|
35828
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35829
|
+
* @beta
|
|
35830
|
+
*/
|
|
35831
|
+
enum SensitivityLabelUpdateResult {
|
|
35832
|
+
/**
|
|
35833
|
+
* The sensitivity label was successfully updated.
|
|
35834
|
+
* @remarks
|
|
35835
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35836
|
+
* @beta
|
|
35837
|
+
*/
|
|
35838
|
+
success = "Success",
|
|
35839
|
+
/**
|
|
35840
|
+
* The update failed due to an unspecified error.
|
|
35841
|
+
* @remarks
|
|
35842
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35843
|
+
* @beta
|
|
35844
|
+
*/
|
|
35845
|
+
unspecifiedFailure = "UnspecifiedFailure",
|
|
35846
|
+
/**
|
|
35847
|
+
* The specified sensitivity label could not be found.
|
|
35848
|
+
* @remarks
|
|
35849
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35850
|
+
* @beta
|
|
35851
|
+
*/
|
|
35852
|
+
labelNotFound = "LabelNotFound",
|
|
35853
|
+
/**
|
|
35854
|
+
* The document is read-only and cannot be modified.
|
|
35855
|
+
* @remarks
|
|
35856
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35857
|
+
* @beta
|
|
35858
|
+
*/
|
|
35859
|
+
documentReadOnly = "DocumentReadOnly",
|
|
35860
|
+
/**
|
|
35861
|
+
* The user does not have sufficient permissions to update the label.
|
|
35862
|
+
* @remarks
|
|
35863
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35864
|
+
* @beta
|
|
35865
|
+
*/
|
|
35866
|
+
insufficientPermission = "InsufficientPermission",
|
|
35867
|
+
/**
|
|
35868
|
+
* The label update failed due to unsupported Double Key Encryption (DKE).
|
|
35869
|
+
* @remarks
|
|
35870
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35871
|
+
* @beta
|
|
35872
|
+
*/
|
|
35873
|
+
unsupportedDoubleKeyEncryption = "UnsupportedDoubleKeyEncryption",
|
|
35874
|
+
/**
|
|
35875
|
+
* The label update failed because native labeling is not enabled for the user or installed SKU.
|
|
35876
|
+
* @remarks
|
|
35877
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35878
|
+
* @beta
|
|
35879
|
+
*/
|
|
35880
|
+
labelingDisabled = "LabelingDisabled",
|
|
35881
|
+
/**
|
|
35882
|
+
* The label update failed because the user's identity is not valid for applying a label.
|
|
35883
|
+
* @remarks
|
|
35884
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35885
|
+
* @beta
|
|
35886
|
+
*/
|
|
35887
|
+
userNotFound = "UserNotFound",
|
|
35888
|
+
/**
|
|
35889
|
+
* The label update failed due to unsupported User Defined Permissions (UDP).
|
|
35890
|
+
* @remarks
|
|
35891
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35892
|
+
* @beta
|
|
35893
|
+
*/
|
|
35894
|
+
unsupportedUdp = "UnsupportedUdp",
|
|
35895
|
+
/**
|
|
35896
|
+
* The label update failed because the specified label is a parent label, which cannot be applied.
|
|
35897
|
+
* @remarks
|
|
35898
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35899
|
+
* @beta
|
|
35900
|
+
*/
|
|
35901
|
+
parentLabelNotSupported = "ParentLabelNotSupported",
|
|
35902
|
+
/**
|
|
35903
|
+
* The label update failed because the document doesn't belong to the same tenant as the user.
|
|
35904
|
+
* @remarks
|
|
35905
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35906
|
+
* @beta
|
|
35907
|
+
*/
|
|
35908
|
+
crossTenant = "CrossTenant"
|
|
35909
|
+
}
|
|
35910
|
+
/**
|
|
35911
|
+
* 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.
|
|
35912
|
+
*
|
|
35913
|
+
* @remarks
|
|
35914
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35915
|
+
* @beta
|
|
35916
|
+
*/
|
|
35917
|
+
class SensitivityLabelsCatalog extends OfficeExtension.ClientObject {
|
|
35918
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
35919
|
+
context: RequestContext;
|
|
35920
|
+
/**
|
|
35921
|
+
* Gets whether the catalog of sensitivity labels is enabled in Excel.
|
|
35922
|
+
*
|
|
35923
|
+
* @remarks
|
|
35924
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35925
|
+
* @beta
|
|
35926
|
+
*/
|
|
35927
|
+
readonly getLabelingCapability: Excel.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled";
|
|
35928
|
+
/**
|
|
35929
|
+
* Gets sensitivity labels that are available to the current user.
|
|
35930
|
+
*
|
|
35931
|
+
* @remarks
|
|
35932
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35933
|
+
* @beta
|
|
35934
|
+
* @returns The current `SensitivityLabelDetailsCollection` object.
|
|
35935
|
+
*/
|
|
35936
|
+
getLabels(): Excel.SensitivityLabelDetailsCollection;
|
|
35937
|
+
/**
|
|
35938
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
35939
|
+
*
|
|
35940
|
+
* @param options Provides options for which properties of the object to load.
|
|
35941
|
+
*/
|
|
35942
|
+
load(options?: Excel.Interfaces.SensitivityLabelsCatalogLoadOptions): Excel.SensitivityLabelsCatalog;
|
|
35943
|
+
/**
|
|
35944
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
35945
|
+
*
|
|
35946
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
35947
|
+
*/
|
|
35948
|
+
load(propertyNames?: string | string[]): Excel.SensitivityLabelsCatalog;
|
|
35949
|
+
/**
|
|
35950
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
35951
|
+
*
|
|
35952
|
+
* @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.
|
|
35953
|
+
*/
|
|
35954
|
+
load(propertyNamesAndPaths?: {
|
|
35955
|
+
select?: string;
|
|
35956
|
+
expand?: string;
|
|
35957
|
+
}): Excel.SensitivityLabelsCatalog;
|
|
35958
|
+
/**
|
|
35959
|
+
* 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.)
|
|
35960
|
+
* 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.
|
|
35961
|
+
*/
|
|
35962
|
+
toJSON(): Excel.Interfaces.SensitivityLabelsCatalogData;
|
|
35963
|
+
}
|
|
35553
35964
|
/**
|
|
35554
35965
|
* Provides information about the ranges that raised the `onCalculationBusy` event, which triggers when the calculation is in progress in a worksheet.
|
|
35555
35966
|
*
|
|
@@ -40829,6 +41240,14 @@ declare namespace Excel {
|
|
|
40829
41240
|
* [Api set: ExcelApi 1.1]
|
|
40830
41241
|
*/
|
|
40831
41242
|
readonly worksheets: Excel.WorksheetCollection;
|
|
41243
|
+
/**
|
|
41244
|
+
* Returns the sensitivity label of the workbook.
|
|
41245
|
+
*
|
|
41246
|
+
* @remarks
|
|
41247
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
41248
|
+
* @beta
|
|
41249
|
+
*/
|
|
41250
|
+
readonly sensitivityLabel: Excel.SensitivityLabel;
|
|
40832
41251
|
/**
|
|
40833
41252
|
* Specifies if the workbook is in AutoSave mode.
|
|
40834
41253
|
*
|
|
@@ -62217,6 +62636,55 @@ declare namespace Excel {
|
|
|
62217
62636
|
*/
|
|
62218
62637
|
toJSON(): Excel.Interfaces.SlicerItemCollectionData;
|
|
62219
62638
|
}
|
|
62639
|
+
/**
|
|
62640
|
+
* Provides information about the `LinkedEntityCellValue` that was requested given a specified `LinkedEntityId`.
|
|
62641
|
+
*
|
|
62642
|
+
* @remarks
|
|
62643
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
62644
|
+
* @beta
|
|
62645
|
+
*/
|
|
62646
|
+
interface LinkedEntityCellValueLoadedEventArgs {
|
|
62647
|
+
/**
|
|
62648
|
+
* Any error encountered during the request to load the `LinkedEntityCellValue`.
|
|
62649
|
+
*
|
|
62650
|
+
* @remarks
|
|
62651
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
62652
|
+
* @beta
|
|
62653
|
+
*/
|
|
62654
|
+
error?: string;
|
|
62655
|
+
/**
|
|
62656
|
+
* Gets the `LinkedEntityId` of the requested `LinkedEntityCellValue`.
|
|
62657
|
+
*
|
|
62658
|
+
* @remarks
|
|
62659
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
62660
|
+
* @beta
|
|
62661
|
+
*/
|
|
62662
|
+
id: LinkedEntityId;
|
|
62663
|
+
/**
|
|
62664
|
+
* Gets the `LinkedEntityCellValue` of the requested `LinkedEntityId`. If the load operation failed, this property is `null`.
|
|
62665
|
+
*
|
|
62666
|
+
* @remarks
|
|
62667
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
62668
|
+
* @beta
|
|
62669
|
+
*/
|
|
62670
|
+
linkedEntityCellValue?: LinkedEntityCellValue;
|
|
62671
|
+
/**
|
|
62672
|
+
* Gets the source of the event. See `Excel.EventSource` for details.
|
|
62673
|
+
*
|
|
62674
|
+
* @remarks
|
|
62675
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
62676
|
+
* @beta
|
|
62677
|
+
*/
|
|
62678
|
+
source: Excel.EventSource | "Local" | "Remote";
|
|
62679
|
+
/**
|
|
62680
|
+
* Gets the type of the event. See `Excel.EventType` for details.
|
|
62681
|
+
*
|
|
62682
|
+
* @remarks
|
|
62683
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
62684
|
+
* @beta
|
|
62685
|
+
*/
|
|
62686
|
+
type: "LinkedEntityDataDomainLinkedEntityCellValueLoaded";
|
|
62687
|
+
}
|
|
62220
62688
|
/**
|
|
62221
62689
|
* Represents a specific category or field of information that shares some common characteristics or attributes.
|
|
62222
62690
|
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 {
|
|
|
62517
62985
|
* @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.
|
|
62518
62986
|
*/
|
|
62519
62987
|
getItemOrNullObject(id: string): Excel.LinkedEntityDataDomain;
|
|
62988
|
+
/**
|
|
62989
|
+
* Submits a request to load the `LinkedEntityCellValue` object with the specified `LinkedEntityId`.
|
|
62990
|
+
If found, the `LinkedEntityCellValue` object will be returned through the `LinkedEntityCellValueLoaded` event.
|
|
62991
|
+
*
|
|
62992
|
+
* @remarks
|
|
62993
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
62994
|
+
* @beta
|
|
62995
|
+
*
|
|
62996
|
+
* @param id A specific `LinkedEntityId`
|
|
62997
|
+
*/
|
|
62998
|
+
loadLinkedEntityCellValue(id: LinkedEntityId): void;
|
|
62520
62999
|
/**
|
|
62521
63000
|
* Refreshes all `LinkedEntityCellValue` objects of all linked entity data domains in this collection.
|
|
62522
63001
|
The refresh request can fail if the data providers are busy or temporarily inaccessible.
|
|
@@ -62545,6 +63024,16 @@ declare namespace Excel {
|
|
|
62545
63024
|
* @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.
|
|
62546
63025
|
*/
|
|
62547
63026
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.LinkedEntityDataDomainCollection;
|
|
63027
|
+
/**
|
|
63028
|
+
* Occurs when the request to load a `LinkedEntityCellValue` is completed.
|
|
63029
|
+
*
|
|
63030
|
+
* @remarks
|
|
63031
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
63032
|
+
*
|
|
63033
|
+
* @eventproperty
|
|
63034
|
+
* @beta
|
|
63035
|
+
*/
|
|
63036
|
+
readonly onLinkedEntityCellValueLoaded: OfficeExtension.EventHandlers<Excel.LinkedEntityCellValueLoadedEventArgs>;
|
|
62548
63037
|
/**
|
|
62549
63038
|
* Occurs when a new linked entity data domain is added to the workbook.
|
|
62550
63039
|
*
|
|
@@ -74893,6 +75382,10 @@ declare namespace Excel {
|
|
|
74893
75382
|
*/
|
|
74894
75383
|
$skip?: number;
|
|
74895
75384
|
}
|
|
75385
|
+
/** An interface for updating data on the `SensitivityLabelDetailsCollection` object, for use in `sensitivityLabelDetailsCollection.set({ ... })`. */
|
|
75386
|
+
interface SensitivityLabelDetailsCollectionUpdateData {
|
|
75387
|
+
items?: Excel.Interfaces.SensitivityLabelDetailsData[];
|
|
75388
|
+
}
|
|
74896
75389
|
/** An interface for updating data on the `AllowEditRange` object, for use in `allowEditRange.set({ ... })`. */
|
|
74897
75390
|
interface AllowEditRangeUpdateData {
|
|
74898
75391
|
/**
|
|
@@ -80546,6 +81039,96 @@ declare namespace Excel {
|
|
|
80546
81039
|
interface PaneCollectionUpdateData {
|
|
80547
81040
|
items?: Excel.Interfaces.PaneData[];
|
|
80548
81041
|
}
|
|
81042
|
+
/** An interface describing the data returned by calling `sensitivityLabelDetails.toJSON()`. */
|
|
81043
|
+
interface SensitivityLabelDetailsData {
|
|
81044
|
+
/**
|
|
81045
|
+
* Gets the sublabels of the sensitivity label. Returns `null` if a label doesn't have any sublabels.
|
|
81046
|
+
*
|
|
81047
|
+
* @remarks
|
|
81048
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
81049
|
+
* @beta
|
|
81050
|
+
*/
|
|
81051
|
+
children?: SensitivityLabelDetailsCollection | null;
|
|
81052
|
+
/**
|
|
81053
|
+
* Gets the color of the sensitivity label.
|
|
81054
|
+
*
|
|
81055
|
+
* @remarks
|
|
81056
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
81057
|
+
* @beta
|
|
81058
|
+
*/
|
|
81059
|
+
color?: string;
|
|
81060
|
+
/**
|
|
81061
|
+
* Gets the unique identifier (GUID) of the sensitivity label.
|
|
81062
|
+
*
|
|
81063
|
+
* @remarks
|
|
81064
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
81065
|
+
* @beta
|
|
81066
|
+
*/
|
|
81067
|
+
id?: string;
|
|
81068
|
+
/**
|
|
81069
|
+
* Gets a value indicating whether the label is enabled.
|
|
81070
|
+
*
|
|
81071
|
+
* @remarks
|
|
81072
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
81073
|
+
* @beta
|
|
81074
|
+
*/
|
|
81075
|
+
isEnabled?: boolean;
|
|
81076
|
+
/**
|
|
81077
|
+
* Gets the name of the sensitivity label.
|
|
81078
|
+
*
|
|
81079
|
+
* @remarks
|
|
81080
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
81081
|
+
* @beta
|
|
81082
|
+
*/
|
|
81083
|
+
name?: string;
|
|
81084
|
+
/**
|
|
81085
|
+
* Gets the priority of the sensitivity label, with 0 as lowest priority.
|
|
81086
|
+
*
|
|
81087
|
+
* @remarks
|
|
81088
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
81089
|
+
* @beta
|
|
81090
|
+
*/
|
|
81091
|
+
order?: number;
|
|
81092
|
+
/**
|
|
81093
|
+
* Gets a value indicating the protection type provided by this label.
|
|
81094
|
+
*
|
|
81095
|
+
* @remarks
|
|
81096
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
81097
|
+
* @beta
|
|
81098
|
+
*/
|
|
81099
|
+
protectionType?: Excel.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined";
|
|
81100
|
+
/**
|
|
81101
|
+
* Gets the unique identifier (GUID) of the tenant which the sensitivity label is belonged.
|
|
81102
|
+
*
|
|
81103
|
+
* @remarks
|
|
81104
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
81105
|
+
* @beta
|
|
81106
|
+
*/
|
|
81107
|
+
siteId?: string;
|
|
81108
|
+
/**
|
|
81109
|
+
* Gets the description of the sensitivity label.
|
|
81110
|
+
*
|
|
81111
|
+
* @remarks
|
|
81112
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
81113
|
+
* @beta
|
|
81114
|
+
*/
|
|
81115
|
+
tooltip?: string;
|
|
81116
|
+
}
|
|
81117
|
+
/** An interface describing the data returned by calling `sensitivityLabelDetailsCollection.toJSON()`. */
|
|
81118
|
+
interface SensitivityLabelDetailsCollectionData {
|
|
81119
|
+
items?: Excel.Interfaces.SensitivityLabelDetailsData[];
|
|
81120
|
+
}
|
|
81121
|
+
/** An interface describing the data returned by calling `sensitivityLabelsCatalog.toJSON()`. */
|
|
81122
|
+
interface SensitivityLabelsCatalogData {
|
|
81123
|
+
/**
|
|
81124
|
+
* Gets whether the catalog of sensitivity labels is enabled in Excel.
|
|
81125
|
+
*
|
|
81126
|
+
* @remarks
|
|
81127
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
81128
|
+
* @beta
|
|
81129
|
+
*/
|
|
81130
|
+
getLabelingCapability?: Excel.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled";
|
|
81131
|
+
}
|
|
80549
81132
|
/** An interface describing the data returned by calling `allowEditRange.toJSON()`. */
|
|
80550
81133
|
interface AllowEditRangeData {
|
|
80551
81134
|
/**
|
|
@@ -88338,6 +88921,197 @@ declare namespace Excel {
|
|
|
88338
88921
|
*/
|
|
88339
88922
|
value?: T;
|
|
88340
88923
|
}
|
|
88924
|
+
/**
|
|
88925
|
+
* Represents the properties of available sensitivity labels in Excel.
|
|
88926
|
+
*
|
|
88927
|
+
* @remarks
|
|
88928
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
88929
|
+
* @beta
|
|
88930
|
+
*/
|
|
88931
|
+
interface SensitivityLabelDetailsLoadOptions {
|
|
88932
|
+
/**
|
|
88933
|
+
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`).
|
|
88934
|
+
*/
|
|
88935
|
+
$all?: boolean;
|
|
88936
|
+
/**
|
|
88937
|
+
* Gets the sublabels of the sensitivity label. Returns `null` if a label doesn't have any sublabels.
|
|
88938
|
+
*
|
|
88939
|
+
* @remarks
|
|
88940
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
88941
|
+
* @beta
|
|
88942
|
+
*/
|
|
88943
|
+
children?: boolean;
|
|
88944
|
+
/**
|
|
88945
|
+
* Gets the color of the sensitivity label.
|
|
88946
|
+
*
|
|
88947
|
+
* @remarks
|
|
88948
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
88949
|
+
* @beta
|
|
88950
|
+
*/
|
|
88951
|
+
color?: boolean;
|
|
88952
|
+
/**
|
|
88953
|
+
* Gets the unique identifier (GUID) of the sensitivity label.
|
|
88954
|
+
*
|
|
88955
|
+
* @remarks
|
|
88956
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
88957
|
+
* @beta
|
|
88958
|
+
*/
|
|
88959
|
+
id?: boolean;
|
|
88960
|
+
/**
|
|
88961
|
+
* Gets a value indicating whether the label is enabled.
|
|
88962
|
+
*
|
|
88963
|
+
* @remarks
|
|
88964
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
88965
|
+
* @beta
|
|
88966
|
+
*/
|
|
88967
|
+
isEnabled?: boolean;
|
|
88968
|
+
/**
|
|
88969
|
+
* Gets the name of the sensitivity label.
|
|
88970
|
+
*
|
|
88971
|
+
* @remarks
|
|
88972
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
88973
|
+
* @beta
|
|
88974
|
+
*/
|
|
88975
|
+
name?: boolean;
|
|
88976
|
+
/**
|
|
88977
|
+
* Gets the priority of the sensitivity label, with 0 as lowest priority.
|
|
88978
|
+
*
|
|
88979
|
+
* @remarks
|
|
88980
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
88981
|
+
* @beta
|
|
88982
|
+
*/
|
|
88983
|
+
order?: boolean;
|
|
88984
|
+
/**
|
|
88985
|
+
* Gets a value indicating the protection type provided by this label.
|
|
88986
|
+
*
|
|
88987
|
+
* @remarks
|
|
88988
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
88989
|
+
* @beta
|
|
88990
|
+
*/
|
|
88991
|
+
protectionType?: boolean;
|
|
88992
|
+
/**
|
|
88993
|
+
* Gets the unique identifier (GUID) of the tenant which the sensitivity label is belonged.
|
|
88994
|
+
*
|
|
88995
|
+
* @remarks
|
|
88996
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
88997
|
+
* @beta
|
|
88998
|
+
*/
|
|
88999
|
+
siteId?: boolean;
|
|
89000
|
+
/**
|
|
89001
|
+
* Gets the description of the sensitivity label.
|
|
89002
|
+
*
|
|
89003
|
+
* @remarks
|
|
89004
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
89005
|
+
* @beta
|
|
89006
|
+
*/
|
|
89007
|
+
tooltip?: boolean;
|
|
89008
|
+
}
|
|
89009
|
+
/**
|
|
89010
|
+
* Represents the collection of {@link Excel.SensitivityLabelDetails} objects.
|
|
89011
|
+
*
|
|
89012
|
+
* @remarks
|
|
89013
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
89014
|
+
* @beta
|
|
89015
|
+
*/
|
|
89016
|
+
interface SensitivityLabelDetailsCollectionLoadOptions {
|
|
89017
|
+
/**
|
|
89018
|
+
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`).
|
|
89019
|
+
*/
|
|
89020
|
+
$all?: boolean;
|
|
89021
|
+
/**
|
|
89022
|
+
* For EACH ITEM in the collection: Gets the sublabels of the sensitivity label. Returns `null` if a label doesn't have any sublabels.
|
|
89023
|
+
*
|
|
89024
|
+
* @remarks
|
|
89025
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
89026
|
+
* @beta
|
|
89027
|
+
*/
|
|
89028
|
+
children?: boolean;
|
|
89029
|
+
/**
|
|
89030
|
+
* For EACH ITEM in the collection: Gets the color of the sensitivity label.
|
|
89031
|
+
*
|
|
89032
|
+
* @remarks
|
|
89033
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
89034
|
+
* @beta
|
|
89035
|
+
*/
|
|
89036
|
+
color?: boolean;
|
|
89037
|
+
/**
|
|
89038
|
+
* For EACH ITEM in the collection: Gets the unique identifier (GUID) of the sensitivity label.
|
|
89039
|
+
*
|
|
89040
|
+
* @remarks
|
|
89041
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
89042
|
+
* @beta
|
|
89043
|
+
*/
|
|
89044
|
+
id?: boolean;
|
|
89045
|
+
/**
|
|
89046
|
+
* For EACH ITEM in the collection: Gets a value indicating whether the label is enabled.
|
|
89047
|
+
*
|
|
89048
|
+
* @remarks
|
|
89049
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
89050
|
+
* @beta
|
|
89051
|
+
*/
|
|
89052
|
+
isEnabled?: boolean;
|
|
89053
|
+
/**
|
|
89054
|
+
* For EACH ITEM in the collection: Gets the name of the sensitivity label.
|
|
89055
|
+
*
|
|
89056
|
+
* @remarks
|
|
89057
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
89058
|
+
* @beta
|
|
89059
|
+
*/
|
|
89060
|
+
name?: boolean;
|
|
89061
|
+
/**
|
|
89062
|
+
* For EACH ITEM in the collection: Gets the priority of the sensitivity label, with 0 as lowest priority.
|
|
89063
|
+
*
|
|
89064
|
+
* @remarks
|
|
89065
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
89066
|
+
* @beta
|
|
89067
|
+
*/
|
|
89068
|
+
order?: boolean;
|
|
89069
|
+
/**
|
|
89070
|
+
* For EACH ITEM in the collection: Gets a value indicating the protection type provided by this label.
|
|
89071
|
+
*
|
|
89072
|
+
* @remarks
|
|
89073
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
89074
|
+
* @beta
|
|
89075
|
+
*/
|
|
89076
|
+
protectionType?: boolean;
|
|
89077
|
+
/**
|
|
89078
|
+
* For EACH ITEM in the collection: Gets the unique identifier (GUID) of the tenant which the sensitivity label is belonged.
|
|
89079
|
+
*
|
|
89080
|
+
* @remarks
|
|
89081
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
89082
|
+
* @beta
|
|
89083
|
+
*/
|
|
89084
|
+
siteId?: boolean;
|
|
89085
|
+
/**
|
|
89086
|
+
* For EACH ITEM in the collection: Gets the description of the sensitivity label.
|
|
89087
|
+
*
|
|
89088
|
+
* @remarks
|
|
89089
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
89090
|
+
* @beta
|
|
89091
|
+
*/
|
|
89092
|
+
tooltip?: boolean;
|
|
89093
|
+
}
|
|
89094
|
+
/**
|
|
89095
|
+
* 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.
|
|
89096
|
+
*
|
|
89097
|
+
* @remarks
|
|
89098
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
89099
|
+
* @beta
|
|
89100
|
+
*/
|
|
89101
|
+
interface SensitivityLabelsCatalogLoadOptions {
|
|
89102
|
+
/**
|
|
89103
|
+
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`).
|
|
89104
|
+
*/
|
|
89105
|
+
$all?: boolean;
|
|
89106
|
+
/**
|
|
89107
|
+
* Gets whether the catalog of sensitivity labels is enabled in Excel.
|
|
89108
|
+
*
|
|
89109
|
+
* @remarks
|
|
89110
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
89111
|
+
* @beta
|
|
89112
|
+
*/
|
|
89113
|
+
getLabelingCapability?: boolean;
|
|
89114
|
+
}
|
|
88341
89115
|
/**
|
|
88342
89116
|
* Represents an `AllowEditRange` object found in a worksheet. This object works with worksheet protection properties.
|
|
88343
89117
|
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 {
|
|
|
108033
108807
|
* [Api set: WordApiDesktop 1.4]
|
|
108034
108808
|
*/
|
|
108035
108809
|
readonly selection: Word.Selection;
|
|
108810
|
+
/**
|
|
108811
|
+
* Returns the sensitivity label of the document.
|
|
108812
|
+
*
|
|
108813
|
+
* @remarks
|
|
108814
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
108815
|
+
* @beta
|
|
108816
|
+
*/
|
|
108817
|
+
readonly sensitivityLabel: Word.SensitivityLabel;
|
|
108036
108818
|
/**
|
|
108037
108819
|
* Gets the `RangeScopedCollection` object that represents all the sentences in the document.
|
|
108038
108820
|
*
|
|
@@ -116630,6 +117412,318 @@ declare namespace Word {
|
|
|
116630
117412
|
*/
|
|
116631
117413
|
toJSON(): Word.Interfaces.SectionCollectionData;
|
|
116632
117414
|
}
|
|
117415
|
+
/**
|
|
117416
|
+
* Represents the sensitivity label on the document.
|
|
117417
|
+
*
|
|
117418
|
+
* @remarks
|
|
117419
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117420
|
+
* @beta
|
|
117421
|
+
*/
|
|
117422
|
+
class SensitivityLabel extends OfficeExtension.ClientObject {
|
|
117423
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
117424
|
+
context: RequestContext;
|
|
117425
|
+
/**
|
|
117426
|
+
* Gets the current label information that exists on the document for the user.
|
|
117427
|
+
*
|
|
117428
|
+
* @remarks
|
|
117429
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117430
|
+
* @beta
|
|
117431
|
+
*/
|
|
117432
|
+
getCurrentOrNullObject(): Word.SensitivityLabelDetails;
|
|
117433
|
+
/**
|
|
117434
|
+
* Try to update to the provided sensitivity label on the document for the user.
|
|
117435
|
+
*
|
|
117436
|
+
* @remarks
|
|
117437
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117438
|
+
* @beta
|
|
117439
|
+
*
|
|
117440
|
+
* @param LabelId The label information that needs to be set on the document.
|
|
117441
|
+
* @param Justification Optional. The justification of changing the label.
|
|
117442
|
+
*/
|
|
117443
|
+
tryToUpdate(LabelId: string, Justification?: string): OfficeExtension.ClientResult<Word.SensitivityLabelUpdateResult>;
|
|
117444
|
+
/**
|
|
117445
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
117446
|
+
*
|
|
117447
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
117448
|
+
*/
|
|
117449
|
+
load(propertyNames?: string | string[]): Word.SensitivityLabel;
|
|
117450
|
+
/**
|
|
117451
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
117452
|
+
*
|
|
117453
|
+
* @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.
|
|
117454
|
+
*/
|
|
117455
|
+
load(propertyNamesAndPaths?: {
|
|
117456
|
+
select?: string;
|
|
117457
|
+
expand?: string;
|
|
117458
|
+
}): Word.SensitivityLabel;
|
|
117459
|
+
/**
|
|
117460
|
+
* 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.
|
|
117461
|
+
*/
|
|
117462
|
+
track(): Word.SensitivityLabel;
|
|
117463
|
+
/**
|
|
117464
|
+
* 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.
|
|
117465
|
+
*/
|
|
117466
|
+
untrack(): Word.SensitivityLabel;
|
|
117467
|
+
/**
|
|
117468
|
+
* 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.)
|
|
117469
|
+
* 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.
|
|
117470
|
+
*/
|
|
117471
|
+
toJSON(): {
|
|
117472
|
+
[key: string]: string;
|
|
117473
|
+
};
|
|
117474
|
+
}
|
|
117475
|
+
/**
|
|
117476
|
+
* 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.
|
|
117477
|
+
*
|
|
117478
|
+
* @remarks
|
|
117479
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117480
|
+
* @beta
|
|
117481
|
+
*/
|
|
117482
|
+
class SensitivityLabelsCatalog extends OfficeExtension.ClientObject {
|
|
117483
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
117484
|
+
context: RequestContext;
|
|
117485
|
+
/**
|
|
117486
|
+
* Gets the labeling capability status of the sensitivity label catalog in Word.
|
|
117487
|
+
*
|
|
117488
|
+
* @remarks
|
|
117489
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117490
|
+
* @beta
|
|
117491
|
+
*/
|
|
117492
|
+
readonly getLabelingCapability: Word.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled";
|
|
117493
|
+
/**
|
|
117494
|
+
* Gets all the sensitivity labels that are enabled in Word.
|
|
117495
|
+
*
|
|
117496
|
+
* @remarks
|
|
117497
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117498
|
+
* @beta
|
|
117499
|
+
*/
|
|
117500
|
+
getLabels(): Word.SensitivityLabelDetailsCollection;
|
|
117501
|
+
/**
|
|
117502
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
117503
|
+
*
|
|
117504
|
+
* @param options Provides options for which properties of the object to load.
|
|
117505
|
+
*/
|
|
117506
|
+
load(options?: Word.Interfaces.SensitivityLabelsCatalogLoadOptions): Word.SensitivityLabelsCatalog;
|
|
117507
|
+
/**
|
|
117508
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
117509
|
+
*
|
|
117510
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
117511
|
+
*/
|
|
117512
|
+
load(propertyNames?: string | string[]): Word.SensitivityLabelsCatalog;
|
|
117513
|
+
/**
|
|
117514
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
117515
|
+
*
|
|
117516
|
+
* @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.
|
|
117517
|
+
*/
|
|
117518
|
+
load(propertyNamesAndPaths?: {
|
|
117519
|
+
select?: string;
|
|
117520
|
+
expand?: string;
|
|
117521
|
+
}): Word.SensitivityLabelsCatalog;
|
|
117522
|
+
/**
|
|
117523
|
+
* Create a new instance of the `Word.SensitivityLabelsCatalog` object.
|
|
117524
|
+
*/
|
|
117525
|
+
static newObject(context: OfficeExtension.ClientRequestContext): Word.SensitivityLabelsCatalog;
|
|
117526
|
+
/**
|
|
117527
|
+
* 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.
|
|
117528
|
+
*/
|
|
117529
|
+
track(): Word.SensitivityLabelsCatalog;
|
|
117530
|
+
/**
|
|
117531
|
+
* 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.
|
|
117532
|
+
*/
|
|
117533
|
+
untrack(): Word.SensitivityLabelsCatalog;
|
|
117534
|
+
/**
|
|
117535
|
+
* 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.)
|
|
117536
|
+
* 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.
|
|
117537
|
+
*/
|
|
117538
|
+
toJSON(): Word.Interfaces.SensitivityLabelsCatalogData;
|
|
117539
|
+
}
|
|
117540
|
+
/**
|
|
117541
|
+
* Represents the collection of {@link Word.SensitivityLabelDetails} objects.
|
|
117542
|
+
*
|
|
117543
|
+
* @remarks
|
|
117544
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117545
|
+
* @beta
|
|
117546
|
+
*/
|
|
117547
|
+
class SensitivityLabelDetailsCollection extends OfficeExtension.ClientObject {
|
|
117548
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
117549
|
+
context: RequestContext;
|
|
117550
|
+
/** Gets the loaded child items in this collection. */
|
|
117551
|
+
readonly items: Word.SensitivityLabelDetails[];
|
|
117552
|
+
/**
|
|
117553
|
+
* Gets the first `SensitivityLabelDetails` object in this collection. Throws an `ItemNotFound` error if this collection is empty.
|
|
117554
|
+
*
|
|
117555
|
+
* @remarks
|
|
117556
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117557
|
+
* @beta
|
|
117558
|
+
*/
|
|
117559
|
+
getFirst(): Word.SensitivityLabelDetails;
|
|
117560
|
+
/**
|
|
117561
|
+
* 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}.
|
|
117562
|
+
*
|
|
117563
|
+
* @remarks
|
|
117564
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117565
|
+
* @beta
|
|
117566
|
+
*/
|
|
117567
|
+
getFirstOrNullObject(): Word.SensitivityLabelDetails;
|
|
117568
|
+
/**
|
|
117569
|
+
* Gets a `SensitivityLabelDetails` object by its index in the collection.
|
|
117570
|
+
*
|
|
117571
|
+
* @remarks
|
|
117572
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117573
|
+
* @beta
|
|
117574
|
+
*
|
|
117575
|
+
* @param index A number that identifies the index location of a `SensitivityLabelDetails` object.
|
|
117576
|
+
*/
|
|
117577
|
+
getItem(index: number): Word.SensitivityLabelDetails;
|
|
117578
|
+
/**
|
|
117579
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
117580
|
+
*
|
|
117581
|
+
* @param options Provides options for which properties of the object to load.
|
|
117582
|
+
*/
|
|
117583
|
+
load(options?: Word.Interfaces.SensitivityLabelDetailsCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SensitivityLabelDetailsCollection;
|
|
117584
|
+
/**
|
|
117585
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
117586
|
+
*
|
|
117587
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
117588
|
+
*/
|
|
117589
|
+
load(propertyNames?: string | string[]): Word.SensitivityLabelDetailsCollection;
|
|
117590
|
+
/**
|
|
117591
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
117592
|
+
*
|
|
117593
|
+
* @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.
|
|
117594
|
+
*/
|
|
117595
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.SensitivityLabelDetailsCollection;
|
|
117596
|
+
/**
|
|
117597
|
+
* 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.
|
|
117598
|
+
*/
|
|
117599
|
+
track(): Word.SensitivityLabelDetailsCollection;
|
|
117600
|
+
/**
|
|
117601
|
+
* 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.
|
|
117602
|
+
*/
|
|
117603
|
+
untrack(): Word.SensitivityLabelDetailsCollection;
|
|
117604
|
+
/**
|
|
117605
|
+
* 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.)
|
|
117606
|
+
* 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.
|
|
117607
|
+
*/
|
|
117608
|
+
toJSON(): Word.Interfaces.SensitivityLabelDetailsCollectionData;
|
|
117609
|
+
}
|
|
117610
|
+
/**
|
|
117611
|
+
* Represents the properties of available sensitivity labels in Word.
|
|
117612
|
+
*
|
|
117613
|
+
* @remarks
|
|
117614
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117615
|
+
* @beta
|
|
117616
|
+
*/
|
|
117617
|
+
class SensitivityLabelDetails extends OfficeExtension.ClientObject {
|
|
117618
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
117619
|
+
context: RequestContext;
|
|
117620
|
+
/**
|
|
117621
|
+
* The sublabels of the sensitivity label. Returns null if a label doesn't have any sublabels.
|
|
117622
|
+
*
|
|
117623
|
+
* @remarks
|
|
117624
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117625
|
+
* @beta
|
|
117626
|
+
*/
|
|
117627
|
+
readonly children: Word.SensitivityLabelDetailsCollection;
|
|
117628
|
+
/**
|
|
117629
|
+
* The color of the sensitivity label.
|
|
117630
|
+
*
|
|
117631
|
+
* @remarks
|
|
117632
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117633
|
+
* @beta
|
|
117634
|
+
*/
|
|
117635
|
+
readonly color: string;
|
|
117636
|
+
/**
|
|
117637
|
+
* The unique identifier (GUID) of the sensitivity label.
|
|
117638
|
+
*
|
|
117639
|
+
* @remarks
|
|
117640
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117641
|
+
* @beta
|
|
117642
|
+
*/
|
|
117643
|
+
readonly id: string;
|
|
117644
|
+
/**
|
|
117645
|
+
* Gets a value indicating whether the label is enabled.
|
|
117646
|
+
*
|
|
117647
|
+
* @remarks
|
|
117648
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117649
|
+
* @beta
|
|
117650
|
+
*/
|
|
117651
|
+
readonly isEnabled: boolean;
|
|
117652
|
+
/**
|
|
117653
|
+
* The name of the sensitivity label.
|
|
117654
|
+
*
|
|
117655
|
+
* @remarks
|
|
117656
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117657
|
+
* @beta
|
|
117658
|
+
*/
|
|
117659
|
+
readonly name: string;
|
|
117660
|
+
/**
|
|
117661
|
+
* The order of the sensitivity label.
|
|
117662
|
+
*
|
|
117663
|
+
* @remarks
|
|
117664
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117665
|
+
* @beta
|
|
117666
|
+
*/
|
|
117667
|
+
readonly order: number;
|
|
117668
|
+
/**
|
|
117669
|
+
* Gets a value indicating the protection type provided by this label.
|
|
117670
|
+
*
|
|
117671
|
+
* @remarks
|
|
117672
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117673
|
+
* @beta
|
|
117674
|
+
*/
|
|
117675
|
+
readonly protectionType: Word.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined";
|
|
117676
|
+
/**
|
|
117677
|
+
* The unique identifier (GUID) of the tenant which the sensitivity label is belonged.
|
|
117678
|
+
*
|
|
117679
|
+
* @remarks
|
|
117680
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117681
|
+
* @beta
|
|
117682
|
+
*/
|
|
117683
|
+
readonly siteId: string;
|
|
117684
|
+
/**
|
|
117685
|
+
* The description of the sensitivity label.
|
|
117686
|
+
*
|
|
117687
|
+
* @remarks
|
|
117688
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117689
|
+
* @beta
|
|
117690
|
+
*/
|
|
117691
|
+
readonly tooltip: string;
|
|
117692
|
+
/**
|
|
117693
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
117694
|
+
*
|
|
117695
|
+
* @param options Provides options for which properties of the object to load.
|
|
117696
|
+
*/
|
|
117697
|
+
load(options?: Word.Interfaces.SensitivityLabelDetailsLoadOptions): Word.SensitivityLabelDetails;
|
|
117698
|
+
/**
|
|
117699
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
117700
|
+
*
|
|
117701
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
117702
|
+
*/
|
|
117703
|
+
load(propertyNames?: string | string[]): Word.SensitivityLabelDetails;
|
|
117704
|
+
/**
|
|
117705
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
117706
|
+
*
|
|
117707
|
+
* @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.
|
|
117708
|
+
*/
|
|
117709
|
+
load(propertyNamesAndPaths?: {
|
|
117710
|
+
select?: string;
|
|
117711
|
+
expand?: string;
|
|
117712
|
+
}): Word.SensitivityLabelDetails;
|
|
117713
|
+
/**
|
|
117714
|
+
* 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.
|
|
117715
|
+
*/
|
|
117716
|
+
track(): Word.SensitivityLabelDetails;
|
|
117717
|
+
/**
|
|
117718
|
+
* 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.
|
|
117719
|
+
*/
|
|
117720
|
+
untrack(): Word.SensitivityLabelDetails;
|
|
117721
|
+
/**
|
|
117722
|
+
* 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.)
|
|
117723
|
+
* 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.
|
|
117724
|
+
*/
|
|
117725
|
+
toJSON(): Word.Interfaces.SensitivityLabelDetailsData;
|
|
117726
|
+
}
|
|
116633
117727
|
/**
|
|
116634
117728
|
* Represents a setting of the add-in.
|
|
116635
117729
|
*
|
|
@@ -148787,6 +149881,159 @@ declare namespace Word {
|
|
|
148787
149881
|
*/
|
|
148788
149882
|
owners = "Owners",
|
|
148789
149883
|
}
|
|
149884
|
+
/**
|
|
149885
|
+
* Represents the result of updating the sensitivity label on the document.
|
|
149886
|
+
*
|
|
149887
|
+
* @remarks
|
|
149888
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149889
|
+
* @beta
|
|
149890
|
+
*/
|
|
149891
|
+
enum SensitivityLabelUpdateResult {
|
|
149892
|
+
/**
|
|
149893
|
+
* The sensitivity label was successfully updated.
|
|
149894
|
+
* @remarks
|
|
149895
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149896
|
+
* @beta
|
|
149897
|
+
*/
|
|
149898
|
+
success = "Success",
|
|
149899
|
+
/**
|
|
149900
|
+
* The update failed due to an unspecified error.
|
|
149901
|
+
* @remarks
|
|
149902
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149903
|
+
* @beta
|
|
149904
|
+
*/
|
|
149905
|
+
unspecifiedFailure = "UnspecifiedFailure",
|
|
149906
|
+
/**
|
|
149907
|
+
* The specified sensitivity label could not be found.
|
|
149908
|
+
* @remarks
|
|
149909
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149910
|
+
* @beta
|
|
149911
|
+
*/
|
|
149912
|
+
labelNotFound = "LabelNotFound",
|
|
149913
|
+
/**
|
|
149914
|
+
* The document is read-only and cannot be modified.
|
|
149915
|
+
* @remarks
|
|
149916
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149917
|
+
* @beta
|
|
149918
|
+
*/
|
|
149919
|
+
documentReadOnly = "DocumentReadOnly",
|
|
149920
|
+
/**
|
|
149921
|
+
* The user does not have sufficient permissions to update the label.
|
|
149922
|
+
* @remarks
|
|
149923
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149924
|
+
* @beta
|
|
149925
|
+
*/
|
|
149926
|
+
insufficientPermission = "InsufficientPermission",
|
|
149927
|
+
/**
|
|
149928
|
+
* The label update failed due to unsupported Double Key Encryption (DKE).
|
|
149929
|
+
* @remarks
|
|
149930
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149931
|
+
* @beta
|
|
149932
|
+
*/
|
|
149933
|
+
unsupportedDoubleKeyEncryption = "UnsupportedDoubleKeyEncryption",
|
|
149934
|
+
/**
|
|
149935
|
+
* The label update failed because native labeling is not enabled for the user or installed SKU.
|
|
149936
|
+
* @remarks
|
|
149937
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149938
|
+
* @beta
|
|
149939
|
+
*/
|
|
149940
|
+
labelingDisabled = "LabelingDisabled",
|
|
149941
|
+
/**
|
|
149942
|
+
* The label update failed because the user's identity is not valid for applying a label.
|
|
149943
|
+
* @remarks
|
|
149944
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149945
|
+
* @beta
|
|
149946
|
+
*/
|
|
149947
|
+
userNotFound = "UserNotFound",
|
|
149948
|
+
/**
|
|
149949
|
+
* The label update failed due to unsupported Universal Data Protection (UDP).
|
|
149950
|
+
* @remarks
|
|
149951
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149952
|
+
* @beta
|
|
149953
|
+
*/
|
|
149954
|
+
unsupportedUdp = "UnsupportedUdp",
|
|
149955
|
+
/**
|
|
149956
|
+
* The label update failed because the specified label is a parent label, which cannot be applied.
|
|
149957
|
+
* @remarks
|
|
149958
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149959
|
+
* @beta
|
|
149960
|
+
*/
|
|
149961
|
+
parentLabelNotSupported = "ParentLabelNotSupported",
|
|
149962
|
+
/**
|
|
149963
|
+
* The label update failed because the document doesn't belong to the same tenant as the user.
|
|
149964
|
+
* @remarks
|
|
149965
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149966
|
+
* @beta
|
|
149967
|
+
*/
|
|
149968
|
+
crossTenant = "CrossTenant",
|
|
149969
|
+
}
|
|
149970
|
+
/**
|
|
149971
|
+
* Represents the labeling capability status of the sensitivity label catalog.
|
|
149972
|
+
*
|
|
149973
|
+
* @remarks
|
|
149974
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149975
|
+
* @beta
|
|
149976
|
+
*/
|
|
149977
|
+
enum LabelingCapability {
|
|
149978
|
+
/**
|
|
149979
|
+
* No valid license is available for sensitivity labeling.
|
|
149980
|
+
* @remarks
|
|
149981
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149982
|
+
* @beta
|
|
149983
|
+
*/
|
|
149984
|
+
noLicense = "NoLicense",
|
|
149985
|
+
/**
|
|
149986
|
+
* Sensitivity labeling is disabled for the user or tenant.
|
|
149987
|
+
* @remarks
|
|
149988
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149989
|
+
* @beta
|
|
149990
|
+
*/
|
|
149991
|
+
labelingDisabled = "LabelingDisabled",
|
|
149992
|
+
/**
|
|
149993
|
+
* No labeling policy was found for the user.
|
|
149994
|
+
* @remarks
|
|
149995
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149996
|
+
* @beta
|
|
149997
|
+
*/
|
|
149998
|
+
labelingPolicyNotFound = "LabelingPolicyNotFound",
|
|
149999
|
+
/**
|
|
150000
|
+
* Sensitivity labeling is fully enabled.
|
|
150001
|
+
* @remarks
|
|
150002
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
150003
|
+
* @beta
|
|
150004
|
+
*/
|
|
150005
|
+
labelingEnabled = "LabelingEnabled",
|
|
150006
|
+
}
|
|
150007
|
+
/**
|
|
150008
|
+
* Specifies the type of protection applied by a sensitivity label.
|
|
150009
|
+
*
|
|
150010
|
+
* @remarks
|
|
150011
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
150012
|
+
* @beta
|
|
150013
|
+
*/
|
|
150014
|
+
enum SensitivityLabelProtectionType {
|
|
150015
|
+
/**
|
|
150016
|
+
* The label applies no protection.
|
|
150017
|
+
* @remarks
|
|
150018
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
150019
|
+
* @beta
|
|
150020
|
+
*/
|
|
150021
|
+
noProtection = "NoProtection",
|
|
150022
|
+
/**
|
|
150023
|
+
* The label applies admin-defined protection.
|
|
150024
|
+
* @remarks
|
|
150025
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
150026
|
+
* @beta
|
|
150027
|
+
*/
|
|
150028
|
+
adminDefined = "AdminDefined",
|
|
150029
|
+
/**
|
|
150030
|
+
* The label applies user-defined protection.
|
|
150031
|
+
* @remarks
|
|
150032
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
150033
|
+
* @beta
|
|
150034
|
+
*/
|
|
150035
|
+
userDefined = "UserDefined",
|
|
150036
|
+
}
|
|
148790
150037
|
enum ErrorCodes {
|
|
148791
150038
|
accessDenied = "AccessDenied",
|
|
148792
150039
|
generalException = "GeneralException",
|
|
@@ -151525,6 +152772,10 @@ declare namespace Word {
|
|
|
151525
152772
|
interface SectionCollectionUpdateData {
|
|
151526
152773
|
items?: Word.Interfaces.SectionData[];
|
|
151527
152774
|
}
|
|
152775
|
+
/** An interface for updating data on the `SensitivityLabelDetailsCollection` object, for use in `sensitivityLabelDetailsCollection.set({ ... })`. */
|
|
152776
|
+
interface SensitivityLabelDetailsCollectionUpdateData {
|
|
152777
|
+
items?: Word.Interfaces.SensitivityLabelDetailsData[];
|
|
152778
|
+
}
|
|
151528
152779
|
/** An interface for updating data on the `Setting` object, for use in `setting.set({ ... })`. */
|
|
151529
152780
|
interface SettingUpdateData {
|
|
151530
152781
|
/**
|
|
@@ -158990,6 +160241,96 @@ declare namespace Word {
|
|
|
158990
160241
|
interface SectionCollectionData {
|
|
158991
160242
|
items?: Word.Interfaces.SectionData[];
|
|
158992
160243
|
}
|
|
160244
|
+
/** An interface describing the data returned by calling `sensitivityLabelsCatalog.toJSON()`. */
|
|
160245
|
+
interface SensitivityLabelsCatalogData {
|
|
160246
|
+
/**
|
|
160247
|
+
* Gets the labeling capability status of the sensitivity label catalog in Word.
|
|
160248
|
+
*
|
|
160249
|
+
* @remarks
|
|
160250
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
160251
|
+
* @beta
|
|
160252
|
+
*/
|
|
160253
|
+
getLabelingCapability?: Word.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled";
|
|
160254
|
+
}
|
|
160255
|
+
/** An interface describing the data returned by calling `sensitivityLabelDetailsCollection.toJSON()`. */
|
|
160256
|
+
interface SensitivityLabelDetailsCollectionData {
|
|
160257
|
+
items?: Word.Interfaces.SensitivityLabelDetailsData[];
|
|
160258
|
+
}
|
|
160259
|
+
/** An interface describing the data returned by calling `sensitivityLabelDetails.toJSON()`. */
|
|
160260
|
+
interface SensitivityLabelDetailsData {
|
|
160261
|
+
/**
|
|
160262
|
+
* The sublabels of the sensitivity label. Returns null if a label doesn't have any sublabels.
|
|
160263
|
+
*
|
|
160264
|
+
* @remarks
|
|
160265
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
160266
|
+
* @beta
|
|
160267
|
+
*/
|
|
160268
|
+
children?: Word.Interfaces.SensitivityLabelDetailsData[];
|
|
160269
|
+
/**
|
|
160270
|
+
* The color of the sensitivity label.
|
|
160271
|
+
*
|
|
160272
|
+
* @remarks
|
|
160273
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
160274
|
+
* @beta
|
|
160275
|
+
*/
|
|
160276
|
+
color?: string;
|
|
160277
|
+
/**
|
|
160278
|
+
* The unique identifier (GUID) of the sensitivity label.
|
|
160279
|
+
*
|
|
160280
|
+
* @remarks
|
|
160281
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
160282
|
+
* @beta
|
|
160283
|
+
*/
|
|
160284
|
+
id?: string;
|
|
160285
|
+
/**
|
|
160286
|
+
* Gets a value indicating whether the label is enabled.
|
|
160287
|
+
*
|
|
160288
|
+
* @remarks
|
|
160289
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
160290
|
+
* @beta
|
|
160291
|
+
*/
|
|
160292
|
+
isEnabled?: boolean;
|
|
160293
|
+
/**
|
|
160294
|
+
* The name of the sensitivity label.
|
|
160295
|
+
*
|
|
160296
|
+
* @remarks
|
|
160297
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
160298
|
+
* @beta
|
|
160299
|
+
*/
|
|
160300
|
+
name?: string;
|
|
160301
|
+
/**
|
|
160302
|
+
* The order of the sensitivity label.
|
|
160303
|
+
*
|
|
160304
|
+
* @remarks
|
|
160305
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
160306
|
+
* @beta
|
|
160307
|
+
*/
|
|
160308
|
+
order?: number;
|
|
160309
|
+
/**
|
|
160310
|
+
* Gets a value indicating the protection type provided by this label.
|
|
160311
|
+
*
|
|
160312
|
+
* @remarks
|
|
160313
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
160314
|
+
* @beta
|
|
160315
|
+
*/
|
|
160316
|
+
protectionType?: Word.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined";
|
|
160317
|
+
/**
|
|
160318
|
+
* The unique identifier (GUID) of the tenant which the sensitivity label is belonged.
|
|
160319
|
+
*
|
|
160320
|
+
* @remarks
|
|
160321
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
160322
|
+
* @beta
|
|
160323
|
+
*/
|
|
160324
|
+
siteId?: string;
|
|
160325
|
+
/**
|
|
160326
|
+
* The description of the sensitivity label.
|
|
160327
|
+
*
|
|
160328
|
+
* @remarks
|
|
160329
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
160330
|
+
* @beta
|
|
160331
|
+
*/
|
|
160332
|
+
tooltip?: string;
|
|
160333
|
+
}
|
|
158993
160334
|
/** An interface describing the data returned by calling `setting.toJSON()`. */
|
|
158994
160335
|
interface SettingData {
|
|
158995
160336
|
/**
|
|
@@ -170270,6 +171611,181 @@ declare namespace Word {
|
|
|
170270
171611
|
*/
|
|
170271
171612
|
protectedForForms?: boolean;
|
|
170272
171613
|
}
|
|
171614
|
+
/**
|
|
171615
|
+
* 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.
|
|
171616
|
+
*
|
|
171617
|
+
* @remarks
|
|
171618
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171619
|
+
* @beta
|
|
171620
|
+
*/
|
|
171621
|
+
interface SensitivityLabelsCatalogLoadOptions {
|
|
171622
|
+
/**
|
|
171623
|
+
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`).
|
|
171624
|
+
*/
|
|
171625
|
+
$all?: boolean;
|
|
171626
|
+
/**
|
|
171627
|
+
* Gets the labeling capability status of the sensitivity label catalog in Word.
|
|
171628
|
+
*
|
|
171629
|
+
* @remarks
|
|
171630
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171631
|
+
* @beta
|
|
171632
|
+
*/
|
|
171633
|
+
getLabelingCapability?: boolean;
|
|
171634
|
+
}
|
|
171635
|
+
/**
|
|
171636
|
+
* Represents the collection of {@link Word.SensitivityLabelDetails} objects.
|
|
171637
|
+
*
|
|
171638
|
+
* @remarks
|
|
171639
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171640
|
+
* @beta
|
|
171641
|
+
*/
|
|
171642
|
+
interface SensitivityLabelDetailsCollectionLoadOptions {
|
|
171643
|
+
/**
|
|
171644
|
+
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`).
|
|
171645
|
+
*/
|
|
171646
|
+
$all?: boolean;
|
|
171647
|
+
/**
|
|
171648
|
+
* For EACH ITEM in the collection: The color of the sensitivity label.
|
|
171649
|
+
*
|
|
171650
|
+
* @remarks
|
|
171651
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171652
|
+
* @beta
|
|
171653
|
+
*/
|
|
171654
|
+
color?: boolean;
|
|
171655
|
+
/**
|
|
171656
|
+
* For EACH ITEM in the collection: The unique identifier (GUID) of the sensitivity label.
|
|
171657
|
+
*
|
|
171658
|
+
* @remarks
|
|
171659
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171660
|
+
* @beta
|
|
171661
|
+
*/
|
|
171662
|
+
id?: boolean;
|
|
171663
|
+
/**
|
|
171664
|
+
* For EACH ITEM in the collection: Gets a value indicating whether the label is enabled.
|
|
171665
|
+
*
|
|
171666
|
+
* @remarks
|
|
171667
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171668
|
+
* @beta
|
|
171669
|
+
*/
|
|
171670
|
+
isEnabled?: boolean;
|
|
171671
|
+
/**
|
|
171672
|
+
* For EACH ITEM in the collection: The name of the sensitivity label.
|
|
171673
|
+
*
|
|
171674
|
+
* @remarks
|
|
171675
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171676
|
+
* @beta
|
|
171677
|
+
*/
|
|
171678
|
+
name?: boolean;
|
|
171679
|
+
/**
|
|
171680
|
+
* For EACH ITEM in the collection: The order of the sensitivity label.
|
|
171681
|
+
*
|
|
171682
|
+
* @remarks
|
|
171683
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171684
|
+
* @beta
|
|
171685
|
+
*/
|
|
171686
|
+
order?: boolean;
|
|
171687
|
+
/**
|
|
171688
|
+
* For EACH ITEM in the collection: Gets a value indicating the protection type provided by this label.
|
|
171689
|
+
*
|
|
171690
|
+
* @remarks
|
|
171691
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171692
|
+
* @beta
|
|
171693
|
+
*/
|
|
171694
|
+
protectionType?: boolean;
|
|
171695
|
+
/**
|
|
171696
|
+
* For EACH ITEM in the collection: The unique identifier (GUID) of the tenant which the sensitivity label is belonged.
|
|
171697
|
+
*
|
|
171698
|
+
* @remarks
|
|
171699
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171700
|
+
* @beta
|
|
171701
|
+
*/
|
|
171702
|
+
siteId?: boolean;
|
|
171703
|
+
/**
|
|
171704
|
+
* For EACH ITEM in the collection: The description of the sensitivity label.
|
|
171705
|
+
*
|
|
171706
|
+
* @remarks
|
|
171707
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171708
|
+
* @beta
|
|
171709
|
+
*/
|
|
171710
|
+
tooltip?: boolean;
|
|
171711
|
+
}
|
|
171712
|
+
/**
|
|
171713
|
+
* Represents the properties of available sensitivity labels in Word.
|
|
171714
|
+
*
|
|
171715
|
+
* @remarks
|
|
171716
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171717
|
+
* @beta
|
|
171718
|
+
*/
|
|
171719
|
+
interface SensitivityLabelDetailsLoadOptions {
|
|
171720
|
+
/**
|
|
171721
|
+
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`).
|
|
171722
|
+
*/
|
|
171723
|
+
$all?: boolean;
|
|
171724
|
+
/**
|
|
171725
|
+
* The color of the sensitivity label.
|
|
171726
|
+
*
|
|
171727
|
+
* @remarks
|
|
171728
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171729
|
+
* @beta
|
|
171730
|
+
*/
|
|
171731
|
+
color?: boolean;
|
|
171732
|
+
/**
|
|
171733
|
+
* The unique identifier (GUID) of the sensitivity label.
|
|
171734
|
+
*
|
|
171735
|
+
* @remarks
|
|
171736
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171737
|
+
* @beta
|
|
171738
|
+
*/
|
|
171739
|
+
id?: boolean;
|
|
171740
|
+
/**
|
|
171741
|
+
* Gets a value indicating whether the label is enabled.
|
|
171742
|
+
*
|
|
171743
|
+
* @remarks
|
|
171744
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171745
|
+
* @beta
|
|
171746
|
+
*/
|
|
171747
|
+
isEnabled?: boolean;
|
|
171748
|
+
/**
|
|
171749
|
+
* The name of the sensitivity label.
|
|
171750
|
+
*
|
|
171751
|
+
* @remarks
|
|
171752
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171753
|
+
* @beta
|
|
171754
|
+
*/
|
|
171755
|
+
name?: boolean;
|
|
171756
|
+
/**
|
|
171757
|
+
* The order of the sensitivity label.
|
|
171758
|
+
*
|
|
171759
|
+
* @remarks
|
|
171760
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171761
|
+
* @beta
|
|
171762
|
+
*/
|
|
171763
|
+
order?: boolean;
|
|
171764
|
+
/**
|
|
171765
|
+
* Gets a value indicating the protection type provided by this label.
|
|
171766
|
+
*
|
|
171767
|
+
* @remarks
|
|
171768
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171769
|
+
* @beta
|
|
171770
|
+
*/
|
|
171771
|
+
protectionType?: boolean;
|
|
171772
|
+
/**
|
|
171773
|
+
* The unique identifier (GUID) of the tenant which the sensitivity label is belonged.
|
|
171774
|
+
*
|
|
171775
|
+
* @remarks
|
|
171776
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171777
|
+
* @beta
|
|
171778
|
+
*/
|
|
171779
|
+
siteId?: boolean;
|
|
171780
|
+
/**
|
|
171781
|
+
* The description of the sensitivity label.
|
|
171782
|
+
*
|
|
171783
|
+
* @remarks
|
|
171784
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171785
|
+
* @beta
|
|
171786
|
+
*/
|
|
171787
|
+
tooltip?: boolean;
|
|
171788
|
+
}
|
|
170273
171789
|
/**
|
|
170274
171790
|
* Represents a setting of the add-in.
|
|
170275
171791
|
*
|
|
@@ -177583,6 +179099,7 @@ declare namespace Word {
|
|
|
177583
179099
|
constructor(url?: string);
|
|
177584
179100
|
readonly document: Document;
|
|
177585
179101
|
readonly application: Application;
|
|
179102
|
+
readonly sensitivityLabelsCatalog: SensitivityLabelsCatalog;
|
|
177586
179103
|
}
|
|
177587
179104
|
/**
|
|
177588
179105
|
* Executes a batch script that performs actions on the Word object model, using the RequestContext of previously created API objects.
|