@types/office-js-preview 1.0.403 → 1.0.404
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 +476 -0
- 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 (https://github.com/OfficeD
|
|
|
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: Tue, 01 Aug 2023 16:32:48 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
* Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
|
|
14
14
|
|
office-js-preview/index.d.ts
CHANGED
|
@@ -94881,6 +94881,14 @@ declare namespace Word {
|
|
|
94881
94881
|
* [Api set: WordApi 1.5]
|
|
94882
94882
|
*/
|
|
94883
94883
|
readonly paragraphFormat: Word.ParagraphFormat;
|
|
94884
|
+
/**
|
|
94885
|
+
* Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
|
|
94886
|
+
*
|
|
94887
|
+
* @remarks
|
|
94888
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
94889
|
+
* @beta
|
|
94890
|
+
*/
|
|
94891
|
+
readonly shading: Word.Shading;
|
|
94884
94892
|
/**
|
|
94885
94893
|
* Gets the name of an existing style to use as the base formatting of another style.
|
|
94886
94894
|
*
|
|
@@ -95016,6 +95024,83 @@ declare namespace Word {
|
|
|
95016
95024
|
*/
|
|
95017
95025
|
toJSON(): Word.Interfaces.StyleData;
|
|
95018
95026
|
}
|
|
95027
|
+
/**
|
|
95028
|
+
* Represents the shading object.
|
|
95029
|
+
*
|
|
95030
|
+
* @remarks
|
|
95031
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
95032
|
+
* @beta
|
|
95033
|
+
*/
|
|
95034
|
+
class Shading extends OfficeExtension.ClientObject {
|
|
95035
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
95036
|
+
context: RequestContext;
|
|
95037
|
+
/**
|
|
95038
|
+
* Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name.
|
|
95039
|
+
*
|
|
95040
|
+
* @remarks
|
|
95041
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
95042
|
+
* @beta
|
|
95043
|
+
*/
|
|
95044
|
+
backgroundPatternColor: string;
|
|
95045
|
+
/**
|
|
95046
|
+
* Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name.
|
|
95047
|
+
*
|
|
95048
|
+
* @remarks
|
|
95049
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
95050
|
+
* @beta
|
|
95051
|
+
*/
|
|
95052
|
+
foregroundPatternColor: string;
|
|
95053
|
+
/**
|
|
95054
|
+
* Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}.
|
|
95055
|
+
*
|
|
95056
|
+
* @remarks
|
|
95057
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
95058
|
+
* @beta
|
|
95059
|
+
*/
|
|
95060
|
+
texture: Word.ShadingTextureType | "Texture10Percent" | "Texture12Pt5Percent" | "Texture15Percent" | "Texture20Percent" | "Texture25Percent" | "Texture30Percent" | "Texture35Percent" | "Texture37Pt5Percent" | "Texture40Percent" | "Texture45Percent" | "Texture50Percent" | "Texture55Percent" | "Texture5Percent" | "Texture60Percent" | "Texture62Pt5Percent" | "Texture65Percent" | "Texture70Percent" | "Texture75Percent" | "Texture80Percent" | "Texture85Percent" | "Texture87Pt5Percent" | "Texture90Percent" | "Texture95Percent" | "TextureDarkDiagonalDown" | "TextureDarkDiagonalUp" | "TextureDarkGrid" | "TextureDarkHorizontal" | "TextureDarkTrellis" | "TextureDarkVertical" | "TextureLightDiagonalDown" | "TextureLightDiagonalUp" | "TextureLightGrid" | "TextureLightHorizontal" | "TextureLightTrellis" | "TextureLightVertical" | "TextureNone" | "TextureSolid";
|
|
95061
|
+
/**
|
|
95062
|
+
* Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
|
|
95063
|
+
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
95064
|
+
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
95065
|
+
*/
|
|
95066
|
+
set(properties: Interfaces.ShadingUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
95067
|
+
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
95068
|
+
set(properties: Word.Shading): void;
|
|
95069
|
+
/**
|
|
95070
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
95071
|
+
*
|
|
95072
|
+
* @param options Provides options for which properties of the object to load.
|
|
95073
|
+
*/
|
|
95074
|
+
load(options?: Word.Interfaces.ShadingLoadOptions): Word.Shading;
|
|
95075
|
+
/**
|
|
95076
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
95077
|
+
*
|
|
95078
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
95079
|
+
*/
|
|
95080
|
+
load(propertyNames?: string | string[]): Word.Shading;
|
|
95081
|
+
/**
|
|
95082
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
95083
|
+
*
|
|
95084
|
+
* @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.
|
|
95085
|
+
*/
|
|
95086
|
+
load(propertyNamesAndPaths?: {
|
|
95087
|
+
select?: string;
|
|
95088
|
+
expand?: string;
|
|
95089
|
+
}): Word.Shading;
|
|
95090
|
+
/**
|
|
95091
|
+
* 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 are 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.
|
|
95092
|
+
*/
|
|
95093
|
+
track(): Word.Shading;
|
|
95094
|
+
/**
|
|
95095
|
+
* 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 will need to call `context.sync()` before the memory release takes effect.
|
|
95096
|
+
*/
|
|
95097
|
+
untrack(): Word.Shading;
|
|
95098
|
+
/**
|
|
95099
|
+
* 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 is passed to it.)
|
|
95100
|
+
* Whereas the original Word.Shading object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadingData`) that contains shallow copies of any loaded child properties from the original object.
|
|
95101
|
+
*/
|
|
95102
|
+
toJSON(): Word.Interfaces.ShadingData;
|
|
95103
|
+
}
|
|
95019
95104
|
/**
|
|
95020
95105
|
* Represents a table in a Word document.
|
|
95021
95106
|
*
|
|
@@ -99773,6 +99858,274 @@ declare namespace Word {
|
|
|
99773
99858
|
*/
|
|
99774
99859
|
legalLZ = "LegalLZ",
|
|
99775
99860
|
}
|
|
99861
|
+
/**
|
|
99862
|
+
* Represents the shading texture. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}.
|
|
99863
|
+
*
|
|
99864
|
+
* @remarks
|
|
99865
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99866
|
+
* @beta
|
|
99867
|
+
*/
|
|
99868
|
+
enum ShadingTextureType {
|
|
99869
|
+
/**
|
|
99870
|
+
* Represents 10 percent texture.
|
|
99871
|
+
* @remarks
|
|
99872
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99873
|
+
* @beta
|
|
99874
|
+
*/
|
|
99875
|
+
texture10Percent = "Texture10Percent",
|
|
99876
|
+
/**
|
|
99877
|
+
* Represents 12.5 percent texture.
|
|
99878
|
+
* @remarks
|
|
99879
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99880
|
+
* @beta
|
|
99881
|
+
*/
|
|
99882
|
+
texture12Pt5Percent = "Texture12Pt5Percent",
|
|
99883
|
+
/**
|
|
99884
|
+
* Represents 15 percent texture.
|
|
99885
|
+
* @remarks
|
|
99886
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99887
|
+
* @beta
|
|
99888
|
+
*/
|
|
99889
|
+
texture15Percent = "Texture15Percent",
|
|
99890
|
+
/**
|
|
99891
|
+
* Represents 20 percent texture.
|
|
99892
|
+
* @remarks
|
|
99893
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99894
|
+
* @beta
|
|
99895
|
+
*/
|
|
99896
|
+
texture20Percent = "Texture20Percent",
|
|
99897
|
+
/**
|
|
99898
|
+
* Represents 25 percent texture.
|
|
99899
|
+
* @remarks
|
|
99900
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99901
|
+
* @beta
|
|
99902
|
+
*/
|
|
99903
|
+
texture25Percent = "Texture25Percent",
|
|
99904
|
+
/**
|
|
99905
|
+
* Represents 30 percent texture.
|
|
99906
|
+
* @remarks
|
|
99907
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99908
|
+
* @beta
|
|
99909
|
+
*/
|
|
99910
|
+
texture30Percent = "Texture30Percent",
|
|
99911
|
+
/**
|
|
99912
|
+
* Represents 35 percent texture.
|
|
99913
|
+
* @remarks
|
|
99914
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99915
|
+
* @beta
|
|
99916
|
+
*/
|
|
99917
|
+
texture35Percent = "Texture35Percent",
|
|
99918
|
+
/**
|
|
99919
|
+
* Represents 37.5 percent texture.
|
|
99920
|
+
* @remarks
|
|
99921
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99922
|
+
* @beta
|
|
99923
|
+
*/
|
|
99924
|
+
texture37Pt5Percent = "Texture37Pt5Percent",
|
|
99925
|
+
/**
|
|
99926
|
+
* Represents 40 percent texture.
|
|
99927
|
+
* @remarks
|
|
99928
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99929
|
+
* @beta
|
|
99930
|
+
*/
|
|
99931
|
+
texture40Percent = "Texture40Percent",
|
|
99932
|
+
/**
|
|
99933
|
+
* Represents 45 percent texture.
|
|
99934
|
+
* @remarks
|
|
99935
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99936
|
+
* @beta
|
|
99937
|
+
*/
|
|
99938
|
+
texture45Percent = "Texture45Percent",
|
|
99939
|
+
/**
|
|
99940
|
+
* Represents 50 percent texture.
|
|
99941
|
+
* @remarks
|
|
99942
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99943
|
+
* @beta
|
|
99944
|
+
*/
|
|
99945
|
+
texture50Percent = "Texture50Percent",
|
|
99946
|
+
/**
|
|
99947
|
+
* Represents 55 percent texture.
|
|
99948
|
+
* @remarks
|
|
99949
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99950
|
+
* @beta
|
|
99951
|
+
*/
|
|
99952
|
+
texture55Percent = "Texture55Percent",
|
|
99953
|
+
/**
|
|
99954
|
+
* Represents 5 percent texture.
|
|
99955
|
+
* @remarks
|
|
99956
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99957
|
+
* @beta
|
|
99958
|
+
*/
|
|
99959
|
+
texture5Percent = "Texture5Percent",
|
|
99960
|
+
/**
|
|
99961
|
+
* Represents 60 percent texture.
|
|
99962
|
+
* @remarks
|
|
99963
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99964
|
+
* @beta
|
|
99965
|
+
*/
|
|
99966
|
+
texture60Percent = "Texture60Percent",
|
|
99967
|
+
/**
|
|
99968
|
+
* Represents 62.5 percent texture.
|
|
99969
|
+
* @remarks
|
|
99970
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99971
|
+
* @beta
|
|
99972
|
+
*/
|
|
99973
|
+
texture62Pt5Percent = "Texture62Pt5Percent",
|
|
99974
|
+
/**
|
|
99975
|
+
* Represents 65 percent texture.
|
|
99976
|
+
* @remarks
|
|
99977
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99978
|
+
* @beta
|
|
99979
|
+
*/
|
|
99980
|
+
texture65Percent = "Texture65Percent",
|
|
99981
|
+
/**
|
|
99982
|
+
* Represents 70 percent texture.
|
|
99983
|
+
* @remarks
|
|
99984
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99985
|
+
* @beta
|
|
99986
|
+
*/
|
|
99987
|
+
texture70Percent = "Texture70Percent",
|
|
99988
|
+
/**
|
|
99989
|
+
* Represents 75 percent texture.
|
|
99990
|
+
* @remarks
|
|
99991
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99992
|
+
* @beta
|
|
99993
|
+
*/
|
|
99994
|
+
texture75Percent = "Texture75Percent",
|
|
99995
|
+
/**
|
|
99996
|
+
* Represents 80 percent texture.
|
|
99997
|
+
* @remarks
|
|
99998
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99999
|
+
* @beta
|
|
100000
|
+
*/
|
|
100001
|
+
texture80Percent = "Texture80Percent",
|
|
100002
|
+
/**
|
|
100003
|
+
* Represents 85 percent texture.
|
|
100004
|
+
* @remarks
|
|
100005
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100006
|
+
* @beta
|
|
100007
|
+
*/
|
|
100008
|
+
texture85Percent = "Texture85Percent",
|
|
100009
|
+
/**
|
|
100010
|
+
* Represents 87.5 percent texture.
|
|
100011
|
+
* @remarks
|
|
100012
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100013
|
+
* @beta
|
|
100014
|
+
*/
|
|
100015
|
+
texture87Pt5Percent = "Texture87Pt5Percent",
|
|
100016
|
+
/**
|
|
100017
|
+
* Represents 90 percent texture.
|
|
100018
|
+
* @remarks
|
|
100019
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100020
|
+
* @beta
|
|
100021
|
+
*/
|
|
100022
|
+
texture90Percent = "Texture90Percent",
|
|
100023
|
+
/**
|
|
100024
|
+
* Represents 95 percent texture.
|
|
100025
|
+
* @remarks
|
|
100026
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100027
|
+
* @beta
|
|
100028
|
+
*/
|
|
100029
|
+
texture95Percent = "Texture95Percent",
|
|
100030
|
+
/**
|
|
100031
|
+
* Represents dark diagonal-down texture.
|
|
100032
|
+
* @remarks
|
|
100033
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100034
|
+
* @beta
|
|
100035
|
+
*/
|
|
100036
|
+
textureDarkDiagonalDown = "TextureDarkDiagonalDown",
|
|
100037
|
+
/**
|
|
100038
|
+
* Represents dark diagonal-up texture.
|
|
100039
|
+
* @remarks
|
|
100040
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100041
|
+
* @beta
|
|
100042
|
+
*/
|
|
100043
|
+
textureDarkDiagonalUp = "TextureDarkDiagonalUp",
|
|
100044
|
+
/**
|
|
100045
|
+
* Represents dark horizontal-cross texture.
|
|
100046
|
+
* @remarks
|
|
100047
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100048
|
+
* @beta
|
|
100049
|
+
*/
|
|
100050
|
+
textureDarkGrid = "TextureDarkGrid",
|
|
100051
|
+
/**
|
|
100052
|
+
* Represents dark horizontal texture.
|
|
100053
|
+
* @remarks
|
|
100054
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100055
|
+
* @beta
|
|
100056
|
+
*/
|
|
100057
|
+
textureDarkHorizontal = "TextureDarkHorizontal",
|
|
100058
|
+
/**
|
|
100059
|
+
* Represents dark diagonal-cross texture.
|
|
100060
|
+
* @remarks
|
|
100061
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100062
|
+
* @beta
|
|
100063
|
+
*/
|
|
100064
|
+
textureDarkTrellis = "TextureDarkTrellis",
|
|
100065
|
+
/**
|
|
100066
|
+
* Represents dark vertical texture.
|
|
100067
|
+
* @remarks
|
|
100068
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100069
|
+
* @beta
|
|
100070
|
+
*/
|
|
100071
|
+
textureDarkVertical = "TextureDarkVertical",
|
|
100072
|
+
/**
|
|
100073
|
+
* Represents light diagonal-down texture.
|
|
100074
|
+
* @remarks
|
|
100075
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100076
|
+
* @beta
|
|
100077
|
+
*/
|
|
100078
|
+
textureLightDiagonalDown = "TextureLightDiagonalDown",
|
|
100079
|
+
/**
|
|
100080
|
+
* Represents light diagonal-up texture.
|
|
100081
|
+
* @remarks
|
|
100082
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100083
|
+
* @beta
|
|
100084
|
+
*/
|
|
100085
|
+
textureLightDiagonalUp = "TextureLightDiagonalUp",
|
|
100086
|
+
/**
|
|
100087
|
+
* Represents light horizontal-cross texture.
|
|
100088
|
+
* @remarks
|
|
100089
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100090
|
+
* @beta
|
|
100091
|
+
*/
|
|
100092
|
+
textureLightGrid = "TextureLightGrid",
|
|
100093
|
+
/**
|
|
100094
|
+
* Represents light horizontal texture.
|
|
100095
|
+
* @remarks
|
|
100096
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100097
|
+
* @beta
|
|
100098
|
+
*/
|
|
100099
|
+
textureLightHorizontal = "TextureLightHorizontal",
|
|
100100
|
+
/**
|
|
100101
|
+
* Represents light diagonal-cross texture.
|
|
100102
|
+
* @remarks
|
|
100103
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100104
|
+
* @beta
|
|
100105
|
+
*/
|
|
100106
|
+
textureLightTrellis = "TextureLightTrellis",
|
|
100107
|
+
/**
|
|
100108
|
+
* Represents light vertical texture.
|
|
100109
|
+
* @remarks
|
|
100110
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100111
|
+
* @beta
|
|
100112
|
+
*/
|
|
100113
|
+
textureLightVertical = "TextureLightVertical",
|
|
100114
|
+
/**
|
|
100115
|
+
* Represents that there's no texture.
|
|
100116
|
+
* @remarks
|
|
100117
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100118
|
+
* @beta
|
|
100119
|
+
*/
|
|
100120
|
+
textureNone = "TextureNone",
|
|
100121
|
+
/**
|
|
100122
|
+
* Represents solid texture.
|
|
100123
|
+
* @remarks
|
|
100124
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100125
|
+
* @beta
|
|
100126
|
+
*/
|
|
100127
|
+
textureSolid = "TextureSolid",
|
|
100128
|
+
}
|
|
99776
100129
|
enum ErrorCodes {
|
|
99777
100130
|
accessDenied = "AccessDenied",
|
|
99778
100131
|
generalException = "GeneralException",
|
|
@@ -100796,6 +101149,14 @@ declare namespace Word {
|
|
|
100796
101149
|
* [Api set: WordApi 1.5]
|
|
100797
101150
|
*/
|
|
100798
101151
|
paragraphFormat?: Word.Interfaces.ParagraphFormatUpdateData;
|
|
101152
|
+
/**
|
|
101153
|
+
* Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
|
|
101154
|
+
*
|
|
101155
|
+
* @remarks
|
|
101156
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
101157
|
+
* @beta
|
|
101158
|
+
*/
|
|
101159
|
+
shading?: Word.Interfaces.ShadingUpdateData;
|
|
100799
101160
|
/**
|
|
100800
101161
|
* Specifies the priority.
|
|
100801
101162
|
*
|
|
@@ -100825,6 +101186,33 @@ declare namespace Word {
|
|
|
100825
101186
|
*/
|
|
100826
101187
|
visibility?: boolean;
|
|
100827
101188
|
}
|
|
101189
|
+
/** An interface for updating data on the Shading object, for use in `shading.set({ ... })`. */
|
|
101190
|
+
interface ShadingUpdateData {
|
|
101191
|
+
/**
|
|
101192
|
+
* Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name.
|
|
101193
|
+
*
|
|
101194
|
+
* @remarks
|
|
101195
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
101196
|
+
* @beta
|
|
101197
|
+
*/
|
|
101198
|
+
backgroundPatternColor?: string;
|
|
101199
|
+
/**
|
|
101200
|
+
* Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name.
|
|
101201
|
+
*
|
|
101202
|
+
* @remarks
|
|
101203
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
101204
|
+
* @beta
|
|
101205
|
+
*/
|
|
101206
|
+
foregroundPatternColor?: string;
|
|
101207
|
+
/**
|
|
101208
|
+
* Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}.
|
|
101209
|
+
*
|
|
101210
|
+
* @remarks
|
|
101211
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
101212
|
+
* @beta
|
|
101213
|
+
*/
|
|
101214
|
+
texture?: Word.ShadingTextureType | "Texture10Percent" | "Texture12Pt5Percent" | "Texture15Percent" | "Texture20Percent" | "Texture25Percent" | "Texture30Percent" | "Texture35Percent" | "Texture37Pt5Percent" | "Texture40Percent" | "Texture45Percent" | "Texture50Percent" | "Texture55Percent" | "Texture5Percent" | "Texture60Percent" | "Texture62Pt5Percent" | "Texture65Percent" | "Texture70Percent" | "Texture75Percent" | "Texture80Percent" | "Texture85Percent" | "Texture87Pt5Percent" | "Texture90Percent" | "Texture95Percent" | "TextureDarkDiagonalDown" | "TextureDarkDiagonalUp" | "TextureDarkGrid" | "TextureDarkHorizontal" | "TextureDarkTrellis" | "TextureDarkVertical" | "TextureLightDiagonalDown" | "TextureLightDiagonalUp" | "TextureLightGrid" | "TextureLightHorizontal" | "TextureLightTrellis" | "TextureLightVertical" | "TextureNone" | "TextureSolid";
|
|
101215
|
+
}
|
|
100828
101216
|
/** An interface for updating data on the Table object, for use in `table.set({ ... })`. */
|
|
100829
101217
|
interface TableUpdateData {
|
|
100830
101218
|
/**
|
|
@@ -102587,6 +102975,14 @@ declare namespace Word {
|
|
|
102587
102975
|
* [Api set: WordApi 1.5]
|
|
102588
102976
|
*/
|
|
102589
102977
|
paragraphFormat?: Word.Interfaces.ParagraphFormatData;
|
|
102978
|
+
/**
|
|
102979
|
+
* Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
|
|
102980
|
+
*
|
|
102981
|
+
* @remarks
|
|
102982
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102983
|
+
* @beta
|
|
102984
|
+
*/
|
|
102985
|
+
shading?: Word.Interfaces.ShadingData;
|
|
102590
102986
|
/**
|
|
102591
102987
|
* Gets the name of an existing style to use as the base formatting of another style.
|
|
102592
102988
|
*
|
|
@@ -102673,6 +103069,33 @@ declare namespace Word {
|
|
|
102673
103069
|
*/
|
|
102674
103070
|
visibility?: boolean;
|
|
102675
103071
|
}
|
|
103072
|
+
/** An interface describing the data returned by calling `shading.toJSON()`. */
|
|
103073
|
+
interface ShadingData {
|
|
103074
|
+
/**
|
|
103075
|
+
* Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name.
|
|
103076
|
+
*
|
|
103077
|
+
* @remarks
|
|
103078
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
103079
|
+
* @beta
|
|
103080
|
+
*/
|
|
103081
|
+
backgroundPatternColor?: string;
|
|
103082
|
+
/**
|
|
103083
|
+
* Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name.
|
|
103084
|
+
*
|
|
103085
|
+
* @remarks
|
|
103086
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
103087
|
+
* @beta
|
|
103088
|
+
*/
|
|
103089
|
+
foregroundPatternColor?: string;
|
|
103090
|
+
/**
|
|
103091
|
+
* Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}.
|
|
103092
|
+
*
|
|
103093
|
+
* @remarks
|
|
103094
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
103095
|
+
* @beta
|
|
103096
|
+
*/
|
|
103097
|
+
texture?: Word.ShadingTextureType | "Texture10Percent" | "Texture12Pt5Percent" | "Texture15Percent" | "Texture20Percent" | "Texture25Percent" | "Texture30Percent" | "Texture35Percent" | "Texture37Pt5Percent" | "Texture40Percent" | "Texture45Percent" | "Texture50Percent" | "Texture55Percent" | "Texture5Percent" | "Texture60Percent" | "Texture62Pt5Percent" | "Texture65Percent" | "Texture70Percent" | "Texture75Percent" | "Texture80Percent" | "Texture85Percent" | "Texture87Pt5Percent" | "Texture90Percent" | "Texture95Percent" | "TextureDarkDiagonalDown" | "TextureDarkDiagonalUp" | "TextureDarkGrid" | "TextureDarkHorizontal" | "TextureDarkTrellis" | "TextureDarkVertical" | "TextureLightDiagonalDown" | "TextureLightDiagonalUp" | "TextureLightGrid" | "TextureLightHorizontal" | "TextureLightTrellis" | "TextureLightVertical" | "TextureNone" | "TextureSolid";
|
|
103098
|
+
}
|
|
102676
103099
|
/** An interface describing the data returned by calling `table.toJSON()`. */
|
|
102677
103100
|
interface TableData {
|
|
102678
103101
|
/**
|
|
@@ -105919,6 +106342,14 @@ declare namespace Word {
|
|
|
105919
106342
|
* [Api set: WordApi 1.5]
|
|
105920
106343
|
*/
|
|
105921
106344
|
paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions;
|
|
106345
|
+
/**
|
|
106346
|
+
* For EACH ITEM in the collection: Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
|
|
106347
|
+
*
|
|
106348
|
+
* @remarks
|
|
106349
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
106350
|
+
* @beta
|
|
106351
|
+
*/
|
|
106352
|
+
shading?: Word.Interfaces.ShadingLoadOptions;
|
|
105922
106353
|
/**
|
|
105923
106354
|
* For EACH ITEM in the collection: Gets the name of an existing style to use as the base formatting of another style.
|
|
105924
106355
|
*
|
|
@@ -106038,6 +106469,14 @@ declare namespace Word {
|
|
|
106038
106469
|
* [Api set: WordApi 1.5]
|
|
106039
106470
|
*/
|
|
106040
106471
|
paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions;
|
|
106472
|
+
/**
|
|
106473
|
+
* Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
|
|
106474
|
+
*
|
|
106475
|
+
* @remarks
|
|
106476
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
106477
|
+
* @beta
|
|
106478
|
+
*/
|
|
106479
|
+
shading?: Word.Interfaces.ShadingLoadOptions;
|
|
106041
106480
|
/**
|
|
106042
106481
|
* Gets the name of an existing style to use as the base formatting of another style.
|
|
106043
106482
|
*
|
|
@@ -106124,6 +106563,43 @@ declare namespace Word {
|
|
|
106124
106563
|
*/
|
|
106125
106564
|
visibility?: boolean;
|
|
106126
106565
|
}
|
|
106566
|
+
/**
|
|
106567
|
+
* Represents the shading object.
|
|
106568
|
+
*
|
|
106569
|
+
* @remarks
|
|
106570
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
106571
|
+
* @beta
|
|
106572
|
+
*/
|
|
106573
|
+
interface ShadingLoadOptions {
|
|
106574
|
+
/**
|
|
106575
|
+
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
106576
|
+
*/
|
|
106577
|
+
$all?: boolean;
|
|
106578
|
+
/**
|
|
106579
|
+
* Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name.
|
|
106580
|
+
*
|
|
106581
|
+
* @remarks
|
|
106582
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
106583
|
+
* @beta
|
|
106584
|
+
*/
|
|
106585
|
+
backgroundPatternColor?: boolean;
|
|
106586
|
+
/**
|
|
106587
|
+
* Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name.
|
|
106588
|
+
*
|
|
106589
|
+
* @remarks
|
|
106590
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
106591
|
+
* @beta
|
|
106592
|
+
*/
|
|
106593
|
+
foregroundPatternColor?: boolean;
|
|
106594
|
+
/**
|
|
106595
|
+
* Specifies the shading texture of the object.
|
|
106596
|
+
*
|
|
106597
|
+
* @remarks
|
|
106598
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
106599
|
+
* @beta
|
|
106600
|
+
*/
|
|
106601
|
+
texture?: boolean;
|
|
106602
|
+
}
|
|
106127
106603
|
/**
|
|
106128
106604
|
* Represents a table in a Word document.
|
|
106129
106605
|
*
|
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.404",
|
|
4
4
|
"description": "TypeScript definitions for Office.js",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
|
|
6
6
|
"license": "MIT",
|
|
@@ -45,6 +45,6 @@
|
|
|
45
45
|
},
|
|
46
46
|
"scripts": {},
|
|
47
47
|
"dependencies": {},
|
|
48
|
-
"typesPublisherContentHash": "
|
|
48
|
+
"typesPublisherContentHash": "f1d2eee82a6816b91e09a6f0f09a3e6b57253aea229b58cbd73d44069069158c",
|
|
49
49
|
"typeScriptVersion": "4.3"
|
|
50
50
|
}
|