@types/office-js-preview 1.0.703 → 1.0.704
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 +815 -105
- office-js-preview/package.json +2 -2
office-js-preview/README.md
CHANGED
|
@@ -8,7 +8,7 @@ This package contains type definitions for office-js-preview (https://github.com
|
|
|
8
8
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
|
|
9
9
|
|
|
10
10
|
### Additional Details
|
|
11
|
-
* Last updated:
|
|
11
|
+
* Last updated: Fri, 08 May 2026 18:49:38 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js-preview/index.d.ts
CHANGED
|
@@ -187967,6 +187967,65 @@ declare namespace PowerPoint {
|
|
|
187967
187967
|
[key: string]: string;
|
|
187968
187968
|
};
|
|
187969
187969
|
}
|
|
187970
|
+
/**
|
|
187971
|
+
* Provides methods to check the status of the catalog of sensitivity labels in PowerPoint
|
|
187972
|
+
and retrieve all available sensitivity labels if the catalog is enabled.
|
|
187973
|
+
*
|
|
187974
|
+
* @remarks
|
|
187975
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
187976
|
+
* @beta
|
|
187977
|
+
*/
|
|
187978
|
+
class SensitivityLabelsCatalog extends OfficeExtension.ClientObject {
|
|
187979
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
187980
|
+
context: RequestContext;
|
|
187981
|
+
/**
|
|
187982
|
+
* Gets whether the catalog of sensitivity labels is enabled in PowerPoint.
|
|
187983
|
+
*
|
|
187984
|
+
* @remarks
|
|
187985
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
187986
|
+
* @beta
|
|
187987
|
+
*/
|
|
187988
|
+
readonly getLabelingCapability: PowerPoint.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled";
|
|
187989
|
+
/**
|
|
187990
|
+
* Gets sensitivity labels that are available to the current user.
|
|
187991
|
+
*
|
|
187992
|
+
* @remarks
|
|
187993
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
187994
|
+
* @beta
|
|
187995
|
+
* @returns The current object.
|
|
187996
|
+
*/
|
|
187997
|
+
getLabels(): PowerPoint.SensitivityLabelDetailsCollection;
|
|
187998
|
+
/**
|
|
187999
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
188000
|
+
*
|
|
188001
|
+
* @param options Provides options for which properties of the object to load.
|
|
188002
|
+
*/
|
|
188003
|
+
load(options?: PowerPoint.Interfaces.SensitivityLabelsCatalogLoadOptions): PowerPoint.SensitivityLabelsCatalog;
|
|
188004
|
+
/**
|
|
188005
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
188006
|
+
*
|
|
188007
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
188008
|
+
*/
|
|
188009
|
+
load(propertyNames?: string | string[]): PowerPoint.SensitivityLabelsCatalog;
|
|
188010
|
+
/**
|
|
188011
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
188012
|
+
*
|
|
188013
|
+
* @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.
|
|
188014
|
+
*/
|
|
188015
|
+
load(propertyNamesAndPaths?: {
|
|
188016
|
+
select?: string;
|
|
188017
|
+
expand?: string;
|
|
188018
|
+
}): PowerPoint.SensitivityLabelsCatalog;
|
|
188019
|
+
/**
|
|
188020
|
+
* Create a new instance of the `PowerPoint.SensitivityLabelsCatalog` object.
|
|
188021
|
+
*/
|
|
188022
|
+
static newObject(context: OfficeExtension.ClientRequestContext): PowerPoint.SensitivityLabelsCatalog;
|
|
188023
|
+
/**
|
|
188024
|
+
* 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.)
|
|
188025
|
+
* Whereas the original `PowerPoint.SensitivityLabelsCatalog` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SensitivityLabelsCatalogData`) that contains shallow copies of any loaded child properties from the original object.
|
|
188026
|
+
*/
|
|
188027
|
+
toJSON(): PowerPoint.Interfaces.SensitivityLabelsCatalogData;
|
|
188028
|
+
}
|
|
187970
188029
|
/**
|
|
187971
188030
|
* The `Presentation` object is the top-level object with one or more slides that contain the contents of the presentation.
|
|
187972
188031
|
To learn more about the PowerPoint object model,
|
|
@@ -188006,6 +188065,14 @@ declare namespace PowerPoint {
|
|
|
188006
188065
|
* [Api set: PowerPointApi 1.7]
|
|
188007
188066
|
*/
|
|
188008
188067
|
readonly properties: PowerPoint.DocumentProperties;
|
|
188068
|
+
/**
|
|
188069
|
+
* Returns the sensitivity label of the presentation.
|
|
188070
|
+
*
|
|
188071
|
+
* @remarks
|
|
188072
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
188073
|
+
* @beta
|
|
188074
|
+
*/
|
|
188075
|
+
readonly sensitivityLabel: PowerPoint.SensitivityLabel;
|
|
188009
188076
|
/**
|
|
188010
188077
|
* Returns the collection of `SlideMaster` objects that are in the presentation.
|
|
188011
188078
|
*
|
|
@@ -196789,6 +196856,43 @@ declare namespace PowerPoint {
|
|
|
196789
196856
|
*/
|
|
196790
196857
|
targetSlideId?: string;
|
|
196791
196858
|
}
|
|
196859
|
+
/**
|
|
196860
|
+
* Indicates the labeling capability.
|
|
196861
|
+
*
|
|
196862
|
+
* @remarks
|
|
196863
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
196864
|
+
* @beta
|
|
196865
|
+
*/
|
|
196866
|
+
enum LabelingCapability {
|
|
196867
|
+
/**
|
|
196868
|
+
* Represents there's no valid licenses.
|
|
196869
|
+
* @remarks
|
|
196870
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
196871
|
+
* @beta
|
|
196872
|
+
*/
|
|
196873
|
+
noLicense = "NoLicense",
|
|
196874
|
+
/**
|
|
196875
|
+
* Represents labeling being disabled.
|
|
196876
|
+
* @remarks
|
|
196877
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
196878
|
+
* @beta
|
|
196879
|
+
*/
|
|
196880
|
+
labelingDisabled = "LabelingDisabled",
|
|
196881
|
+
/**
|
|
196882
|
+
* Represents labeling policy not found.
|
|
196883
|
+
* @remarks
|
|
196884
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
196885
|
+
* @beta
|
|
196886
|
+
*/
|
|
196887
|
+
labelingPolicyNotFound = "LabelingPolicyNotFound",
|
|
196888
|
+
/**
|
|
196889
|
+
* Represents labeling being enabled.
|
|
196890
|
+
* @remarks
|
|
196891
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
196892
|
+
* @beta
|
|
196893
|
+
*/
|
|
196894
|
+
labelingEnabled = "LabelingEnabled",
|
|
196895
|
+
}
|
|
196792
196896
|
/**
|
|
196793
196897
|
* Represents the page setup information for the presentation.
|
|
196794
196898
|
*
|
|
@@ -196840,217 +196944,560 @@ declare namespace PowerPoint {
|
|
|
196840
196944
|
toJSON(): PowerPoint.Interfaces.PageSetupData;
|
|
196841
196945
|
}
|
|
196842
196946
|
/**
|
|
196843
|
-
* Represents the collection of
|
|
196947
|
+
* Represents the collection of {@link PowerPoint.SensitivityLabelDetails} objects.
|
|
196844
196948
|
*
|
|
196845
196949
|
* @remarks
|
|
196846
|
-
* [Api set: PowerPointApi
|
|
196950
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
196951
|
+
* @beta
|
|
196847
196952
|
*/
|
|
196848
|
-
class
|
|
196953
|
+
class SensitivityLabelDetailsCollection extends OfficeExtension.ClientObject {
|
|
196849
196954
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
196850
196955
|
context: RequestContext;
|
|
196851
196956
|
/** Gets the loaded child items in this collection. */
|
|
196852
|
-
readonly items: PowerPoint.
|
|
196853
|
-
/**
|
|
196854
|
-
* Adds a new slide to the collection.
|
|
196855
|
-
*
|
|
196856
|
-
* @remarks
|
|
196857
|
-
* [Api set: PowerPointApi 1.3]
|
|
196858
|
-
*
|
|
196859
|
-
* @param options Optional. Options for configuring the properties of the new slide.
|
|
196860
|
-
*/
|
|
196861
|
-
add(options?: PowerPoint.AddSlideOptions): void;
|
|
196862
|
-
/**
|
|
196863
|
-
* Exports one or more slides found in this collection to their own presentation file, returned as Base64-encoded data.
|
|
196864
|
-
Throws an `InvalidArgument` exception if provided slide IDs or `Slide` objects are not found in this collection.
|
|
196865
|
-
*
|
|
196866
|
-
* @remarks
|
|
196867
|
-
* [Api set: PowerPointApi 1.10]
|
|
196868
|
-
*
|
|
196869
|
-
* @param values An array of slide IDs or `Slide` objects.
|
|
196870
|
-
* @returns A Base64-encoded string.
|
|
196871
|
-
*/
|
|
196872
|
-
exportAsBase64Presentation(values: Array<string | Slide>): OfficeExtension.ClientResult<string>;
|
|
196957
|
+
readonly items: PowerPoint.SensitivityLabelDetails[];
|
|
196873
196958
|
/**
|
|
196874
|
-
* Gets the number of
|
|
196959
|
+
* Gets the number of {@link PowerPoint.SensitivityLabelDetails} objects in this collection.
|
|
196875
196960
|
*
|
|
196876
196961
|
* @remarks
|
|
196877
|
-
* [Api set: PowerPointApi
|
|
196878
|
-
* @
|
|
196962
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
196963
|
+
* @beta
|
|
196964
|
+
* @returns The number of `SensitivityLabelDetails` objects.
|
|
196879
196965
|
*/
|
|
196880
196966
|
getCount(): OfficeExtension.ClientResult<number>;
|
|
196881
196967
|
/**
|
|
196882
|
-
* Gets
|
|
196968
|
+
* Gets the specified `SensitivityLabelDetails` object in this collection. Throws an `ItemNotFound` error if an item with the specified ID isn't found.
|
|
196883
196969
|
*
|
|
196884
196970
|
* @remarks
|
|
196885
|
-
* [Api set: PowerPointApi
|
|
196971
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
196972
|
+
* @beta
|
|
196886
196973
|
*
|
|
196887
|
-
* @param
|
|
196888
|
-
* @returns The
|
|
196974
|
+
* @param id The ID of the sensitivity label.
|
|
196975
|
+
* @returns The specified `SensitivityLabelDetails` object.
|
|
196889
196976
|
*/
|
|
196890
|
-
getItem(
|
|
196977
|
+
getItem(id: string): PowerPoint.SensitivityLabelDetails;
|
|
196891
196978
|
/**
|
|
196892
|
-
* Gets
|
|
196893
|
-
are shown in the presentation.
|
|
196979
|
+
* Gets the `SensitivityLabelDetails` object at the specified index in this collection. Throws an `IndexOutOfRange` error if the index is out of range.
|
|
196894
196980
|
*
|
|
196895
196981
|
* @remarks
|
|
196896
|
-
* [Api set: PowerPointApi
|
|
196982
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
196983
|
+
* @beta
|
|
196897
196984
|
*
|
|
196898
|
-
* @param index The index of the
|
|
196899
|
-
* @returns The
|
|
196985
|
+
* @param index The index of the item to retrieve. Zero-indexed.
|
|
196986
|
+
* @returns The `SensitivityLabelDetails` object at the specified index.
|
|
196900
196987
|
*/
|
|
196901
|
-
getItemAt(index: number): PowerPoint.
|
|
196988
|
+
getItemAt(index: number): PowerPoint.SensitivityLabelDetails;
|
|
196902
196989
|
/**
|
|
196903
|
-
* Gets
|
|
196904
|
-
{@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
196990
|
+
* Gets the specified `SensitivityLabelDetails` object in this collection. If an item with the specified ID isn't found, 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}.
|
|
196905
196991
|
*
|
|
196906
196992
|
* @remarks
|
|
196907
|
-
* [Api set: PowerPointApi
|
|
196993
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
196994
|
+
* @beta
|
|
196908
196995
|
*
|
|
196909
|
-
* @param id The ID of the
|
|
196910
|
-
* @returns The
|
|
196996
|
+
* @param id The ID of the sensitivity label.
|
|
196997
|
+
* @returns The specified `SensitivityLabelDetails` object.
|
|
196911
196998
|
*/
|
|
196912
|
-
getItemOrNullObject(id: string): PowerPoint.
|
|
196999
|
+
getItemOrNullObject(id: string): PowerPoint.SensitivityLabelDetails;
|
|
196913
197000
|
/**
|
|
196914
197001
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
196915
197002
|
*
|
|
196916
197003
|
* @param options Provides options for which properties of the object to load.
|
|
196917
197004
|
*/
|
|
196918
|
-
load(options?: PowerPoint.Interfaces.
|
|
197005
|
+
load(options?: PowerPoint.Interfaces.SensitivityLabelDetailsCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SensitivityLabelDetailsCollection;
|
|
196919
197006
|
/**
|
|
196920
197007
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
196921
197008
|
*
|
|
196922
197009
|
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
196923
197010
|
*/
|
|
196924
|
-
load(propertyNames?: string | string[]): PowerPoint.
|
|
197011
|
+
load(propertyNames?: string | string[]): PowerPoint.SensitivityLabelDetailsCollection;
|
|
196925
197012
|
/**
|
|
196926
197013
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
196927
197014
|
*
|
|
196928
197015
|
* @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.
|
|
196929
197016
|
*/
|
|
196930
|
-
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.
|
|
197017
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SensitivityLabelDetailsCollection;
|
|
196931
197018
|
/**
|
|
196932
197019
|
* 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.)
|
|
196933
|
-
* Whereas the original `PowerPoint.
|
|
197020
|
+
* Whereas the original `PowerPoint.SensitivityLabelDetailsCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SensitivityLabelDetailsCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
196934
197021
|
*/
|
|
196935
|
-
toJSON(): PowerPoint.Interfaces.
|
|
197022
|
+
toJSON(): PowerPoint.Interfaces.SensitivityLabelDetailsCollectionData;
|
|
196936
197023
|
}
|
|
196937
197024
|
/**
|
|
196938
|
-
* Represents
|
|
197025
|
+
* Represents the protection type.
|
|
196939
197026
|
*
|
|
196940
197027
|
* @remarks
|
|
196941
|
-
* [Api set: PowerPointApi
|
|
197028
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197029
|
+
* @beta
|
|
196942
197030
|
*/
|
|
196943
|
-
|
|
197031
|
+
enum SensitivityLabelProtectionType {
|
|
197032
|
+
/**
|
|
197033
|
+
* No protection is applied by this label.
|
|
197034
|
+
* @remarks
|
|
197035
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197036
|
+
* @beta
|
|
197037
|
+
*/
|
|
197038
|
+
noProtection = "NoProtection",
|
|
197039
|
+
/**
|
|
197040
|
+
* Protection is defined by an administrator.
|
|
197041
|
+
* @remarks
|
|
197042
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197043
|
+
* @beta
|
|
197044
|
+
*/
|
|
197045
|
+
adminDefined = "AdminDefined",
|
|
197046
|
+
/**
|
|
197047
|
+
* Protection is defined by the user.
|
|
197048
|
+
* @remarks
|
|
197049
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197050
|
+
* @beta
|
|
197051
|
+
*/
|
|
197052
|
+
userDefined = "UserDefined",
|
|
197053
|
+
}
|
|
197054
|
+
/**
|
|
197055
|
+
* Represents the properties of available sensitivity labels in PowerPoint.
|
|
197056
|
+
*
|
|
197057
|
+
* @remarks
|
|
197058
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197059
|
+
* @beta
|
|
197060
|
+
*/
|
|
197061
|
+
class SensitivityLabelDetails extends OfficeExtension.ClientObject {
|
|
196944
197062
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
196945
197063
|
context: RequestContext;
|
|
196946
|
-
/** Gets the loaded child items in this collection. */
|
|
196947
|
-
readonly items: PowerPoint.Slide[];
|
|
196948
197064
|
/**
|
|
196949
|
-
*
|
|
197065
|
+
* Gets the sublabels of the sensitivity label.
|
|
196950
197066
|
*
|
|
196951
197067
|
* @remarks
|
|
196952
|
-
* [Api set: PowerPointApi
|
|
196953
|
-
* @
|
|
197068
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197069
|
+
* @beta
|
|
196954
197070
|
*/
|
|
196955
|
-
|
|
197071
|
+
readonly children: PowerPoint.SensitivityLabelDetailsCollection;
|
|
196956
197072
|
/**
|
|
196957
|
-
* Gets the
|
|
197073
|
+
* Gets the color of the sensitivity label.
|
|
196958
197074
|
*
|
|
196959
197075
|
* @remarks
|
|
196960
|
-
* [Api set: PowerPointApi
|
|
196961
|
-
* @
|
|
197076
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197077
|
+
* @beta
|
|
196962
197078
|
*/
|
|
196963
|
-
|
|
197079
|
+
readonly color: string;
|
|
196964
197080
|
/**
|
|
196965
|
-
* Gets
|
|
197081
|
+
* Gets the unique ID of the sensitivity label.
|
|
196966
197082
|
*
|
|
196967
197083
|
* @remarks
|
|
196968
|
-
* [Api set: PowerPointApi
|
|
197084
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197085
|
+
* @beta
|
|
197086
|
+
*/
|
|
197087
|
+
readonly id: string;
|
|
197088
|
+
/**
|
|
197089
|
+
* Gets a value indicating whether the label is enabled.
|
|
196969
197090
|
*
|
|
196970
|
-
* @
|
|
196971
|
-
*
|
|
197091
|
+
* @remarks
|
|
197092
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197093
|
+
* @beta
|
|
196972
197094
|
*/
|
|
196973
|
-
|
|
197095
|
+
readonly isEnabled: boolean;
|
|
196974
197096
|
/**
|
|
196975
|
-
* Gets
|
|
197097
|
+
* Gets the name of the sensitivity label.
|
|
196976
197098
|
*
|
|
196977
197099
|
* @remarks
|
|
196978
|
-
* [Api set: PowerPointApi
|
|
197100
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197101
|
+
* @beta
|
|
197102
|
+
*/
|
|
197103
|
+
readonly name: string;
|
|
197104
|
+
/**
|
|
197105
|
+
* Gets the priority of the sensitivity label, with 0 as lowest priority.
|
|
196979
197106
|
*
|
|
196980
|
-
* @
|
|
196981
|
-
*
|
|
197107
|
+
* @remarks
|
|
197108
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197109
|
+
* @beta
|
|
196982
197110
|
*/
|
|
196983
|
-
|
|
197111
|
+
readonly order: number;
|
|
196984
197112
|
/**
|
|
196985
|
-
* Gets a
|
|
196986
|
-
{@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
197113
|
+
* Gets a value indicating the protection type provided by this label.
|
|
196987
197114
|
*
|
|
196988
197115
|
* @remarks
|
|
196989
|
-
* [Api set: PowerPointApi
|
|
197116
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197117
|
+
* @beta
|
|
197118
|
+
*/
|
|
197119
|
+
readonly protectionType: PowerPoint.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined";
|
|
197120
|
+
/**
|
|
197121
|
+
* Gets the unique ID of the tenant which the sensitivity label is belonged.
|
|
196990
197122
|
*
|
|
196991
|
-
* @
|
|
196992
|
-
*
|
|
197123
|
+
* @remarks
|
|
197124
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197125
|
+
* @beta
|
|
196993
197126
|
*/
|
|
196994
|
-
|
|
197127
|
+
readonly siteId: string;
|
|
197128
|
+
/**
|
|
197129
|
+
* Gets the description of the sensitivity label.
|
|
197130
|
+
*
|
|
197131
|
+
* @remarks
|
|
197132
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197133
|
+
* @beta
|
|
197134
|
+
*/
|
|
197135
|
+
readonly tooltip: string;
|
|
196995
197136
|
/**
|
|
196996
197137
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
196997
197138
|
*
|
|
196998
197139
|
* @param options Provides options for which properties of the object to load.
|
|
196999
197140
|
*/
|
|
197000
|
-
load(options?: PowerPoint.Interfaces.
|
|
197141
|
+
load(options?: PowerPoint.Interfaces.SensitivityLabelDetailsLoadOptions): PowerPoint.SensitivityLabelDetails;
|
|
197001
197142
|
/**
|
|
197002
197143
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
197003
197144
|
*
|
|
197004
197145
|
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
197005
197146
|
*/
|
|
197006
|
-
load(propertyNames?: string | string[]): PowerPoint.
|
|
197147
|
+
load(propertyNames?: string | string[]): PowerPoint.SensitivityLabelDetails;
|
|
197007
197148
|
/**
|
|
197008
197149
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
197009
197150
|
*
|
|
197010
197151
|
* @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.
|
|
197011
197152
|
*/
|
|
197012
|
-
load(propertyNamesAndPaths?:
|
|
197153
|
+
load(propertyNamesAndPaths?: {
|
|
197154
|
+
select?: string;
|
|
197155
|
+
expand?: string;
|
|
197156
|
+
}): PowerPoint.SensitivityLabelDetails;
|
|
197013
197157
|
/**
|
|
197014
197158
|
* 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.)
|
|
197015
|
-
* Whereas the original `PowerPoint.
|
|
197159
|
+
* Whereas the original `PowerPoint.SensitivityLabelDetails` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SensitivityLabelDetailsData`) that contains shallow copies of any loaded child properties from the original object.
|
|
197016
197160
|
*/
|
|
197017
|
-
toJSON(): PowerPoint.Interfaces.
|
|
197161
|
+
toJSON(): PowerPoint.Interfaces.SensitivityLabelDetailsData;
|
|
197018
197162
|
}
|
|
197019
197163
|
/**
|
|
197020
|
-
*
|
|
197164
|
+
* Represents the result of updating the sensitivity label on the presentation.
|
|
197021
197165
|
*
|
|
197022
197166
|
* @remarks
|
|
197023
197167
|
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197024
197168
|
* @beta
|
|
197025
197169
|
*/
|
|
197026
|
-
|
|
197170
|
+
enum SensitivityLabelUpdateResult {
|
|
197027
197171
|
/**
|
|
197028
|
-
*
|
|
197029
|
-
*
|
|
197172
|
+
* The sensitivity label was successfully updated.
|
|
197030
197173
|
* @remarks
|
|
197031
197174
|
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197032
197175
|
* @beta
|
|
197033
197176
|
*/
|
|
197034
|
-
|
|
197035
|
-
}
|
|
197036
|
-
/**
|
|
197037
|
-
* Represents the collection of Slide Masters in the presentation.
|
|
197038
|
-
*
|
|
197039
|
-
* @remarks
|
|
197040
|
-
* [Api set: PowerPointApi 1.3]
|
|
197041
|
-
*/
|
|
197042
|
-
class SlideMasterCollection extends OfficeExtension.ClientObject {
|
|
197043
|
-
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
197044
|
-
context: RequestContext;
|
|
197045
|
-
/** Gets the loaded child items in this collection. */
|
|
197046
|
-
readonly items: PowerPoint.SlideMaster[];
|
|
197177
|
+
success = "Success",
|
|
197047
197178
|
/**
|
|
197048
|
-
*
|
|
197049
|
-
*
|
|
197179
|
+
* The update failed due to an unspecified error.
|
|
197050
197180
|
* @remarks
|
|
197051
|
-
* [Api set: PowerPointApi
|
|
197052
|
-
* @
|
|
197053
|
-
*/
|
|
197181
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197182
|
+
* @beta
|
|
197183
|
+
*/
|
|
197184
|
+
unspecifiedFailure = "UnspecifiedFailure",
|
|
197185
|
+
/**
|
|
197186
|
+
* The specified sensitivity label could not be found.
|
|
197187
|
+
* @remarks
|
|
197188
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197189
|
+
* @beta
|
|
197190
|
+
*/
|
|
197191
|
+
labelNotFound = "LabelNotFound",
|
|
197192
|
+
/**
|
|
197193
|
+
* The presentation is read-only and cannot be modified.
|
|
197194
|
+
* @remarks
|
|
197195
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197196
|
+
* @beta
|
|
197197
|
+
*/
|
|
197198
|
+
documentReadOnly = "DocumentReadOnly",
|
|
197199
|
+
/**
|
|
197200
|
+
* The user does not have sufficient permissions to update the label.
|
|
197201
|
+
* @remarks
|
|
197202
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197203
|
+
* @beta
|
|
197204
|
+
*/
|
|
197205
|
+
insufficientPermission = "InsufficientPermission",
|
|
197206
|
+
/**
|
|
197207
|
+
* The label update failed due to unsupported Double Key Encryption (DKE).
|
|
197208
|
+
* @remarks
|
|
197209
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197210
|
+
* @beta
|
|
197211
|
+
*/
|
|
197212
|
+
unsupportedDoubleKeyEncryption = "UnsupportedDoubleKeyEncryption",
|
|
197213
|
+
/**
|
|
197214
|
+
* The label update failed because native labeling is not enabled for the user or installed SKU.
|
|
197215
|
+
* @remarks
|
|
197216
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197217
|
+
* @beta
|
|
197218
|
+
*/
|
|
197219
|
+
labelingDisabled = "LabelingDisabled",
|
|
197220
|
+
/**
|
|
197221
|
+
* The label update failed because the user's identity is not valid for applying a label.
|
|
197222
|
+
* @remarks
|
|
197223
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197224
|
+
* @beta
|
|
197225
|
+
*/
|
|
197226
|
+
userNotFound = "UserNotFound",
|
|
197227
|
+
/**
|
|
197228
|
+
* The label update failed due to unsupported User Defined Permissions (UDP).
|
|
197229
|
+
* @remarks
|
|
197230
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197231
|
+
* @beta
|
|
197232
|
+
*/
|
|
197233
|
+
unsupportedUdp = "UnsupportedUdp",
|
|
197234
|
+
/**
|
|
197235
|
+
* The label update failed because the specified label is a parent label, which cannot be applied.
|
|
197236
|
+
* @remarks
|
|
197237
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197238
|
+
* @beta
|
|
197239
|
+
*/
|
|
197240
|
+
parentLabelNotSupported = "ParentLabelNotSupported",
|
|
197241
|
+
/**
|
|
197242
|
+
* The label update failed because the document doesn't belong to the same tenant as the user.
|
|
197243
|
+
* @remarks
|
|
197244
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197245
|
+
* @beta
|
|
197246
|
+
*/
|
|
197247
|
+
crossTenant = "CrossTenant",
|
|
197248
|
+
}
|
|
197249
|
+
/**
|
|
197250
|
+
* Represents the sensitivity label on the presentation.
|
|
197251
|
+
*
|
|
197252
|
+
* @remarks
|
|
197253
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197254
|
+
* @beta
|
|
197255
|
+
*/
|
|
197256
|
+
class SensitivityLabel extends OfficeExtension.ClientObject {
|
|
197257
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
197258
|
+
context: RequestContext;
|
|
197259
|
+
/**
|
|
197260
|
+
* Gets the current label information that exists on the presentation for the user.
|
|
197261
|
+
If there's no sensitivity label on the current presentation, an object with an `isNullObject` property set to `true` is returned.
|
|
197262
|
+
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}.
|
|
197263
|
+
*
|
|
197264
|
+
* @remarks
|
|
197265
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197266
|
+
* @beta
|
|
197267
|
+
* @returns The current `SensitivityLabelDetails` object.
|
|
197268
|
+
*/
|
|
197269
|
+
getCurrentOrNullObject(): PowerPoint.SensitivityLabelDetails;
|
|
197270
|
+
/**
|
|
197271
|
+
* Tries to update to the provided sensitivity label on the presentation for the user.
|
|
197272
|
+
*
|
|
197273
|
+
* @remarks
|
|
197274
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197275
|
+
* @beta
|
|
197276
|
+
*
|
|
197277
|
+
* @param labelId The ID of the label to apply.
|
|
197278
|
+
* @returns The `SensitivityLabelUpdateResult` object.
|
|
197279
|
+
*/
|
|
197280
|
+
tryToUpdate(labelId: string): OfficeExtension.ClientResult<PowerPoint.SensitivityLabelUpdateResult>;
|
|
197281
|
+
/**
|
|
197282
|
+
* 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.)
|
|
197283
|
+
* Whereas the original `PowerPoint.SensitivityLabel` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SensitivityLabelData`) that contains shallow copies of any loaded child properties from the original object.
|
|
197284
|
+
*/
|
|
197285
|
+
toJSON(): {
|
|
197286
|
+
[key: string]: string;
|
|
197287
|
+
};
|
|
197288
|
+
}
|
|
197289
|
+
/**
|
|
197290
|
+
* Represents the collection of slides in the presentation.
|
|
197291
|
+
*
|
|
197292
|
+
* @remarks
|
|
197293
|
+
* [Api set: PowerPointApi 1.2]
|
|
197294
|
+
*/
|
|
197295
|
+
class SlideCollection extends OfficeExtension.ClientObject {
|
|
197296
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
197297
|
+
context: RequestContext;
|
|
197298
|
+
/** Gets the loaded child items in this collection. */
|
|
197299
|
+
readonly items: PowerPoint.Slide[];
|
|
197300
|
+
/**
|
|
197301
|
+
* Adds a new slide to the collection.
|
|
197302
|
+
*
|
|
197303
|
+
* @remarks
|
|
197304
|
+
* [Api set: PowerPointApi 1.3]
|
|
197305
|
+
*
|
|
197306
|
+
* @param options Optional. Options for configuring the properties of the new slide.
|
|
197307
|
+
*/
|
|
197308
|
+
add(options?: PowerPoint.AddSlideOptions): void;
|
|
197309
|
+
/**
|
|
197310
|
+
* Exports one or more slides found in this collection to their own presentation file, returned as Base64-encoded data.
|
|
197311
|
+
Throws an `InvalidArgument` exception if provided slide IDs or `Slide` objects are not found in this collection.
|
|
197312
|
+
*
|
|
197313
|
+
* @remarks
|
|
197314
|
+
* [Api set: PowerPointApi 1.10]
|
|
197315
|
+
*
|
|
197316
|
+
* @param values An array of slide IDs or `Slide` objects.
|
|
197317
|
+
* @returns A Base64-encoded string.
|
|
197318
|
+
*/
|
|
197319
|
+
exportAsBase64Presentation(values: Array<string | Slide>): OfficeExtension.ClientResult<string>;
|
|
197320
|
+
/**
|
|
197321
|
+
* Gets the number of slides in the collection.
|
|
197322
|
+
*
|
|
197323
|
+
* @remarks
|
|
197324
|
+
* [Api set: PowerPointApi 1.2]
|
|
197325
|
+
* @returns The number of slides in the collection.
|
|
197326
|
+
*/
|
|
197327
|
+
getCount(): OfficeExtension.ClientResult<number>;
|
|
197328
|
+
/**
|
|
197329
|
+
* Gets a slide using its unique ID.
|
|
197330
|
+
*
|
|
197331
|
+
* @remarks
|
|
197332
|
+
* [Api set: PowerPointApi 1.2]
|
|
197333
|
+
*
|
|
197334
|
+
* @param key The ID of the slide.
|
|
197335
|
+
* @returns The slide with the unique ID. If such a slide doesn't exist, an error is thrown.
|
|
197336
|
+
*/
|
|
197337
|
+
getItem(key: string): PowerPoint.Slide;
|
|
197338
|
+
/**
|
|
197339
|
+
* Gets a slide using its zero-based index in the collection. Slides are stored in the same order as they
|
|
197340
|
+
are shown in the presentation.
|
|
197341
|
+
*
|
|
197342
|
+
* @remarks
|
|
197343
|
+
* [Api set: PowerPointApi 1.2]
|
|
197344
|
+
*
|
|
197345
|
+
* @param index The index of the slide in the collection.
|
|
197346
|
+
* @returns The slide at the given index. An error is thrown if index is out of range.
|
|
197347
|
+
*/
|
|
197348
|
+
getItemAt(index: number): PowerPoint.Slide;
|
|
197349
|
+
/**
|
|
197350
|
+
* Gets a slide using its unique ID. If such a slide doesn't exist, an object with an `isNullObject` property set to true is returned. For further information, see
|
|
197351
|
+
{@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
197352
|
+
*
|
|
197353
|
+
* @remarks
|
|
197354
|
+
* [Api set: PowerPointApi 1.2]
|
|
197355
|
+
*
|
|
197356
|
+
* @param id The ID of the slide.
|
|
197357
|
+
* @returns The slide with the unique ID.
|
|
197358
|
+
*/
|
|
197359
|
+
getItemOrNullObject(id: string): PowerPoint.Slide;
|
|
197360
|
+
/**
|
|
197361
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
197362
|
+
*
|
|
197363
|
+
* @param options Provides options for which properties of the object to load.
|
|
197364
|
+
*/
|
|
197365
|
+
load(options?: PowerPoint.Interfaces.SlideCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideCollection;
|
|
197366
|
+
/**
|
|
197367
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
197368
|
+
*
|
|
197369
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
197370
|
+
*/
|
|
197371
|
+
load(propertyNames?: string | string[]): PowerPoint.SlideCollection;
|
|
197372
|
+
/**
|
|
197373
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
197374
|
+
*
|
|
197375
|
+
* @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.
|
|
197376
|
+
*/
|
|
197377
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideCollection;
|
|
197378
|
+
/**
|
|
197379
|
+
* 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.)
|
|
197380
|
+
* Whereas the original `PowerPoint.SlideCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
197381
|
+
*/
|
|
197382
|
+
toJSON(): PowerPoint.Interfaces.SlideCollectionData;
|
|
197383
|
+
}
|
|
197384
|
+
/**
|
|
197385
|
+
* Represents a collection of slides in the presentation.
|
|
197386
|
+
*
|
|
197387
|
+
* @remarks
|
|
197388
|
+
* [Api set: PowerPointApi 1.5]
|
|
197389
|
+
*/
|
|
197390
|
+
class SlideScopedCollection extends OfficeExtension.ClientObject {
|
|
197391
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
197392
|
+
context: RequestContext;
|
|
197393
|
+
/** Gets the loaded child items in this collection. */
|
|
197394
|
+
readonly items: PowerPoint.Slide[];
|
|
197395
|
+
/**
|
|
197396
|
+
* Exports all slides in this collection to their own presentation file, returned as Base64-encoded data.
|
|
197397
|
+
*
|
|
197398
|
+
* @remarks
|
|
197399
|
+
* [Api set: PowerPointApi 1.10]
|
|
197400
|
+
* @returns A Base64-encoded string.
|
|
197401
|
+
*/
|
|
197402
|
+
exportAsBase64Presentation(): OfficeExtension.ClientResult<string>;
|
|
197403
|
+
/**
|
|
197404
|
+
* Gets the number of slides in the collection.
|
|
197405
|
+
*
|
|
197406
|
+
* @remarks
|
|
197407
|
+
* [Api set: PowerPointApi 1.5]
|
|
197408
|
+
* @returns The number of slides in the collection.
|
|
197409
|
+
*/
|
|
197410
|
+
getCount(): OfficeExtension.ClientResult<number>;
|
|
197411
|
+
/**
|
|
197412
|
+
* Gets a slide using its unique ID.
|
|
197413
|
+
*
|
|
197414
|
+
* @remarks
|
|
197415
|
+
* [Api set: PowerPointApi 1.5]
|
|
197416
|
+
*
|
|
197417
|
+
* @param key The ID of the slide.
|
|
197418
|
+
* @returns The slide with the unique ID. If such a slide doesn't exist, an error is thrown.
|
|
197419
|
+
*/
|
|
197420
|
+
getItem(key: string): PowerPoint.Slide;
|
|
197421
|
+
/**
|
|
197422
|
+
* Gets a slide using its zero-based index in the collection.
|
|
197423
|
+
*
|
|
197424
|
+
* @remarks
|
|
197425
|
+
* [Api set: PowerPointApi 1.5]
|
|
197426
|
+
*
|
|
197427
|
+
* @param index The index of the slide in the collection.
|
|
197428
|
+
* @returns The slide at the given index. An error is thrown if index is out of range.
|
|
197429
|
+
*/
|
|
197430
|
+
getItemAt(index: number): PowerPoint.Slide;
|
|
197431
|
+
/**
|
|
197432
|
+
* Gets a slide using its unique ID. If such a slide doesn't exist, an object with an `isNullObject` property set to true is returned. For further information, see
|
|
197433
|
+
{@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
197434
|
+
*
|
|
197435
|
+
* @remarks
|
|
197436
|
+
* [Api set: PowerPointApi 1.5]
|
|
197437
|
+
*
|
|
197438
|
+
* @param id The ID of the slide.
|
|
197439
|
+
* @returns The slide with the unique ID.
|
|
197440
|
+
*/
|
|
197441
|
+
getItemOrNullObject(id: string): PowerPoint.Slide;
|
|
197442
|
+
/**
|
|
197443
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
197444
|
+
*
|
|
197445
|
+
* @param options Provides options for which properties of the object to load.
|
|
197446
|
+
*/
|
|
197447
|
+
load(options?: PowerPoint.Interfaces.SlideScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideScopedCollection;
|
|
197448
|
+
/**
|
|
197449
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
197450
|
+
*
|
|
197451
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
197452
|
+
*/
|
|
197453
|
+
load(propertyNames?: string | string[]): PowerPoint.SlideScopedCollection;
|
|
197454
|
+
/**
|
|
197455
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
197456
|
+
*
|
|
197457
|
+
* @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.
|
|
197458
|
+
*/
|
|
197459
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideScopedCollection;
|
|
197460
|
+
/**
|
|
197461
|
+
* 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.)
|
|
197462
|
+
* Whereas the original `PowerPoint.SlideScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
197463
|
+
*/
|
|
197464
|
+
toJSON(): PowerPoint.Interfaces.SlideScopedCollectionData;
|
|
197465
|
+
}
|
|
197466
|
+
/**
|
|
197467
|
+
* Provides information about the slide selection changed event.
|
|
197468
|
+
*
|
|
197469
|
+
* @remarks
|
|
197470
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197471
|
+
* @beta
|
|
197472
|
+
*/
|
|
197473
|
+
interface SlideSelectionChangedEventArgs {
|
|
197474
|
+
/**
|
|
197475
|
+
* Gets the array of IDs of the currently selected slides.
|
|
197476
|
+
*
|
|
197477
|
+
* @remarks
|
|
197478
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197479
|
+
* @beta
|
|
197480
|
+
*/
|
|
197481
|
+
slideIds: string[];
|
|
197482
|
+
}
|
|
197483
|
+
/**
|
|
197484
|
+
* Represents the collection of Slide Masters in the presentation.
|
|
197485
|
+
*
|
|
197486
|
+
* @remarks
|
|
197487
|
+
* [Api set: PowerPointApi 1.3]
|
|
197488
|
+
*/
|
|
197489
|
+
class SlideMasterCollection extends OfficeExtension.ClientObject {
|
|
197490
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
197491
|
+
context: RequestContext;
|
|
197492
|
+
/** Gets the loaded child items in this collection. */
|
|
197493
|
+
readonly items: PowerPoint.SlideMaster[];
|
|
197494
|
+
/**
|
|
197495
|
+
* Gets the number of Slide Masters in the collection.
|
|
197496
|
+
*
|
|
197497
|
+
* @remarks
|
|
197498
|
+
* [Api set: PowerPointApi 1.3]
|
|
197499
|
+
* @returns The number of Slide Masters in the collection.
|
|
197500
|
+
*/
|
|
197054
197501
|
getCount(): OfficeExtension.ClientResult<number>;
|
|
197055
197502
|
/**
|
|
197056
197503
|
* Gets a Slide Master using its unique ID.
|
|
@@ -197967,6 +198414,10 @@ declare namespace PowerPoint {
|
|
|
197967
198414
|
*/
|
|
197968
198415
|
slideWidth?: number;
|
|
197969
198416
|
}
|
|
198417
|
+
/** An interface for updating data on the `SensitivityLabelDetailsCollection` object, for use in `sensitivityLabelDetailsCollection.set({ ... })`. */
|
|
198418
|
+
interface SensitivityLabelDetailsCollectionUpdateData {
|
|
198419
|
+
items?: PowerPoint.Interfaces.SensitivityLabelDetailsData[];
|
|
198420
|
+
}
|
|
197970
198421
|
/** An interface for updating data on the `SlideCollection` object, for use in `slideCollection.set({ ... })`. */
|
|
197971
198422
|
interface SlideCollectionUpdateData {
|
|
197972
198423
|
items?: PowerPoint.Interfaces.SlideData[];
|
|
@@ -197979,6 +198430,17 @@ declare namespace PowerPoint {
|
|
|
197979
198430
|
interface SlideMasterCollectionUpdateData {
|
|
197980
198431
|
items?: PowerPoint.Interfaces.SlideMasterData[];
|
|
197981
198432
|
}
|
|
198433
|
+
/** An interface describing the data returned by calling `sensitivityLabelsCatalog.toJSON()`. */
|
|
198434
|
+
interface SensitivityLabelsCatalogData {
|
|
198435
|
+
/**
|
|
198436
|
+
* Gets whether the catalog of sensitivity labels is enabled in PowerPoint.
|
|
198437
|
+
*
|
|
198438
|
+
* @remarks
|
|
198439
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
198440
|
+
* @beta
|
|
198441
|
+
*/
|
|
198442
|
+
getLabelingCapability?: PowerPoint.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled";
|
|
198443
|
+
}
|
|
197982
198444
|
/** An interface describing the data returned by calling `presentation.toJSON()`. */
|
|
197983
198445
|
interface PresentationData {
|
|
197984
198446
|
/**
|
|
@@ -199168,6 +199630,77 @@ declare namespace PowerPoint {
|
|
|
199168
199630
|
*/
|
|
199169
199631
|
slideWidth?: number;
|
|
199170
199632
|
}
|
|
199633
|
+
/** An interface describing the data returned by calling `sensitivityLabelDetailsCollection.toJSON()`. */
|
|
199634
|
+
interface SensitivityLabelDetailsCollectionData {
|
|
199635
|
+
items?: PowerPoint.Interfaces.SensitivityLabelDetailsData[];
|
|
199636
|
+
}
|
|
199637
|
+
/** An interface describing the data returned by calling `sensitivityLabelDetails.toJSON()`. */
|
|
199638
|
+
interface SensitivityLabelDetailsData {
|
|
199639
|
+
/**
|
|
199640
|
+
* Gets the color of the sensitivity label.
|
|
199641
|
+
*
|
|
199642
|
+
* @remarks
|
|
199643
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
199644
|
+
* @beta
|
|
199645
|
+
*/
|
|
199646
|
+
color?: string;
|
|
199647
|
+
/**
|
|
199648
|
+
* Gets the unique ID of the sensitivity label.
|
|
199649
|
+
*
|
|
199650
|
+
* @remarks
|
|
199651
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
199652
|
+
* @beta
|
|
199653
|
+
*/
|
|
199654
|
+
id?: string;
|
|
199655
|
+
/**
|
|
199656
|
+
* Gets a value indicating whether the label is enabled.
|
|
199657
|
+
*
|
|
199658
|
+
* @remarks
|
|
199659
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
199660
|
+
* @beta
|
|
199661
|
+
*/
|
|
199662
|
+
isEnabled?: boolean;
|
|
199663
|
+
/**
|
|
199664
|
+
* Gets the name of the sensitivity label.
|
|
199665
|
+
*
|
|
199666
|
+
* @remarks
|
|
199667
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
199668
|
+
* @beta
|
|
199669
|
+
*/
|
|
199670
|
+
name?: string;
|
|
199671
|
+
/**
|
|
199672
|
+
* Gets the priority of the sensitivity label, with 0 as lowest priority.
|
|
199673
|
+
*
|
|
199674
|
+
* @remarks
|
|
199675
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
199676
|
+
* @beta
|
|
199677
|
+
*/
|
|
199678
|
+
order?: number;
|
|
199679
|
+
/**
|
|
199680
|
+
* Gets a value indicating the protection type provided by this label.
|
|
199681
|
+
*
|
|
199682
|
+
* @remarks
|
|
199683
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
199684
|
+
* @beta
|
|
199685
|
+
*/
|
|
199686
|
+
protectionType?: PowerPoint.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined";
|
|
199687
|
+
/**
|
|
199688
|
+
* Gets the unique ID of the tenant which the sensitivity label is belonged.
|
|
199689
|
+
*
|
|
199690
|
+
* @remarks
|
|
199691
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
199692
|
+
* @beta
|
|
199693
|
+
*/
|
|
199694
|
+
siteId?: string;
|
|
199695
|
+
/**
|
|
199696
|
+
* Gets the description of the sensitivity label.
|
|
199697
|
+
*
|
|
199698
|
+
* @remarks
|
|
199699
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
199700
|
+
* @beta
|
|
199701
|
+
*/
|
|
199702
|
+
tooltip?: string;
|
|
199703
|
+
}
|
|
199171
199704
|
/** An interface describing the data returned by calling `slideCollection.toJSON()`. */
|
|
199172
199705
|
interface SlideCollectionData {
|
|
199173
199706
|
items?: PowerPoint.Interfaces.SlideData[];
|
|
@@ -199180,6 +199713,28 @@ declare namespace PowerPoint {
|
|
|
199180
199713
|
interface SlideMasterCollectionData {
|
|
199181
199714
|
items?: PowerPoint.Interfaces.SlideMasterData[];
|
|
199182
199715
|
}
|
|
199716
|
+
/**
|
|
199717
|
+
* Provides methods to check the status of the catalog of sensitivity labels in PowerPoint
|
|
199718
|
+
and retrieve all available sensitivity labels if the catalog is enabled.
|
|
199719
|
+
*
|
|
199720
|
+
* @remarks
|
|
199721
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
199722
|
+
* @beta
|
|
199723
|
+
*/
|
|
199724
|
+
interface SensitivityLabelsCatalogLoadOptions {
|
|
199725
|
+
/**
|
|
199726
|
+
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`).
|
|
199727
|
+
*/
|
|
199728
|
+
$all?: boolean;
|
|
199729
|
+
/**
|
|
199730
|
+
* Gets whether the catalog of sensitivity labels is enabled in PowerPoint.
|
|
199731
|
+
*
|
|
199732
|
+
* @remarks
|
|
199733
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
199734
|
+
* @beta
|
|
199735
|
+
*/
|
|
199736
|
+
getLabelingCapability?: boolean;
|
|
199737
|
+
}
|
|
199183
199738
|
/**
|
|
199184
199739
|
* The `Presentation` object is the top-level object with one or more slides that contain the contents of the presentation.
|
|
199185
199740
|
To learn more about the PowerPoint object model,
|
|
@@ -201698,6 +202253,160 @@ declare namespace PowerPoint {
|
|
|
201698
202253
|
*/
|
|
201699
202254
|
slideWidth?: boolean;
|
|
201700
202255
|
}
|
|
202256
|
+
/**
|
|
202257
|
+
* Represents the collection of {@link PowerPoint.SensitivityLabelDetails} objects.
|
|
202258
|
+
*
|
|
202259
|
+
* @remarks
|
|
202260
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
202261
|
+
* @beta
|
|
202262
|
+
*/
|
|
202263
|
+
interface SensitivityLabelDetailsCollectionLoadOptions {
|
|
202264
|
+
/**
|
|
202265
|
+
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`).
|
|
202266
|
+
*/
|
|
202267
|
+
$all?: boolean;
|
|
202268
|
+
/**
|
|
202269
|
+
* For EACH ITEM in the collection: Gets the color of the sensitivity label.
|
|
202270
|
+
*
|
|
202271
|
+
* @remarks
|
|
202272
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
202273
|
+
* @beta
|
|
202274
|
+
*/
|
|
202275
|
+
color?: boolean;
|
|
202276
|
+
/**
|
|
202277
|
+
* For EACH ITEM in the collection: Gets the unique ID of the sensitivity label.
|
|
202278
|
+
*
|
|
202279
|
+
* @remarks
|
|
202280
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
202281
|
+
* @beta
|
|
202282
|
+
*/
|
|
202283
|
+
id?: boolean;
|
|
202284
|
+
/**
|
|
202285
|
+
* For EACH ITEM in the collection: Gets a value indicating whether the label is enabled.
|
|
202286
|
+
*
|
|
202287
|
+
* @remarks
|
|
202288
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
202289
|
+
* @beta
|
|
202290
|
+
*/
|
|
202291
|
+
isEnabled?: boolean;
|
|
202292
|
+
/**
|
|
202293
|
+
* For EACH ITEM in the collection: Gets the name of the sensitivity label.
|
|
202294
|
+
*
|
|
202295
|
+
* @remarks
|
|
202296
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
202297
|
+
* @beta
|
|
202298
|
+
*/
|
|
202299
|
+
name?: boolean;
|
|
202300
|
+
/**
|
|
202301
|
+
* For EACH ITEM in the collection: Gets the priority of the sensitivity label, with 0 as lowest priority.
|
|
202302
|
+
*
|
|
202303
|
+
* @remarks
|
|
202304
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
202305
|
+
* @beta
|
|
202306
|
+
*/
|
|
202307
|
+
order?: boolean;
|
|
202308
|
+
/**
|
|
202309
|
+
* For EACH ITEM in the collection: Gets a value indicating the protection type provided by this label.
|
|
202310
|
+
*
|
|
202311
|
+
* @remarks
|
|
202312
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
202313
|
+
* @beta
|
|
202314
|
+
*/
|
|
202315
|
+
protectionType?: boolean;
|
|
202316
|
+
/**
|
|
202317
|
+
* For EACH ITEM in the collection: Gets the unique ID of the tenant which the sensitivity label is belonged.
|
|
202318
|
+
*
|
|
202319
|
+
* @remarks
|
|
202320
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
202321
|
+
* @beta
|
|
202322
|
+
*/
|
|
202323
|
+
siteId?: boolean;
|
|
202324
|
+
/**
|
|
202325
|
+
* For EACH ITEM in the collection: Gets the description of the sensitivity label.
|
|
202326
|
+
*
|
|
202327
|
+
* @remarks
|
|
202328
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
202329
|
+
* @beta
|
|
202330
|
+
*/
|
|
202331
|
+
tooltip?: boolean;
|
|
202332
|
+
}
|
|
202333
|
+
/**
|
|
202334
|
+
* Represents the properties of available sensitivity labels in PowerPoint.
|
|
202335
|
+
*
|
|
202336
|
+
* @remarks
|
|
202337
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
202338
|
+
* @beta
|
|
202339
|
+
*/
|
|
202340
|
+
interface SensitivityLabelDetailsLoadOptions {
|
|
202341
|
+
/**
|
|
202342
|
+
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`).
|
|
202343
|
+
*/
|
|
202344
|
+
$all?: boolean;
|
|
202345
|
+
/**
|
|
202346
|
+
* Gets the color of the sensitivity label.
|
|
202347
|
+
*
|
|
202348
|
+
* @remarks
|
|
202349
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
202350
|
+
* @beta
|
|
202351
|
+
*/
|
|
202352
|
+
color?: boolean;
|
|
202353
|
+
/**
|
|
202354
|
+
* Gets the unique ID of the sensitivity label.
|
|
202355
|
+
*
|
|
202356
|
+
* @remarks
|
|
202357
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
202358
|
+
* @beta
|
|
202359
|
+
*/
|
|
202360
|
+
id?: boolean;
|
|
202361
|
+
/**
|
|
202362
|
+
* Gets a value indicating whether the label is enabled.
|
|
202363
|
+
*
|
|
202364
|
+
* @remarks
|
|
202365
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
202366
|
+
* @beta
|
|
202367
|
+
*/
|
|
202368
|
+
isEnabled?: boolean;
|
|
202369
|
+
/**
|
|
202370
|
+
* Gets the name of the sensitivity label.
|
|
202371
|
+
*
|
|
202372
|
+
* @remarks
|
|
202373
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
202374
|
+
* @beta
|
|
202375
|
+
*/
|
|
202376
|
+
name?: boolean;
|
|
202377
|
+
/**
|
|
202378
|
+
* Gets the priority of the sensitivity label, with 0 as lowest priority.
|
|
202379
|
+
*
|
|
202380
|
+
* @remarks
|
|
202381
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
202382
|
+
* @beta
|
|
202383
|
+
*/
|
|
202384
|
+
order?: boolean;
|
|
202385
|
+
/**
|
|
202386
|
+
* Gets a value indicating the protection type provided by this label.
|
|
202387
|
+
*
|
|
202388
|
+
* @remarks
|
|
202389
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
202390
|
+
* @beta
|
|
202391
|
+
*/
|
|
202392
|
+
protectionType?: boolean;
|
|
202393
|
+
/**
|
|
202394
|
+
* Gets the unique ID of the tenant which the sensitivity label is belonged.
|
|
202395
|
+
*
|
|
202396
|
+
* @remarks
|
|
202397
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
202398
|
+
* @beta
|
|
202399
|
+
*/
|
|
202400
|
+
siteId?: boolean;
|
|
202401
|
+
/**
|
|
202402
|
+
* Gets the description of the sensitivity label.
|
|
202403
|
+
*
|
|
202404
|
+
* @remarks
|
|
202405
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
202406
|
+
* @beta
|
|
202407
|
+
*/
|
|
202408
|
+
tooltip?: boolean;
|
|
202409
|
+
}
|
|
201701
202410
|
/**
|
|
201702
202411
|
* Represents the collection of slides in the presentation.
|
|
201703
202412
|
*
|
|
@@ -201835,6 +202544,7 @@ declare namespace PowerPoint {
|
|
|
201835
202544
|
constructor(url?: string);
|
|
201836
202545
|
readonly presentation: Presentation;
|
|
201837
202546
|
readonly application: Application;
|
|
202547
|
+
readonly sensitivityLabelsCatalog: any;
|
|
201838
202548
|
}
|
|
201839
202549
|
/**
|
|
201840
202550
|
* Executes a batch script that performs actions on the PowerPoint object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.
|
office-js-preview/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js-preview",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.704",
|
|
4
4
|
"description": "TypeScript definitions for office-js-preview",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
|
|
6
6
|
"license": "MIT",
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
"scripts": {},
|
|
47
47
|
"dependencies": {},
|
|
48
48
|
"peerDependencies": {},
|
|
49
|
-
"typesPublisherContentHash": "
|
|
49
|
+
"typesPublisherContentHash": "1bd36e84d83bb0dd822e3c91552d3cdf2860c179add9870108a26b0b085f903d",
|
|
50
50
|
"typeScriptVersion": "5.3",
|
|
51
51
|
"nonNpm": true
|
|
52
52
|
}
|