@types/office-js-preview 1.0.403 → 1.0.405
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 +1704 -141
- office-js-preview/package.json +2 -2
office-js-preview/index.d.ts
CHANGED
|
@@ -88558,6 +88558,16 @@ declare namespace Word {
|
|
|
88558
88558
|
* [Api set: WordApi 1.1]
|
|
88559
88559
|
*/
|
|
88560
88560
|
getOoxml(): OfficeExtension.ClientResult<string>;
|
|
88561
|
+
/**
|
|
88562
|
+
* Gets the paragraph by its unique id. Throws an `ItemNotFound` error if the collection is empty.
|
|
88563
|
+
*
|
|
88564
|
+
* @remarks
|
|
88565
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88566
|
+
* @beta
|
|
88567
|
+
*
|
|
88568
|
+
* @param id Required. Unique Paragraph Id.
|
|
88569
|
+
*/
|
|
88570
|
+
getParagraphById(id: string): Word.Paragraph;
|
|
88561
88571
|
/**
|
|
88562
88572
|
* Gets the whole body, or the starting or ending point of the body, as a range.
|
|
88563
88573
|
*
|
|
@@ -88785,6 +88795,36 @@ declare namespace Word {
|
|
|
88785
88795
|
* @beta
|
|
88786
88796
|
*/
|
|
88787
88797
|
readonly onCommentSelected: OfficeExtension.EventHandlers<Word.CommentEventArgs>;
|
|
88798
|
+
/**
|
|
88799
|
+
* Occurs when new paragraphs are added.
|
|
88800
|
+
*
|
|
88801
|
+
* @remarks
|
|
88802
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88803
|
+
*
|
|
88804
|
+
* @eventproperty
|
|
88805
|
+
* @beta
|
|
88806
|
+
*/
|
|
88807
|
+
readonly onParagraphAdded: OfficeExtension.EventHandlers<Word.ParagraphAddedEventArgs>;
|
|
88808
|
+
/**
|
|
88809
|
+
* Occurs when paragraphs are changed.
|
|
88810
|
+
*
|
|
88811
|
+
* @remarks
|
|
88812
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88813
|
+
*
|
|
88814
|
+
* @eventproperty
|
|
88815
|
+
* @beta
|
|
88816
|
+
*/
|
|
88817
|
+
readonly onParagraphChanged: OfficeExtension.EventHandlers<Word.ParagraphChangedEventArgs>;
|
|
88818
|
+
/**
|
|
88819
|
+
* Occurs when paragraphs are deleted.
|
|
88820
|
+
*
|
|
88821
|
+
* @remarks
|
|
88822
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88823
|
+
*
|
|
88824
|
+
* @eventproperty
|
|
88825
|
+
* @beta
|
|
88826
|
+
*/
|
|
88827
|
+
readonly onParagraphDeleted: OfficeExtension.EventHandlers<Word.ParagraphDeletedEventArgs>;
|
|
88788
88828
|
/**
|
|
88789
88829
|
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.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.
|
|
88790
88830
|
*/
|
|
@@ -88799,6 +88839,99 @@ declare namespace Word {
|
|
|
88799
88839
|
*/
|
|
88800
88840
|
toJSON(): Word.Interfaces.BodyData;
|
|
88801
88841
|
}
|
|
88842
|
+
/**
|
|
88843
|
+
* Represents the Border object for text, a paragraph, or a table.
|
|
88844
|
+
*
|
|
88845
|
+
* @remarks
|
|
88846
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88847
|
+
* @beta
|
|
88848
|
+
*/
|
|
88849
|
+
class Border extends OfficeExtension.ClientObject {
|
|
88850
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
88851
|
+
context: RequestContext;
|
|
88852
|
+
/**
|
|
88853
|
+
* Specifies the line color for the border.
|
|
88854
|
+
*
|
|
88855
|
+
* @remarks
|
|
88856
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88857
|
+
* @beta
|
|
88858
|
+
*/
|
|
88859
|
+
lineColor: string;
|
|
88860
|
+
/**
|
|
88861
|
+
* Specifies the line style for the border.
|
|
88862
|
+
*
|
|
88863
|
+
* @remarks
|
|
88864
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88865
|
+
* @beta
|
|
88866
|
+
*/
|
|
88867
|
+
lineStyle: Word.LineStyle | "DashDot" | "DashDotDot" | "DashDotStroked" | "DashLargeGap" | "DashSmallGap" | "Dot" | "Double" | "DoubleWavy" | "Emboss3D" | "Engrave3D" | "Inset" | "None" | "Outset" | "Single" | "SingleWavy" | "ThickThinLargeGap" | "ThickThinMedGap" | "ThickThinSmallGap" | "ThinThickLargeGap" | "ThinThickMedGap" | "ThinThickSmallGap" | "ThinThickThinLargeGap" | "ThinThickThinMedGap" | "ThinThickThinSmallGap" | "Triple";
|
|
88868
|
+
/**
|
|
88869
|
+
* Specifies the line width for the border.
|
|
88870
|
+
*
|
|
88871
|
+
* @remarks
|
|
88872
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88873
|
+
* @beta
|
|
88874
|
+
*/
|
|
88875
|
+
lineWidth: Word.LineWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
|
|
88876
|
+
/**
|
|
88877
|
+
* Gets the position type of the border.
|
|
88878
|
+
*
|
|
88879
|
+
* @remarks
|
|
88880
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88881
|
+
* @beta
|
|
88882
|
+
*/
|
|
88883
|
+
readonly positionType: Word.BorderPositionType | "Top" | "Left" | "Bottom" | "Right" | "Horizontal" | "Vertical" | "DiagonalDown" | "DiagonalUp";
|
|
88884
|
+
/**
|
|
88885
|
+
* Specifies whether the border is visible.
|
|
88886
|
+
*
|
|
88887
|
+
* @remarks
|
|
88888
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88889
|
+
* @beta
|
|
88890
|
+
*/
|
|
88891
|
+
visible: boolean;
|
|
88892
|
+
/**
|
|
88893
|
+
* 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.
|
|
88894
|
+
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
88895
|
+
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
88896
|
+
*/
|
|
88897
|
+
set(properties: Interfaces.BorderUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
88898
|
+
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
88899
|
+
set(properties: Word.Border): void;
|
|
88900
|
+
/**
|
|
88901
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
88902
|
+
*
|
|
88903
|
+
* @param options Provides options for which properties of the object to load.
|
|
88904
|
+
*/
|
|
88905
|
+
load(options?: Word.Interfaces.BorderLoadOptions): Word.Border;
|
|
88906
|
+
/**
|
|
88907
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
88908
|
+
*
|
|
88909
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
88910
|
+
*/
|
|
88911
|
+
load(propertyNames?: string | string[]): Word.Border;
|
|
88912
|
+
/**
|
|
88913
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
88914
|
+
*
|
|
88915
|
+
* @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.
|
|
88916
|
+
*/
|
|
88917
|
+
load(propertyNamesAndPaths?: {
|
|
88918
|
+
select?: string;
|
|
88919
|
+
expand?: string;
|
|
88920
|
+
}): Word.Border;
|
|
88921
|
+
/**
|
|
88922
|
+
* 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.
|
|
88923
|
+
*/
|
|
88924
|
+
track(): Word.Border;
|
|
88925
|
+
/**
|
|
88926
|
+
* 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.
|
|
88927
|
+
*/
|
|
88928
|
+
untrack(): Word.Border;
|
|
88929
|
+
/**
|
|
88930
|
+
* 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.)
|
|
88931
|
+
* Whereas the original Word.Border object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BorderData`) that contains shallow copies of any loaded child properties from the original object.
|
|
88932
|
+
*/
|
|
88933
|
+
toJSON(): Word.Interfaces.BorderData;
|
|
88934
|
+
}
|
|
88802
88935
|
/**
|
|
88803
88936
|
* Represents a comment in the document.
|
|
88804
88937
|
*
|
|
@@ -93039,6 +93172,14 @@ declare namespace Word {
|
|
|
93039
93172
|
* [Api set: WordApi 1.1]
|
|
93040
93173
|
*/
|
|
93041
93174
|
readonly text: string;
|
|
93175
|
+
/**
|
|
93176
|
+
* Gets a string that represents the paragraph identifier in the current session.
|
|
93177
|
+
*
|
|
93178
|
+
* @remarks
|
|
93179
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
93180
|
+
* @beta
|
|
93181
|
+
*/
|
|
93182
|
+
readonly uniqueLocalId: string;
|
|
93042
93183
|
/**
|
|
93043
93184
|
* 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.
|
|
93044
93185
|
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
@@ -94881,6 +95022,22 @@ declare namespace Word {
|
|
|
94881
95022
|
* [Api set: WordApi 1.5]
|
|
94882
95023
|
*/
|
|
94883
95024
|
readonly paragraphFormat: Word.ParagraphFormat;
|
|
95025
|
+
/**
|
|
95026
|
+
* Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
|
|
95027
|
+
*
|
|
95028
|
+
* @remarks
|
|
95029
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
95030
|
+
* @beta
|
|
95031
|
+
*/
|
|
95032
|
+
readonly shading: Word.Shading;
|
|
95033
|
+
/**
|
|
95034
|
+
* Gets a TableStyle object representing Style properties that can be applied to a table.
|
|
95035
|
+
*
|
|
95036
|
+
* @remarks
|
|
95037
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
95038
|
+
* @beta
|
|
95039
|
+
*/
|
|
95040
|
+
readonly tableStyle: Word.TableStyle;
|
|
94884
95041
|
/**
|
|
94885
95042
|
* Gets the name of an existing style to use as the base formatting of another style.
|
|
94886
95043
|
*
|
|
@@ -95016,6 +95173,83 @@ declare namespace Word {
|
|
|
95016
95173
|
*/
|
|
95017
95174
|
toJSON(): Word.Interfaces.StyleData;
|
|
95018
95175
|
}
|
|
95176
|
+
/**
|
|
95177
|
+
* Represents the shading object.
|
|
95178
|
+
*
|
|
95179
|
+
* @remarks
|
|
95180
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
95181
|
+
* @beta
|
|
95182
|
+
*/
|
|
95183
|
+
class Shading extends OfficeExtension.ClientObject {
|
|
95184
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
95185
|
+
context: RequestContext;
|
|
95186
|
+
/**
|
|
95187
|
+
* Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name.
|
|
95188
|
+
*
|
|
95189
|
+
* @remarks
|
|
95190
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
95191
|
+
* @beta
|
|
95192
|
+
*/
|
|
95193
|
+
backgroundPatternColor: string;
|
|
95194
|
+
/**
|
|
95195
|
+
* Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name.
|
|
95196
|
+
*
|
|
95197
|
+
* @remarks
|
|
95198
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
95199
|
+
* @beta
|
|
95200
|
+
*/
|
|
95201
|
+
foregroundPatternColor: string;
|
|
95202
|
+
/**
|
|
95203
|
+
* 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}.
|
|
95204
|
+
*
|
|
95205
|
+
* @remarks
|
|
95206
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
95207
|
+
* @beta
|
|
95208
|
+
*/
|
|
95209
|
+
texture: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid";
|
|
95210
|
+
/**
|
|
95211
|
+
* 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.
|
|
95212
|
+
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
95213
|
+
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
95214
|
+
*/
|
|
95215
|
+
set(properties: Interfaces.ShadingUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
95216
|
+
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
95217
|
+
set(properties: Word.Shading): void;
|
|
95218
|
+
/**
|
|
95219
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
95220
|
+
*
|
|
95221
|
+
* @param options Provides options for which properties of the object to load.
|
|
95222
|
+
*/
|
|
95223
|
+
load(options?: Word.Interfaces.ShadingLoadOptions): Word.Shading;
|
|
95224
|
+
/**
|
|
95225
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
95226
|
+
*
|
|
95227
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
95228
|
+
*/
|
|
95229
|
+
load(propertyNames?: string | string[]): Word.Shading;
|
|
95230
|
+
/**
|
|
95231
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
95232
|
+
*
|
|
95233
|
+
* @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.
|
|
95234
|
+
*/
|
|
95235
|
+
load(propertyNamesAndPaths?: {
|
|
95236
|
+
select?: string;
|
|
95237
|
+
expand?: string;
|
|
95238
|
+
}): Word.Shading;
|
|
95239
|
+
/**
|
|
95240
|
+
* 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.
|
|
95241
|
+
*/
|
|
95242
|
+
track(): Word.Shading;
|
|
95243
|
+
/**
|
|
95244
|
+
* 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.
|
|
95245
|
+
*/
|
|
95246
|
+
untrack(): Word.Shading;
|
|
95247
|
+
/**
|
|
95248
|
+
* 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.)
|
|
95249
|
+
* 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.
|
|
95250
|
+
*/
|
|
95251
|
+
toJSON(): Word.Interfaces.ShadingData;
|
|
95252
|
+
}
|
|
95019
95253
|
/**
|
|
95020
95254
|
* Represents a table in a Word document.
|
|
95021
95255
|
*
|
|
@@ -95553,73 +95787,182 @@ declare namespace Word {
|
|
|
95553
95787
|
toJSON(): Word.Interfaces.TableData;
|
|
95554
95788
|
}
|
|
95555
95789
|
/**
|
|
95556
|
-
*
|
|
95790
|
+
* Represents the TableStyle object.
|
|
95557
95791
|
*
|
|
95558
95792
|
* @remarks
|
|
95559
|
-
* [Api set: WordApi
|
|
95793
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
95794
|
+
* @beta
|
|
95560
95795
|
*/
|
|
95561
|
-
class
|
|
95796
|
+
class TableStyle extends OfficeExtension.ClientObject {
|
|
95562
95797
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
95563
95798
|
context: RequestContext;
|
|
95564
|
-
/** Gets the loaded child items in this collection. */
|
|
95565
|
-
readonly items: Word.Table[];
|
|
95566
95799
|
/**
|
|
95567
|
-
*
|
|
95800
|
+
* Specifies the table's alignment against the page margin.
|
|
95568
95801
|
*
|
|
95569
95802
|
* @remarks
|
|
95570
|
-
* [Api set: WordApi
|
|
95803
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
95804
|
+
* @beta
|
|
95571
95805
|
*/
|
|
95572
|
-
|
|
95806
|
+
alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";
|
|
95573
95807
|
/**
|
|
95574
|
-
*
|
|
95808
|
+
* Specifies whether lines in tables formatted with a specified style break across pages.
|
|
95575
95809
|
*
|
|
95576
95810
|
* @remarks
|
|
95577
|
-
* [Api set: WordApi
|
|
95811
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
95812
|
+
* @beta
|
|
95578
95813
|
*/
|
|
95579
|
-
|
|
95814
|
+
allowBreakAcrossPage: boolean;
|
|
95815
|
+
/**
|
|
95816
|
+
* Specifies the amount of space to add between the contents and the bottom borders of the cells.
|
|
95817
|
+
*
|
|
95818
|
+
* @remarks
|
|
95819
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
95820
|
+
* @beta
|
|
95821
|
+
*/
|
|
95822
|
+
bottomCellMargin: number;
|
|
95823
|
+
/**
|
|
95824
|
+
* Specifies the spacing (in points) between the cells in a table style.
|
|
95825
|
+
*
|
|
95826
|
+
* @remarks
|
|
95827
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
95828
|
+
* @beta
|
|
95829
|
+
*/
|
|
95830
|
+
cellSpacing: number;
|
|
95831
|
+
/**
|
|
95832
|
+
* Specifies the amount of space to add between the contents and the left borders of the cells.
|
|
95833
|
+
*
|
|
95834
|
+
* @remarks
|
|
95835
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
95836
|
+
* @beta
|
|
95837
|
+
*/
|
|
95838
|
+
leftCellMargin: number;
|
|
95839
|
+
/**
|
|
95840
|
+
* Specifies the amount of space to add between the contents and the right borders of the cells.
|
|
95841
|
+
*
|
|
95842
|
+
* @remarks
|
|
95843
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
95844
|
+
* @beta
|
|
95845
|
+
*/
|
|
95846
|
+
rightCellMargin: number;
|
|
95847
|
+
/**
|
|
95848
|
+
* Specifies the amount of space to add between the contents and the top borders of the cells.
|
|
95849
|
+
*
|
|
95850
|
+
* @remarks
|
|
95851
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
95852
|
+
* @beta
|
|
95853
|
+
*/
|
|
95854
|
+
topCellMargin: number;
|
|
95855
|
+
/**
|
|
95856
|
+
* 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.
|
|
95857
|
+
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
95858
|
+
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
95859
|
+
*/
|
|
95860
|
+
set(properties: Interfaces.TableStyleUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
95861
|
+
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
95862
|
+
set(properties: Word.TableStyle): void;
|
|
95580
95863
|
/**
|
|
95581
95864
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
95582
95865
|
*
|
|
95583
95866
|
* @param options Provides options for which properties of the object to load.
|
|
95584
95867
|
*/
|
|
95585
|
-
load(options?: Word.Interfaces.
|
|
95868
|
+
load(options?: Word.Interfaces.TableStyleLoadOptions): Word.TableStyle;
|
|
95586
95869
|
/**
|
|
95587
95870
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
95588
95871
|
*
|
|
95589
95872
|
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
95590
95873
|
*/
|
|
95591
|
-
load(propertyNames?: string | string[]): Word.
|
|
95874
|
+
load(propertyNames?: string | string[]): Word.TableStyle;
|
|
95592
95875
|
/**
|
|
95593
95876
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
95594
95877
|
*
|
|
95595
95878
|
* @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.
|
|
95596
95879
|
*/
|
|
95597
|
-
load(propertyNamesAndPaths?:
|
|
95880
|
+
load(propertyNamesAndPaths?: {
|
|
95881
|
+
select?: string;
|
|
95882
|
+
expand?: string;
|
|
95883
|
+
}): Word.TableStyle;
|
|
95598
95884
|
/**
|
|
95599
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
95885
|
+
* 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.
|
|
95600
95886
|
*/
|
|
95601
|
-
track(): Word.
|
|
95887
|
+
track(): Word.TableStyle;
|
|
95602
95888
|
/**
|
|
95603
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
95889
|
+
* 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.
|
|
95604
95890
|
*/
|
|
95605
|
-
untrack(): Word.
|
|
95891
|
+
untrack(): Word.TableStyle;
|
|
95606
95892
|
/**
|
|
95607
|
-
|
|
95608
|
-
|
|
95609
|
-
|
|
95610
|
-
toJSON(): Word.Interfaces.
|
|
95893
|
+
* 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.)
|
|
95894
|
+
* Whereas the original Word.TableStyle object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableStyleData`) that contains shallow copies of any loaded child properties from the original object.
|
|
95895
|
+
*/
|
|
95896
|
+
toJSON(): Word.Interfaces.TableStyleData;
|
|
95611
95897
|
}
|
|
95612
95898
|
/**
|
|
95613
|
-
*
|
|
95899
|
+
* Contains the collection of the document's Table objects.
|
|
95614
95900
|
*
|
|
95615
95901
|
* @remarks
|
|
95616
95902
|
* [Api set: WordApi 1.3]
|
|
95617
95903
|
*/
|
|
95618
|
-
class
|
|
95904
|
+
class TableCollection extends OfficeExtension.ClientObject {
|
|
95619
95905
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
95620
95906
|
context: RequestContext;
|
|
95907
|
+
/** Gets the loaded child items in this collection. */
|
|
95908
|
+
readonly items: Word.Table[];
|
|
95621
95909
|
/**
|
|
95622
|
-
* Gets
|
|
95910
|
+
* Gets the first table in this collection. Throws an `ItemNotFound` error if this collection is empty.
|
|
95911
|
+
*
|
|
95912
|
+
* @remarks
|
|
95913
|
+
* [Api set: WordApi 1.3]
|
|
95914
|
+
*/
|
|
95915
|
+
getFirst(): Word.Table;
|
|
95916
|
+
/**
|
|
95917
|
+
* Gets the first table 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://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
95918
|
+
*
|
|
95919
|
+
* @remarks
|
|
95920
|
+
* [Api set: WordApi 1.3]
|
|
95921
|
+
*/
|
|
95922
|
+
getFirstOrNullObject(): Word.Table;
|
|
95923
|
+
/**
|
|
95924
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
95925
|
+
*
|
|
95926
|
+
* @param options Provides options for which properties of the object to load.
|
|
95927
|
+
*/
|
|
95928
|
+
load(options?: Word.Interfaces.TableCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableCollection;
|
|
95929
|
+
/**
|
|
95930
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
95931
|
+
*
|
|
95932
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
95933
|
+
*/
|
|
95934
|
+
load(propertyNames?: string | string[]): Word.TableCollection;
|
|
95935
|
+
/**
|
|
95936
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
95937
|
+
*
|
|
95938
|
+
* @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.
|
|
95939
|
+
*/
|
|
95940
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableCollection;
|
|
95941
|
+
/**
|
|
95942
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.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.
|
|
95943
|
+
*/
|
|
95944
|
+
track(): Word.TableCollection;
|
|
95945
|
+
/**
|
|
95946
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.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.
|
|
95947
|
+
*/
|
|
95948
|
+
untrack(): Word.TableCollection;
|
|
95949
|
+
/**
|
|
95950
|
+
* 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.)
|
|
95951
|
+
* Whereas the original `Word.TableCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
95952
|
+
*/
|
|
95953
|
+
toJSON(): Word.Interfaces.TableCollectionData;
|
|
95954
|
+
}
|
|
95955
|
+
/**
|
|
95956
|
+
* Represents a row in a Word document.
|
|
95957
|
+
*
|
|
95958
|
+
* @remarks
|
|
95959
|
+
* [Api set: WordApi 1.3]
|
|
95960
|
+
*/
|
|
95961
|
+
class TableRow extends OfficeExtension.ClientObject {
|
|
95962
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
95963
|
+
context: RequestContext;
|
|
95964
|
+
/**
|
|
95965
|
+
* Gets cells. Read-only.
|
|
95623
95966
|
*
|
|
95624
95967
|
* @remarks
|
|
95625
95968
|
* [Api set: WordApi 1.3]
|
|
@@ -96505,6 +96848,27 @@ declare namespace Word {
|
|
|
96505
96848
|
* [Api set: WordApi 1.5]
|
|
96506
96849
|
*/
|
|
96507
96850
|
contentControlExited = "ContentControlExited",
|
|
96851
|
+
/**
|
|
96852
|
+
* Represents that one or more new paragraphs were added.
|
|
96853
|
+
* @remarks
|
|
96854
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
96855
|
+
* @beta
|
|
96856
|
+
*/
|
|
96857
|
+
paragraphAdded = "ParagraphAdded",
|
|
96858
|
+
/**
|
|
96859
|
+
* Represents that one or more paragraphs were changed.
|
|
96860
|
+
* @remarks
|
|
96861
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
96862
|
+
* @beta
|
|
96863
|
+
*/
|
|
96864
|
+
paragraphChanged = "ParagraphChanged",
|
|
96865
|
+
/**
|
|
96866
|
+
* Represents that one or more paragraphs were deleted.
|
|
96867
|
+
* @remarks
|
|
96868
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
96869
|
+
* @beta
|
|
96870
|
+
*/
|
|
96871
|
+
paragraphDeleted = "ParagraphDeleted",
|
|
96508
96872
|
}
|
|
96509
96873
|
/**
|
|
96510
96874
|
* An enum that specifies an event's source. It can be local or remote (through coauthoring).
|
|
@@ -96547,7 +96911,7 @@ declare namespace Word {
|
|
|
96547
96911
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
96548
96912
|
* @beta
|
|
96549
96913
|
*/
|
|
96550
|
-
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited";
|
|
96914
|
+
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
96551
96915
|
/**
|
|
96552
96916
|
* Gets the content control IDs.
|
|
96553
96917
|
*
|
|
@@ -96578,7 +96942,7 @@ declare namespace Word {
|
|
|
96578
96942
|
* @remarks
|
|
96579
96943
|
* [Api set: WordApi 1.5]
|
|
96580
96944
|
*/
|
|
96581
|
-
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited";
|
|
96945
|
+
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
96582
96946
|
/**
|
|
96583
96947
|
* Gets the content control IDs.
|
|
96584
96948
|
*
|
|
@@ -96607,7 +96971,7 @@ declare namespace Word {
|
|
|
96607
96971
|
* @remarks
|
|
96608
96972
|
* [Api set: WordApi 1.5]
|
|
96609
96973
|
*/
|
|
96610
|
-
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited";
|
|
96974
|
+
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
96611
96975
|
/**
|
|
96612
96976
|
* Gets the content control IDs.
|
|
96613
96977
|
*
|
|
@@ -96636,7 +97000,7 @@ declare namespace Word {
|
|
|
96636
97000
|
* @remarks
|
|
96637
97001
|
* [Api set: WordApi 1.5]
|
|
96638
97002
|
*/
|
|
96639
|
-
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited";
|
|
97003
|
+
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
96640
97004
|
/**
|
|
96641
97005
|
* Gets the content control IDs.
|
|
96642
97006
|
*
|
|
@@ -96665,7 +97029,7 @@ declare namespace Word {
|
|
|
96665
97029
|
* @remarks
|
|
96666
97030
|
* [Api set: WordApi 1.5]
|
|
96667
97031
|
*/
|
|
96668
|
-
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited";
|
|
97032
|
+
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
96669
97033
|
/**
|
|
96670
97034
|
* Gets the content control IDs.
|
|
96671
97035
|
*
|
|
@@ -96694,7 +97058,7 @@ declare namespace Word {
|
|
|
96694
97058
|
* @remarks
|
|
96695
97059
|
* [Api set: WordApi 1.5]
|
|
96696
97060
|
*/
|
|
96697
|
-
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited";
|
|
97061
|
+
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
96698
97062
|
/**
|
|
96699
97063
|
* Gets the content control IDs.
|
|
96700
97064
|
*
|
|
@@ -96723,7 +97087,7 @@ declare namespace Word {
|
|
|
96723
97087
|
* @remarks
|
|
96724
97088
|
* [Api set: WordApi 1.5]
|
|
96725
97089
|
*/
|
|
96726
|
-
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited";
|
|
97090
|
+
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
96727
97091
|
/**
|
|
96728
97092
|
* Gets the content control IDs.
|
|
96729
97093
|
*
|
|
@@ -96739,6 +97103,105 @@ declare namespace Word {
|
|
|
96739
97103
|
*/
|
|
96740
97104
|
source: Word.EventSource | "Local" | "Remote";
|
|
96741
97105
|
}
|
|
97106
|
+
/**
|
|
97107
|
+
* Provides information about the paragraphs that raised the paragraphAdded event.
|
|
97108
|
+
*
|
|
97109
|
+
* @remarks
|
|
97110
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97111
|
+
* @beta
|
|
97112
|
+
*/
|
|
97113
|
+
interface ParagraphAddedEventArgs {
|
|
97114
|
+
/**
|
|
97115
|
+
* Gets the IDs of the involved paragraphs.
|
|
97116
|
+
*
|
|
97117
|
+
* @remarks
|
|
97118
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97119
|
+
* @beta
|
|
97120
|
+
*/
|
|
97121
|
+
ids: string[];
|
|
97122
|
+
/**
|
|
97123
|
+
* The source of the event. It can be local or remote (through coauthoring).
|
|
97124
|
+
*
|
|
97125
|
+
* @remarks
|
|
97126
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97127
|
+
* @beta
|
|
97128
|
+
*/
|
|
97129
|
+
source: Word.EventSource | "Local" | "Remote";
|
|
97130
|
+
/**
|
|
97131
|
+
* The event type. See Word.EventType for details.
|
|
97132
|
+
*
|
|
97133
|
+
* @remarks
|
|
97134
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97135
|
+
* @beta
|
|
97136
|
+
*/
|
|
97137
|
+
type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
97138
|
+
}
|
|
97139
|
+
/**
|
|
97140
|
+
* Provides information about the paragraphs that raised the paragraphChanged event.
|
|
97141
|
+
*
|
|
97142
|
+
* @remarks
|
|
97143
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97144
|
+
* @beta
|
|
97145
|
+
*/
|
|
97146
|
+
interface ParagraphChangedEventArgs {
|
|
97147
|
+
/**
|
|
97148
|
+
* Gets the IDs of the involved paragraphs.
|
|
97149
|
+
*
|
|
97150
|
+
* @remarks
|
|
97151
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97152
|
+
* @beta
|
|
97153
|
+
*/
|
|
97154
|
+
ids: string[];
|
|
97155
|
+
/**
|
|
97156
|
+
* The source of the event. It can be local or remote (through coauthoring).
|
|
97157
|
+
*
|
|
97158
|
+
* @remarks
|
|
97159
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97160
|
+
* @beta
|
|
97161
|
+
*/
|
|
97162
|
+
source: Word.EventSource | "Local" | "Remote";
|
|
97163
|
+
/**
|
|
97164
|
+
* The event type. See Word.EventType for details.
|
|
97165
|
+
*
|
|
97166
|
+
* @remarks
|
|
97167
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97168
|
+
* @beta
|
|
97169
|
+
*/
|
|
97170
|
+
type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
97171
|
+
}
|
|
97172
|
+
/**
|
|
97173
|
+
* Provides information about the paragraphs that raised the paragraphDeleted event.
|
|
97174
|
+
*
|
|
97175
|
+
* @remarks
|
|
97176
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97177
|
+
* @beta
|
|
97178
|
+
*/
|
|
97179
|
+
interface ParagraphDeletedEventArgs {
|
|
97180
|
+
/**
|
|
97181
|
+
* Gets the IDs of the involved paragraphs.
|
|
97182
|
+
*
|
|
97183
|
+
* @remarks
|
|
97184
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97185
|
+
* @beta
|
|
97186
|
+
*/
|
|
97187
|
+
ids: string[];
|
|
97188
|
+
/**
|
|
97189
|
+
* The source of the event. It can be local or remote (through coauthoring).
|
|
97190
|
+
*
|
|
97191
|
+
* @remarks
|
|
97192
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97193
|
+
* @beta
|
|
97194
|
+
*/
|
|
97195
|
+
source: Word.EventSource | "Local" | "Remote";
|
|
97196
|
+
/**
|
|
97197
|
+
* The event type. See Word.EventType for details.
|
|
97198
|
+
*
|
|
97199
|
+
* @remarks
|
|
97200
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97201
|
+
* @beta
|
|
97202
|
+
*/
|
|
97203
|
+
type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
97204
|
+
}
|
|
96742
97205
|
/**
|
|
96743
97206
|
* Provides information about the comments that raised the comment event.
|
|
96744
97207
|
*
|
|
@@ -96778,7 +97241,7 @@ declare namespace Word {
|
|
|
96778
97241
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
96779
97242
|
* @beta
|
|
96780
97243
|
*/
|
|
96781
|
-
type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited";
|
|
97244
|
+
type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
96782
97245
|
}
|
|
96783
97246
|
/**
|
|
96784
97247
|
* A structure for the ID and reply IDs of this comment.
|
|
@@ -97601,40 +98064,375 @@ declare namespace Word {
|
|
|
97601
98064
|
inside = "Inside",
|
|
97602
98065
|
/**
|
|
97603
98066
|
* @remarks
|
|
97604
|
-
* [Api set: WordApi 1.3]
|
|
98067
|
+
* [Api set: WordApi 1.3]
|
|
98068
|
+
*/
|
|
98069
|
+
outside = "Outside",
|
|
98070
|
+
/**
|
|
98071
|
+
* @remarks
|
|
98072
|
+
* [Api set: WordApi 1.3]
|
|
98073
|
+
*/
|
|
98074
|
+
all = "All",
|
|
98075
|
+
}
|
|
98076
|
+
/**
|
|
98077
|
+
* @remarks
|
|
98078
|
+
* [Api set: WordApi 1.3]
|
|
98079
|
+
*/
|
|
98080
|
+
enum CellPaddingLocation {
|
|
98081
|
+
/**
|
|
98082
|
+
* @remarks
|
|
98083
|
+
* [Api set: WordApi 1.3]
|
|
98084
|
+
*/
|
|
98085
|
+
top = "Top",
|
|
98086
|
+
/**
|
|
98087
|
+
* @remarks
|
|
98088
|
+
* [Api set: WordApi 1.3]
|
|
98089
|
+
*/
|
|
98090
|
+
left = "Left",
|
|
98091
|
+
/**
|
|
98092
|
+
* @remarks
|
|
98093
|
+
* [Api set: WordApi 1.3]
|
|
98094
|
+
*/
|
|
98095
|
+
bottom = "Bottom",
|
|
98096
|
+
/**
|
|
98097
|
+
* @remarks
|
|
98098
|
+
* [Api set: WordApi 1.3]
|
|
98099
|
+
*/
|
|
98100
|
+
right = "Right",
|
|
98101
|
+
}
|
|
98102
|
+
/**
|
|
98103
|
+
* Represents the line style for the specified border.
|
|
98104
|
+
*
|
|
98105
|
+
* @remarks
|
|
98106
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98107
|
+
* @beta
|
|
98108
|
+
*/
|
|
98109
|
+
enum LineStyle {
|
|
98110
|
+
/**
|
|
98111
|
+
* Represents the dash-dot line style.
|
|
98112
|
+
* @remarks
|
|
98113
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98114
|
+
* @beta
|
|
98115
|
+
*/
|
|
98116
|
+
dashDot = "DashDot",
|
|
98117
|
+
/**
|
|
98118
|
+
* Represents the dash-dot-dot line style.
|
|
98119
|
+
* @remarks
|
|
98120
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98121
|
+
* @beta
|
|
98122
|
+
*/
|
|
98123
|
+
dashDotDot = "DashDotDot",
|
|
98124
|
+
/**
|
|
98125
|
+
* Represents the dash-dot-stroked line style.
|
|
98126
|
+
* @remarks
|
|
98127
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98128
|
+
* @beta
|
|
98129
|
+
*/
|
|
98130
|
+
dashDotStroked = "DashDotStroked",
|
|
98131
|
+
/**
|
|
98132
|
+
* Represents the line style of dashes with large gaps.
|
|
98133
|
+
* @remarks
|
|
98134
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98135
|
+
* @beta
|
|
98136
|
+
*/
|
|
98137
|
+
dashLargeGap = "DashLargeGap",
|
|
98138
|
+
/**
|
|
98139
|
+
* Represents the line style of dashes with small gaps.
|
|
98140
|
+
* @remarks
|
|
98141
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98142
|
+
* @beta
|
|
98143
|
+
*/
|
|
98144
|
+
dashSmallGap = "DashSmallGap",
|
|
98145
|
+
/**
|
|
98146
|
+
* Represents the dot line style.
|
|
98147
|
+
* @remarks
|
|
98148
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98149
|
+
* @beta
|
|
98150
|
+
*/
|
|
98151
|
+
dot = "Dot",
|
|
98152
|
+
/**
|
|
98153
|
+
* Represents the double line style.
|
|
98154
|
+
* @remarks
|
|
98155
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98156
|
+
* @beta
|
|
98157
|
+
*/
|
|
98158
|
+
double = "Double",
|
|
98159
|
+
/**
|
|
98160
|
+
* Represents the double-wavy line style.
|
|
98161
|
+
* @remarks
|
|
98162
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98163
|
+
* @beta
|
|
98164
|
+
*/
|
|
98165
|
+
doubleWavy = "DoubleWavy",
|
|
98166
|
+
/**
|
|
98167
|
+
* Represents the emboss-3D line style.
|
|
98168
|
+
* @remarks
|
|
98169
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98170
|
+
* @beta
|
|
98171
|
+
*/
|
|
98172
|
+
emboss3D = "Emboss3D",
|
|
98173
|
+
/**
|
|
98174
|
+
* Represents the engrave-3D line style.
|
|
98175
|
+
* @remarks
|
|
98176
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98177
|
+
* @beta
|
|
98178
|
+
*/
|
|
98179
|
+
engrave3D = "Engrave3D",
|
|
98180
|
+
/**
|
|
98181
|
+
* Represents the inset line style.
|
|
98182
|
+
* @remarks
|
|
98183
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98184
|
+
* @beta
|
|
98185
|
+
*/
|
|
98186
|
+
inset = "Inset",
|
|
98187
|
+
/**
|
|
98188
|
+
* Represents that there's no line style.
|
|
98189
|
+
* @remarks
|
|
98190
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98191
|
+
* @beta
|
|
98192
|
+
*/
|
|
98193
|
+
none = "None",
|
|
98194
|
+
/**
|
|
98195
|
+
* Represents the outset line style.
|
|
98196
|
+
* @remarks
|
|
98197
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98198
|
+
* @beta
|
|
98199
|
+
*/
|
|
98200
|
+
outset = "Outset",
|
|
98201
|
+
/**
|
|
98202
|
+
* Represents the single line style.
|
|
98203
|
+
* @remarks
|
|
98204
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98205
|
+
* @beta
|
|
98206
|
+
*/
|
|
98207
|
+
single = "Single",
|
|
98208
|
+
/**
|
|
98209
|
+
* Represents the single-wavy line style.
|
|
98210
|
+
* @remarks
|
|
98211
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98212
|
+
* @beta
|
|
98213
|
+
*/
|
|
98214
|
+
singleWavy = "SingleWavy",
|
|
98215
|
+
/**
|
|
98216
|
+
* Represents the internal single thick solid line surrounded by a single thin solid line with a large gap between them.
|
|
98217
|
+
* @remarks
|
|
98218
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98219
|
+
* @beta
|
|
98220
|
+
*/
|
|
98221
|
+
thickThinLargeGap = "ThickThinLargeGap",
|
|
98222
|
+
/**
|
|
98223
|
+
* Represents the internal single thick solid line surrounded by a single thin solid line with a medium gap between them.
|
|
98224
|
+
* @remarks
|
|
98225
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98226
|
+
* @beta
|
|
98227
|
+
*/
|
|
98228
|
+
thickThinMedGap = "ThickThinMedGap",
|
|
98229
|
+
/**
|
|
98230
|
+
* Represents the internal single thick solid line surrounded by a single thin solid line with a small gap between them.
|
|
98231
|
+
* @remarks
|
|
98232
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98233
|
+
* @beta
|
|
98234
|
+
*/
|
|
98235
|
+
thickThinSmallGap = "ThickThinSmallGap",
|
|
98236
|
+
/**
|
|
98237
|
+
* Represents the internal single thin solid line surrounded by a single thick solid line with a large gap between them.
|
|
98238
|
+
* @remarks
|
|
98239
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98240
|
+
* @beta
|
|
98241
|
+
*/
|
|
98242
|
+
thinThickLargeGap = "ThinThickLargeGap",
|
|
98243
|
+
/**
|
|
98244
|
+
* Represents the internal single thin solid line surrounded by a single thick solid line with a medium gap between them.
|
|
98245
|
+
* @remarks
|
|
98246
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98247
|
+
* @beta
|
|
98248
|
+
*/
|
|
98249
|
+
thinThickMedGap = "ThinThickMedGap",
|
|
98250
|
+
/**
|
|
98251
|
+
* Represents the internal single thin solid line surrounded by a single thick solid line with a small gap between them.
|
|
98252
|
+
* @remarks
|
|
98253
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98254
|
+
* @beta
|
|
98255
|
+
*/
|
|
98256
|
+
thinThickSmallGap = "ThinThickSmallGap",
|
|
98257
|
+
/**
|
|
98258
|
+
* Represents the internal single thin solid line surrounded by a single thick solid line surrounded by a single thin solid line with a large gap between all lines.
|
|
98259
|
+
* @remarks
|
|
98260
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98261
|
+
* @beta
|
|
98262
|
+
*/
|
|
98263
|
+
thinThickThinLargeGap = "ThinThickThinLargeGap",
|
|
98264
|
+
/**
|
|
98265
|
+
* Represents the internal single thin solid line surrounded by a single thick solid line surrounded by a single thin solid line with a medium gap between all lines.
|
|
98266
|
+
* @remarks
|
|
98267
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98268
|
+
* @beta
|
|
98269
|
+
*/
|
|
98270
|
+
thinThickThinMedGap = "ThinThickThinMedGap",
|
|
98271
|
+
/**
|
|
98272
|
+
* Represents the internal single thin solid line surrounded by a single thick solid line surrounded by a single thin solid line with a small gap between all lines.
|
|
98273
|
+
* @remarks
|
|
98274
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98275
|
+
* @beta
|
|
98276
|
+
*/
|
|
98277
|
+
thinThickThinSmallGap = "ThinThickThinSmallGap",
|
|
98278
|
+
/**
|
|
98279
|
+
* Represents the triple line style.
|
|
98280
|
+
* @remarks
|
|
98281
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98282
|
+
* @beta
|
|
98283
|
+
*/
|
|
98284
|
+
triple = "Triple",
|
|
98285
|
+
}
|
|
98286
|
+
/**
|
|
98287
|
+
* Represents the width of a style's border.
|
|
98288
|
+
*
|
|
98289
|
+
* @remarks
|
|
98290
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98291
|
+
* @beta
|
|
98292
|
+
*/
|
|
98293
|
+
enum LineWidth {
|
|
98294
|
+
/**
|
|
98295
|
+
* None width.
|
|
98296
|
+
* @remarks
|
|
98297
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98298
|
+
* @beta
|
|
98299
|
+
*/
|
|
98300
|
+
none = "None",
|
|
98301
|
+
/**
|
|
98302
|
+
* 0.25 point.
|
|
98303
|
+
* @remarks
|
|
98304
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98305
|
+
* @beta
|
|
98306
|
+
*/
|
|
98307
|
+
pt025 = "Pt025",
|
|
98308
|
+
/**
|
|
98309
|
+
* 0.50 point.
|
|
98310
|
+
* @remarks
|
|
98311
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98312
|
+
* @beta
|
|
98313
|
+
*/
|
|
98314
|
+
pt050 = "Pt050",
|
|
98315
|
+
/**
|
|
98316
|
+
* 0.75 point.
|
|
98317
|
+
* @remarks
|
|
98318
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98319
|
+
* @beta
|
|
98320
|
+
*/
|
|
98321
|
+
pt075 = "Pt075",
|
|
98322
|
+
/**
|
|
98323
|
+
* 1.00 point. This is the default.
|
|
98324
|
+
* @remarks
|
|
98325
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98326
|
+
* @beta
|
|
98327
|
+
*/
|
|
98328
|
+
pt100 = "Pt100",
|
|
98329
|
+
/**
|
|
98330
|
+
* 1.50 points.
|
|
98331
|
+
* @remarks
|
|
98332
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98333
|
+
* @beta
|
|
98334
|
+
*/
|
|
98335
|
+
pt150 = "Pt150",
|
|
98336
|
+
/**
|
|
98337
|
+
* 2.25 points.
|
|
98338
|
+
* @remarks
|
|
98339
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98340
|
+
* @beta
|
|
98341
|
+
*/
|
|
98342
|
+
pt225 = "Pt225",
|
|
98343
|
+
/**
|
|
98344
|
+
* 3.00 points.
|
|
98345
|
+
* @remarks
|
|
98346
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98347
|
+
* @beta
|
|
98348
|
+
*/
|
|
98349
|
+
pt300 = "Pt300",
|
|
98350
|
+
/**
|
|
98351
|
+
* 4.50 points.
|
|
98352
|
+
* @remarks
|
|
98353
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98354
|
+
* @beta
|
|
98355
|
+
*/
|
|
98356
|
+
pt450 = "Pt450",
|
|
98357
|
+
/**
|
|
98358
|
+
* 6.00 points.
|
|
98359
|
+
* @remarks
|
|
98360
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98361
|
+
* @beta
|
|
98362
|
+
*/
|
|
98363
|
+
pt600 = "Pt600",
|
|
98364
|
+
/**
|
|
98365
|
+
* Mixed width.
|
|
98366
|
+
* @remarks
|
|
98367
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98368
|
+
* @beta
|
|
98369
|
+
*/
|
|
98370
|
+
mixed = "Mixed",
|
|
98371
|
+
}
|
|
98372
|
+
/**
|
|
98373
|
+
* Represents the position of a style's border.
|
|
98374
|
+
*
|
|
98375
|
+
* @remarks
|
|
98376
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98377
|
+
* @beta
|
|
98378
|
+
*/
|
|
98379
|
+
enum BorderPositionType {
|
|
98380
|
+
/**
|
|
98381
|
+
* Represents the top border.
|
|
98382
|
+
* @remarks
|
|
98383
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98384
|
+
* @beta
|
|
98385
|
+
*/
|
|
98386
|
+
top = "Top",
|
|
98387
|
+
/**
|
|
98388
|
+
* Represents the left border.
|
|
98389
|
+
* @remarks
|
|
98390
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98391
|
+
* @beta
|
|
98392
|
+
*/
|
|
98393
|
+
left = "Left",
|
|
98394
|
+
/**
|
|
98395
|
+
* Represents the bottom border.
|
|
98396
|
+
* @remarks
|
|
98397
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98398
|
+
* @beta
|
|
97605
98399
|
*/
|
|
97606
|
-
|
|
98400
|
+
bottom = "Bottom",
|
|
97607
98401
|
/**
|
|
98402
|
+
* Represents the right border.
|
|
97608
98403
|
* @remarks
|
|
97609
|
-
* [Api set: WordApi
|
|
98404
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98405
|
+
* @beta
|
|
97610
98406
|
*/
|
|
97611
|
-
|
|
97612
|
-
}
|
|
97613
|
-
/**
|
|
97614
|
-
* @remarks
|
|
97615
|
-
* [Api set: WordApi 1.3]
|
|
97616
|
-
*/
|
|
97617
|
-
enum CellPaddingLocation {
|
|
98407
|
+
right = "Right",
|
|
97618
98408
|
/**
|
|
98409
|
+
* Represents the horizontal borders.
|
|
97619
98410
|
* @remarks
|
|
97620
|
-
* [Api set: WordApi
|
|
98411
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98412
|
+
* @beta
|
|
97621
98413
|
*/
|
|
97622
|
-
|
|
98414
|
+
horizontal = "Horizontal",
|
|
97623
98415
|
/**
|
|
98416
|
+
* Represents the vertical borders.
|
|
97624
98417
|
* @remarks
|
|
97625
|
-
* [Api set: WordApi
|
|
98418
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98419
|
+
* @beta
|
|
97626
98420
|
*/
|
|
97627
|
-
|
|
98421
|
+
vertical = "Vertical",
|
|
97628
98422
|
/**
|
|
98423
|
+
* Represents the diagonal borders starting in the upper-left corner.
|
|
97629
98424
|
* @remarks
|
|
97630
|
-
* [Api set: WordApi
|
|
98425
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98426
|
+
* @beta
|
|
97631
98427
|
*/
|
|
97632
|
-
|
|
98428
|
+
diagonalDown = "DiagonalDown",
|
|
97633
98429
|
/**
|
|
98430
|
+
* Represents the diagonal borders starting in the lower-left corner.
|
|
97634
98431
|
* @remarks
|
|
97635
|
-
* [Api set: WordApi
|
|
98432
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98433
|
+
* @beta
|
|
97636
98434
|
*/
|
|
97637
|
-
|
|
98435
|
+
diagonalUp = "DiagonalUp",
|
|
97638
98436
|
}
|
|
97639
98437
|
/**
|
|
97640
98438
|
* @remarks
|
|
@@ -99773,6 +100571,274 @@ declare namespace Word {
|
|
|
99773
100571
|
*/
|
|
99774
100572
|
legalLZ = "LegalLZ",
|
|
99775
100573
|
}
|
|
100574
|
+
/**
|
|
100575
|
+
* 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}.
|
|
100576
|
+
*
|
|
100577
|
+
* @remarks
|
|
100578
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100579
|
+
* @beta
|
|
100580
|
+
*/
|
|
100581
|
+
enum ShadingTextureType {
|
|
100582
|
+
/**
|
|
100583
|
+
* Represents dark diagonal-down texture.
|
|
100584
|
+
* @remarks
|
|
100585
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100586
|
+
* @beta
|
|
100587
|
+
*/
|
|
100588
|
+
darkDiagonalDown = "DarkDiagonalDown",
|
|
100589
|
+
/**
|
|
100590
|
+
* Represents dark diagonal-up texture.
|
|
100591
|
+
* @remarks
|
|
100592
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100593
|
+
* @beta
|
|
100594
|
+
*/
|
|
100595
|
+
darkDiagonalUp = "DarkDiagonalUp",
|
|
100596
|
+
/**
|
|
100597
|
+
* Represents dark horizontal-cross texture.
|
|
100598
|
+
* @remarks
|
|
100599
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100600
|
+
* @beta
|
|
100601
|
+
*/
|
|
100602
|
+
darkGrid = "DarkGrid",
|
|
100603
|
+
/**
|
|
100604
|
+
* Represents dark horizontal texture.
|
|
100605
|
+
* @remarks
|
|
100606
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100607
|
+
* @beta
|
|
100608
|
+
*/
|
|
100609
|
+
darkHorizontal = "DarkHorizontal",
|
|
100610
|
+
/**
|
|
100611
|
+
* Represents dark diagonal-cross texture.
|
|
100612
|
+
* @remarks
|
|
100613
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100614
|
+
* @beta
|
|
100615
|
+
*/
|
|
100616
|
+
darkTrellis = "DarkTrellis",
|
|
100617
|
+
/**
|
|
100618
|
+
* Represents dark vertical texture.
|
|
100619
|
+
* @remarks
|
|
100620
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100621
|
+
* @beta
|
|
100622
|
+
*/
|
|
100623
|
+
darkVertical = "DarkVertical",
|
|
100624
|
+
/**
|
|
100625
|
+
* Represents light diagonal-down texture.
|
|
100626
|
+
* @remarks
|
|
100627
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100628
|
+
* @beta
|
|
100629
|
+
*/
|
|
100630
|
+
lightDiagonalDown = "LightDiagonalDown",
|
|
100631
|
+
/**
|
|
100632
|
+
* Represents light diagonal-up texture.
|
|
100633
|
+
* @remarks
|
|
100634
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100635
|
+
* @beta
|
|
100636
|
+
*/
|
|
100637
|
+
lightDiagonalUp = "LightDiagonalUp",
|
|
100638
|
+
/**
|
|
100639
|
+
* Represents light horizontal-cross texture.
|
|
100640
|
+
* @remarks
|
|
100641
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100642
|
+
* @beta
|
|
100643
|
+
*/
|
|
100644
|
+
lightGrid = "LightGrid",
|
|
100645
|
+
/**
|
|
100646
|
+
* Represents light horizontal texture.
|
|
100647
|
+
* @remarks
|
|
100648
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100649
|
+
* @beta
|
|
100650
|
+
*/
|
|
100651
|
+
lightHorizontal = "LightHorizontal",
|
|
100652
|
+
/**
|
|
100653
|
+
* Represents light diagonal-cross texture.
|
|
100654
|
+
* @remarks
|
|
100655
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100656
|
+
* @beta
|
|
100657
|
+
*/
|
|
100658
|
+
lightTrellis = "LightTrellis",
|
|
100659
|
+
/**
|
|
100660
|
+
* Represents light vertical texture.
|
|
100661
|
+
* @remarks
|
|
100662
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100663
|
+
* @beta
|
|
100664
|
+
*/
|
|
100665
|
+
lightVertical = "LightVertical",
|
|
100666
|
+
/**
|
|
100667
|
+
* Represents that there's no texture.
|
|
100668
|
+
* @remarks
|
|
100669
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100670
|
+
* @beta
|
|
100671
|
+
*/
|
|
100672
|
+
none = "None",
|
|
100673
|
+
/**
|
|
100674
|
+
* Represents 10 percent texture.
|
|
100675
|
+
* @remarks
|
|
100676
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100677
|
+
* @beta
|
|
100678
|
+
*/
|
|
100679
|
+
percent10 = "Percent10",
|
|
100680
|
+
/**
|
|
100681
|
+
* Represents 12.5 percent texture.
|
|
100682
|
+
* @remarks
|
|
100683
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100684
|
+
* @beta
|
|
100685
|
+
*/
|
|
100686
|
+
percent12Pt5 = "Percent12Pt5",
|
|
100687
|
+
/**
|
|
100688
|
+
* Represents 15 percent texture.
|
|
100689
|
+
* @remarks
|
|
100690
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100691
|
+
* @beta
|
|
100692
|
+
*/
|
|
100693
|
+
percent15 = "Percent15",
|
|
100694
|
+
/**
|
|
100695
|
+
* Represents 20 percent texture.
|
|
100696
|
+
* @remarks
|
|
100697
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100698
|
+
* @beta
|
|
100699
|
+
*/
|
|
100700
|
+
percent20 = "Percent20",
|
|
100701
|
+
/**
|
|
100702
|
+
* Represents 25 percent texture.
|
|
100703
|
+
* @remarks
|
|
100704
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100705
|
+
* @beta
|
|
100706
|
+
*/
|
|
100707
|
+
percent25 = "Percent25",
|
|
100708
|
+
/**
|
|
100709
|
+
* Represents 30 percent texture.
|
|
100710
|
+
* @remarks
|
|
100711
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100712
|
+
* @beta
|
|
100713
|
+
*/
|
|
100714
|
+
percent30 = "Percent30",
|
|
100715
|
+
/**
|
|
100716
|
+
* Represents 35 percent texture.
|
|
100717
|
+
* @remarks
|
|
100718
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100719
|
+
* @beta
|
|
100720
|
+
*/
|
|
100721
|
+
percent35 = "Percent35",
|
|
100722
|
+
/**
|
|
100723
|
+
* Represents 37.5 percent texture.
|
|
100724
|
+
* @remarks
|
|
100725
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100726
|
+
* @beta
|
|
100727
|
+
*/
|
|
100728
|
+
percent37Pt5 = "Percent37Pt5",
|
|
100729
|
+
/**
|
|
100730
|
+
* Represents 40 percent texture.
|
|
100731
|
+
* @remarks
|
|
100732
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100733
|
+
* @beta
|
|
100734
|
+
*/
|
|
100735
|
+
percent40 = "Percent40",
|
|
100736
|
+
/**
|
|
100737
|
+
* Represents 45 percent texture.
|
|
100738
|
+
* @remarks
|
|
100739
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100740
|
+
* @beta
|
|
100741
|
+
*/
|
|
100742
|
+
percent45 = "Percent45",
|
|
100743
|
+
/**
|
|
100744
|
+
* Represents 5 percent texture.
|
|
100745
|
+
* @remarks
|
|
100746
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100747
|
+
* @beta
|
|
100748
|
+
*/
|
|
100749
|
+
percent5 = "Percent5",
|
|
100750
|
+
/**
|
|
100751
|
+
* Represents 50 percent texture.
|
|
100752
|
+
* @remarks
|
|
100753
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100754
|
+
* @beta
|
|
100755
|
+
*/
|
|
100756
|
+
percent50 = "Percent50",
|
|
100757
|
+
/**
|
|
100758
|
+
* Represents 55 percent texture.
|
|
100759
|
+
* @remarks
|
|
100760
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100761
|
+
* @beta
|
|
100762
|
+
*/
|
|
100763
|
+
percent55 = "Percent55",
|
|
100764
|
+
/**
|
|
100765
|
+
* Represents 60 percent texture.
|
|
100766
|
+
* @remarks
|
|
100767
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100768
|
+
* @beta
|
|
100769
|
+
*/
|
|
100770
|
+
percent60 = "Percent60",
|
|
100771
|
+
/**
|
|
100772
|
+
* Represents 62.5 percent texture.
|
|
100773
|
+
* @remarks
|
|
100774
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100775
|
+
* @beta
|
|
100776
|
+
*/
|
|
100777
|
+
percent62Pt5 = "Percent62Pt5",
|
|
100778
|
+
/**
|
|
100779
|
+
* Represents 65 percent texture.
|
|
100780
|
+
* @remarks
|
|
100781
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100782
|
+
* @beta
|
|
100783
|
+
*/
|
|
100784
|
+
percent65 = "Percent65",
|
|
100785
|
+
/**
|
|
100786
|
+
* Represents 70 percent texture.
|
|
100787
|
+
* @remarks
|
|
100788
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100789
|
+
* @beta
|
|
100790
|
+
*/
|
|
100791
|
+
percent70 = "Percent70",
|
|
100792
|
+
/**
|
|
100793
|
+
* Represents 75 percent texture.
|
|
100794
|
+
* @remarks
|
|
100795
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100796
|
+
* @beta
|
|
100797
|
+
*/
|
|
100798
|
+
percent75 = "Percent75",
|
|
100799
|
+
/**
|
|
100800
|
+
* Represents 80 percent texture.
|
|
100801
|
+
* @remarks
|
|
100802
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100803
|
+
* @beta
|
|
100804
|
+
*/
|
|
100805
|
+
percent80 = "Percent80",
|
|
100806
|
+
/**
|
|
100807
|
+
* Represents 85 percent texture.
|
|
100808
|
+
* @remarks
|
|
100809
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100810
|
+
* @beta
|
|
100811
|
+
*/
|
|
100812
|
+
percent85 = "Percent85",
|
|
100813
|
+
/**
|
|
100814
|
+
* Represents 87.5 percent texture.
|
|
100815
|
+
* @remarks
|
|
100816
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100817
|
+
* @beta
|
|
100818
|
+
*/
|
|
100819
|
+
percent87Pt5 = "Percent87Pt5",
|
|
100820
|
+
/**
|
|
100821
|
+
* Represents 90 percent texture.
|
|
100822
|
+
* @remarks
|
|
100823
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100824
|
+
* @beta
|
|
100825
|
+
*/
|
|
100826
|
+
percent90 = "Percent90",
|
|
100827
|
+
/**
|
|
100828
|
+
* Represents 95 percent texture.
|
|
100829
|
+
* @remarks
|
|
100830
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100831
|
+
* @beta
|
|
100832
|
+
*/
|
|
100833
|
+
percent95 = "Percent95",
|
|
100834
|
+
/**
|
|
100835
|
+
* Represents solid texture.
|
|
100836
|
+
* @remarks
|
|
100837
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100838
|
+
* @beta
|
|
100839
|
+
*/
|
|
100840
|
+
solid = "Solid",
|
|
100841
|
+
}
|
|
99776
100842
|
enum ErrorCodes {
|
|
99777
100843
|
accessDenied = "AccessDenied",
|
|
99778
100844
|
generalException = "GeneralException",
|
|
@@ -99811,14 +100877,49 @@ declare namespace Word {
|
|
|
99811
100877
|
* @remarks
|
|
99812
100878
|
* [Api set: WordApi 1.1]
|
|
99813
100879
|
*/
|
|
99814
|
-
style?: string;
|
|
100880
|
+
style?: string;
|
|
100881
|
+
/**
|
|
100882
|
+
* Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property.
|
|
100883
|
+
*
|
|
100884
|
+
* @remarks
|
|
100885
|
+
* [Api set: WordApi 1.3]
|
|
100886
|
+
*/
|
|
100887
|
+
styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";
|
|
100888
|
+
}
|
|
100889
|
+
/** An interface for updating data on the Border object, for use in `border.set({ ... })`. */
|
|
100890
|
+
interface BorderUpdateData {
|
|
100891
|
+
/**
|
|
100892
|
+
* Specifies the line color for the border.
|
|
100893
|
+
*
|
|
100894
|
+
* @remarks
|
|
100895
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100896
|
+
* @beta
|
|
100897
|
+
*/
|
|
100898
|
+
lineColor?: string;
|
|
100899
|
+
/**
|
|
100900
|
+
* Specifies the line style for the border.
|
|
100901
|
+
*
|
|
100902
|
+
* @remarks
|
|
100903
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100904
|
+
* @beta
|
|
100905
|
+
*/
|
|
100906
|
+
lineStyle?: Word.LineStyle | "DashDot" | "DashDotDot" | "DashDotStroked" | "DashLargeGap" | "DashSmallGap" | "Dot" | "Double" | "DoubleWavy" | "Emboss3D" | "Engrave3D" | "Inset" | "None" | "Outset" | "Single" | "SingleWavy" | "ThickThinLargeGap" | "ThickThinMedGap" | "ThickThinSmallGap" | "ThinThickLargeGap" | "ThinThickMedGap" | "ThinThickSmallGap" | "ThinThickThinLargeGap" | "ThinThickThinMedGap" | "ThinThickThinSmallGap" | "Triple";
|
|
100907
|
+
/**
|
|
100908
|
+
* Specifies the line width for the border.
|
|
100909
|
+
*
|
|
100910
|
+
* @remarks
|
|
100911
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100912
|
+
* @beta
|
|
100913
|
+
*/
|
|
100914
|
+
lineWidth?: Word.LineWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
|
|
99815
100915
|
/**
|
|
99816
|
-
* Specifies
|
|
100916
|
+
* Specifies whether the border is visible.
|
|
99817
100917
|
*
|
|
99818
100918
|
* @remarks
|
|
99819
|
-
* [Api set: WordApi
|
|
100919
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100920
|
+
* @beta
|
|
99820
100921
|
*/
|
|
99821
|
-
|
|
100922
|
+
visible?: boolean;
|
|
99822
100923
|
}
|
|
99823
100924
|
/** An interface for updating data on the Comment object, for use in `comment.set({ ... })`. */
|
|
99824
100925
|
interface CommentUpdateData {
|
|
@@ -100775,27 +101876,43 @@ declare namespace Word {
|
|
|
100775
101876
|
/** An interface for updating data on the Style object, for use in `style.set({ ... })`. */
|
|
100776
101877
|
interface StyleUpdateData {
|
|
100777
101878
|
/**
|
|
100778
|
-
|
|
100779
|
-
|
|
100780
|
-
|
|
100781
|
-
|
|
100782
|
-
|
|
101879
|
+
* Gets a font object that represents the character formatting of the specified style.
|
|
101880
|
+
*
|
|
101881
|
+
* @remarks
|
|
101882
|
+
* [Api set: WordApi 1.5]
|
|
101883
|
+
*/
|
|
100783
101884
|
font?: Word.Interfaces.FontUpdateData;
|
|
100784
101885
|
/**
|
|
100785
|
-
|
|
100786
|
-
|
|
100787
|
-
|
|
100788
|
-
|
|
100789
|
-
|
|
100790
|
-
|
|
101886
|
+
* Gets a ListTemplate object that represents the list formatting for the specified Style object.
|
|
101887
|
+
*
|
|
101888
|
+
* @remarks
|
|
101889
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
101890
|
+
* @beta
|
|
101891
|
+
*/
|
|
100791
101892
|
listTemplate?: Word.Interfaces.ListTemplateUpdateData;
|
|
100792
101893
|
/**
|
|
100793
|
-
|
|
100794
|
-
|
|
100795
|
-
|
|
100796
|
-
|
|
100797
|
-
|
|
101894
|
+
* Gets a ParagraphFormat object that represents the paragraph settings for the specified style.
|
|
101895
|
+
*
|
|
101896
|
+
* @remarks
|
|
101897
|
+
* [Api set: WordApi 1.5]
|
|
101898
|
+
*/
|
|
100798
101899
|
paragraphFormat?: Word.Interfaces.ParagraphFormatUpdateData;
|
|
101900
|
+
/**
|
|
101901
|
+
* Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
|
|
101902
|
+
*
|
|
101903
|
+
* @remarks
|
|
101904
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
101905
|
+
* @beta
|
|
101906
|
+
*/
|
|
101907
|
+
shading?: Word.Interfaces.ShadingUpdateData;
|
|
101908
|
+
/**
|
|
101909
|
+
* Gets a TableStyle object representing Style properties that can be applied to a table.
|
|
101910
|
+
*
|
|
101911
|
+
* @remarks
|
|
101912
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
101913
|
+
* @beta
|
|
101914
|
+
*/
|
|
101915
|
+
tableStyle?: Word.Interfaces.TableStyleUpdateData;
|
|
100799
101916
|
/**
|
|
100800
101917
|
* Specifies the priority.
|
|
100801
101918
|
*
|
|
@@ -100825,6 +101942,33 @@ declare namespace Word {
|
|
|
100825
101942
|
*/
|
|
100826
101943
|
visibility?: boolean;
|
|
100827
101944
|
}
|
|
101945
|
+
/** An interface for updating data on the Shading object, for use in `shading.set({ ... })`. */
|
|
101946
|
+
interface ShadingUpdateData {
|
|
101947
|
+
/**
|
|
101948
|
+
* Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name.
|
|
101949
|
+
*
|
|
101950
|
+
* @remarks
|
|
101951
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
101952
|
+
* @beta
|
|
101953
|
+
*/
|
|
101954
|
+
backgroundPatternColor?: string;
|
|
101955
|
+
/**
|
|
101956
|
+
* Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name.
|
|
101957
|
+
*
|
|
101958
|
+
* @remarks
|
|
101959
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
101960
|
+
* @beta
|
|
101961
|
+
*/
|
|
101962
|
+
foregroundPatternColor?: string;
|
|
101963
|
+
/**
|
|
101964
|
+
* 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}.
|
|
101965
|
+
*
|
|
101966
|
+
* @remarks
|
|
101967
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
101968
|
+
* @beta
|
|
101969
|
+
*/
|
|
101970
|
+
texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid";
|
|
101971
|
+
}
|
|
100828
101972
|
/** An interface for updating data on the Table object, for use in `table.set({ ... })`. */
|
|
100829
101973
|
interface TableUpdateData {
|
|
100830
101974
|
/**
|
|
@@ -100933,6 +102077,65 @@ declare namespace Word {
|
|
|
100933
102077
|
*/
|
|
100934
102078
|
width?: number;
|
|
100935
102079
|
}
|
|
102080
|
+
/** An interface for updating data on the TableStyle object, for use in `tableStyle.set({ ... })`. */
|
|
102081
|
+
interface TableStyleUpdateData {
|
|
102082
|
+
/**
|
|
102083
|
+
* Specifies the table's alignment against the page margin.
|
|
102084
|
+
*
|
|
102085
|
+
* @remarks
|
|
102086
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102087
|
+
* @beta
|
|
102088
|
+
*/
|
|
102089
|
+
alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";
|
|
102090
|
+
/**
|
|
102091
|
+
* Specifies whether lines in tables formatted with a specified style break across pages.
|
|
102092
|
+
*
|
|
102093
|
+
* @remarks
|
|
102094
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102095
|
+
* @beta
|
|
102096
|
+
*/
|
|
102097
|
+
allowBreakAcrossPage?: boolean;
|
|
102098
|
+
/**
|
|
102099
|
+
* Specifies the amount of space to add between the contents and the bottom borders of the cells.
|
|
102100
|
+
*
|
|
102101
|
+
* @remarks
|
|
102102
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102103
|
+
* @beta
|
|
102104
|
+
*/
|
|
102105
|
+
bottomCellMargin?: number;
|
|
102106
|
+
/**
|
|
102107
|
+
* Specifies the spacing (in points) between the cells in a table style.
|
|
102108
|
+
*
|
|
102109
|
+
* @remarks
|
|
102110
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102111
|
+
* @beta
|
|
102112
|
+
*/
|
|
102113
|
+
cellSpacing?: number;
|
|
102114
|
+
/**
|
|
102115
|
+
* Specifies the amount of space to add between the contents and the left borders of the cells.
|
|
102116
|
+
*
|
|
102117
|
+
* @remarks
|
|
102118
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102119
|
+
* @beta
|
|
102120
|
+
*/
|
|
102121
|
+
leftCellMargin?: number;
|
|
102122
|
+
/**
|
|
102123
|
+
* Specifies the amount of space to add between the contents and the right borders of the cells.
|
|
102124
|
+
*
|
|
102125
|
+
* @remarks
|
|
102126
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102127
|
+
* @beta
|
|
102128
|
+
*/
|
|
102129
|
+
rightCellMargin?: number;
|
|
102130
|
+
/**
|
|
102131
|
+
* Specifies the amount of space to add between the contents and the top borders of the cells.
|
|
102132
|
+
*
|
|
102133
|
+
* @remarks
|
|
102134
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102135
|
+
* @beta
|
|
102136
|
+
*/
|
|
102137
|
+
topCellMargin?: number;
|
|
102138
|
+
}
|
|
100936
102139
|
/** An interface for updating data on the TableCollection object, for use in `tableCollection.set({ ... })`. */
|
|
100937
102140
|
interface TableCollectionUpdateData {
|
|
100938
102141
|
items?: Word.Interfaces.TableData[];
|
|
@@ -101139,6 +102342,49 @@ declare namespace Word {
|
|
|
101139
102342
|
*/
|
|
101140
102343
|
type?: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem";
|
|
101141
102344
|
}
|
|
102345
|
+
/** An interface describing the data returned by calling `border.toJSON()`. */
|
|
102346
|
+
interface BorderData {
|
|
102347
|
+
/**
|
|
102348
|
+
* Specifies the line color for the border.
|
|
102349
|
+
*
|
|
102350
|
+
* @remarks
|
|
102351
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102352
|
+
* @beta
|
|
102353
|
+
*/
|
|
102354
|
+
lineColor?: string;
|
|
102355
|
+
/**
|
|
102356
|
+
* Specifies the line style for the border.
|
|
102357
|
+
*
|
|
102358
|
+
* @remarks
|
|
102359
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102360
|
+
* @beta
|
|
102361
|
+
*/
|
|
102362
|
+
lineStyle?: Word.LineStyle | "DashDot" | "DashDotDot" | "DashDotStroked" | "DashLargeGap" | "DashSmallGap" | "Dot" | "Double" | "DoubleWavy" | "Emboss3D" | "Engrave3D" | "Inset" | "None" | "Outset" | "Single" | "SingleWavy" | "ThickThinLargeGap" | "ThickThinMedGap" | "ThickThinSmallGap" | "ThinThickLargeGap" | "ThinThickMedGap" | "ThinThickSmallGap" | "ThinThickThinLargeGap" | "ThinThickThinMedGap" | "ThinThickThinSmallGap" | "Triple";
|
|
102363
|
+
/**
|
|
102364
|
+
* Specifies the line width for the border.
|
|
102365
|
+
*
|
|
102366
|
+
* @remarks
|
|
102367
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102368
|
+
* @beta
|
|
102369
|
+
*/
|
|
102370
|
+
lineWidth?: Word.LineWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
|
|
102371
|
+
/**
|
|
102372
|
+
* Gets the position type of the border.
|
|
102373
|
+
*
|
|
102374
|
+
* @remarks
|
|
102375
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102376
|
+
* @beta
|
|
102377
|
+
*/
|
|
102378
|
+
positionType?: Word.BorderPositionType | "Top" | "Left" | "Bottom" | "Right" | "Horizontal" | "Vertical" | "DiagonalDown" | "DiagonalUp";
|
|
102379
|
+
/**
|
|
102380
|
+
* Specifies whether the border is visible.
|
|
102381
|
+
*
|
|
102382
|
+
* @remarks
|
|
102383
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102384
|
+
* @beta
|
|
102385
|
+
*/
|
|
102386
|
+
visible?: boolean;
|
|
102387
|
+
}
|
|
101142
102388
|
/** An interface describing the data returned by calling `comment.toJSON()`. */
|
|
101143
102389
|
interface CommentData {
|
|
101144
102390
|
/**
|
|
@@ -102303,6 +103549,14 @@ declare namespace Word {
|
|
|
102303
103549
|
* [Api set: WordApi 1.1]
|
|
102304
103550
|
*/
|
|
102305
103551
|
text?: string;
|
|
103552
|
+
/**
|
|
103553
|
+
* Gets a string that represents the paragraph identifier in the current session.
|
|
103554
|
+
*
|
|
103555
|
+
* @remarks
|
|
103556
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
103557
|
+
* @beta
|
|
103558
|
+
*/
|
|
103559
|
+
uniqueLocalId?: string;
|
|
102306
103560
|
}
|
|
102307
103561
|
/** An interface describing the data returned by calling `paragraphCollection.toJSON()`. */
|
|
102308
103562
|
interface ParagraphCollectionData {
|
|
@@ -102566,27 +103820,43 @@ declare namespace Word {
|
|
|
102566
103820
|
/** An interface describing the data returned by calling `style.toJSON()`. */
|
|
102567
103821
|
interface StyleData {
|
|
102568
103822
|
/**
|
|
102569
|
-
|
|
102570
|
-
|
|
102571
|
-
|
|
102572
|
-
|
|
102573
|
-
|
|
103823
|
+
* Gets a font object that represents the character formatting of the specified style.
|
|
103824
|
+
*
|
|
103825
|
+
* @remarks
|
|
103826
|
+
* [Api set: WordApi 1.5]
|
|
103827
|
+
*/
|
|
102574
103828
|
font?: Word.Interfaces.FontData;
|
|
102575
103829
|
/**
|
|
102576
|
-
|
|
102577
|
-
|
|
102578
|
-
|
|
102579
|
-
|
|
102580
|
-
|
|
102581
|
-
|
|
103830
|
+
* Gets a ListTemplate object that represents the list formatting for the specified Style object.
|
|
103831
|
+
*
|
|
103832
|
+
* @remarks
|
|
103833
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
103834
|
+
* @beta
|
|
103835
|
+
*/
|
|
102582
103836
|
listTemplate?: Word.Interfaces.ListTemplateData;
|
|
102583
103837
|
/**
|
|
102584
|
-
|
|
102585
|
-
|
|
102586
|
-
|
|
102587
|
-
|
|
102588
|
-
|
|
103838
|
+
* Gets a ParagraphFormat object that represents the paragraph settings for the specified style.
|
|
103839
|
+
*
|
|
103840
|
+
* @remarks
|
|
103841
|
+
* [Api set: WordApi 1.5]
|
|
103842
|
+
*/
|
|
102589
103843
|
paragraphFormat?: Word.Interfaces.ParagraphFormatData;
|
|
103844
|
+
/**
|
|
103845
|
+
* Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
|
|
103846
|
+
*
|
|
103847
|
+
* @remarks
|
|
103848
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
103849
|
+
* @beta
|
|
103850
|
+
*/
|
|
103851
|
+
shading?: Word.Interfaces.ShadingData;
|
|
103852
|
+
/**
|
|
103853
|
+
* Gets a TableStyle object representing Style properties that can be applied to a table.
|
|
103854
|
+
*
|
|
103855
|
+
* @remarks
|
|
103856
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
103857
|
+
* @beta
|
|
103858
|
+
*/
|
|
103859
|
+
tableStyle?: Word.Interfaces.TableStyleData;
|
|
102590
103860
|
/**
|
|
102591
103861
|
* Gets the name of an existing style to use as the base formatting of another style.
|
|
102592
103862
|
*
|
|
@@ -102673,6 +103943,33 @@ declare namespace Word {
|
|
|
102673
103943
|
*/
|
|
102674
103944
|
visibility?: boolean;
|
|
102675
103945
|
}
|
|
103946
|
+
/** An interface describing the data returned by calling `shading.toJSON()`. */
|
|
103947
|
+
interface ShadingData {
|
|
103948
|
+
/**
|
|
103949
|
+
* Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name.
|
|
103950
|
+
*
|
|
103951
|
+
* @remarks
|
|
103952
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
103953
|
+
* @beta
|
|
103954
|
+
*/
|
|
103955
|
+
backgroundPatternColor?: string;
|
|
103956
|
+
/**
|
|
103957
|
+
* Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name.
|
|
103958
|
+
*
|
|
103959
|
+
* @remarks
|
|
103960
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
103961
|
+
* @beta
|
|
103962
|
+
*/
|
|
103963
|
+
foregroundPatternColor?: string;
|
|
103964
|
+
/**
|
|
103965
|
+
* 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}.
|
|
103966
|
+
*
|
|
103967
|
+
* @remarks
|
|
103968
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
103969
|
+
* @beta
|
|
103970
|
+
*/
|
|
103971
|
+
texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid";
|
|
103972
|
+
}
|
|
102676
103973
|
/** An interface describing the data returned by calling `table.toJSON()`. */
|
|
102677
103974
|
interface TableData {
|
|
102678
103975
|
/**
|
|
@@ -102772,56 +104069,115 @@ declare namespace Word {
|
|
|
102772
104069
|
* @remarks
|
|
102773
104070
|
* [Api set: WordApi 1.3]
|
|
102774
104071
|
*/
|
|
102775
|
-
styleBandedRows?: boolean;
|
|
104072
|
+
styleBandedRows?: boolean;
|
|
104073
|
+
/**
|
|
104074
|
+
* Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property.
|
|
104075
|
+
*
|
|
104076
|
+
* @remarks
|
|
104077
|
+
* [Api set: WordApi 1.3]
|
|
104078
|
+
*/
|
|
104079
|
+
styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";
|
|
104080
|
+
/**
|
|
104081
|
+
* Specifies whether the table has a first column with a special style.
|
|
104082
|
+
*
|
|
104083
|
+
* @remarks
|
|
104084
|
+
* [Api set: WordApi 1.3]
|
|
104085
|
+
*/
|
|
104086
|
+
styleFirstColumn?: boolean;
|
|
104087
|
+
/**
|
|
104088
|
+
* Specifies whether the table has a last column with a special style.
|
|
104089
|
+
*
|
|
104090
|
+
* @remarks
|
|
104091
|
+
* [Api set: WordApi 1.3]
|
|
104092
|
+
*/
|
|
104093
|
+
styleLastColumn?: boolean;
|
|
104094
|
+
/**
|
|
104095
|
+
* Specifies whether the table has a total (last) row with a special style.
|
|
104096
|
+
*
|
|
104097
|
+
* @remarks
|
|
104098
|
+
* [Api set: WordApi 1.3]
|
|
104099
|
+
*/
|
|
104100
|
+
styleTotalRow?: boolean;
|
|
104101
|
+
/**
|
|
104102
|
+
* Specifies the text values in the table, as a 2D JavaScript array.
|
|
104103
|
+
*
|
|
104104
|
+
* @remarks
|
|
104105
|
+
* [Api set: WordApi 1.3]
|
|
104106
|
+
*/
|
|
104107
|
+
values?: string[][];
|
|
104108
|
+
/**
|
|
104109
|
+
* Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'.
|
|
104110
|
+
*
|
|
104111
|
+
* @remarks
|
|
104112
|
+
* [Api set: WordApi 1.3]
|
|
104113
|
+
*/
|
|
104114
|
+
verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom";
|
|
104115
|
+
/**
|
|
104116
|
+
* Specifies the width of the table in points.
|
|
104117
|
+
*
|
|
104118
|
+
* @remarks
|
|
104119
|
+
* [Api set: WordApi 1.3]
|
|
104120
|
+
*/
|
|
104121
|
+
width?: number;
|
|
104122
|
+
}
|
|
104123
|
+
/** An interface describing the data returned by calling `tableStyle.toJSON()`. */
|
|
104124
|
+
interface TableStyleData {
|
|
102776
104125
|
/**
|
|
102777
|
-
* Specifies the
|
|
104126
|
+
* Specifies the table's alignment against the page margin.
|
|
102778
104127
|
*
|
|
102779
104128
|
* @remarks
|
|
102780
|
-
* [Api set: WordApi
|
|
104129
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104130
|
+
* @beta
|
|
102781
104131
|
*/
|
|
102782
|
-
|
|
104132
|
+
alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";
|
|
102783
104133
|
/**
|
|
102784
|
-
* Specifies whether
|
|
104134
|
+
* Specifies whether lines in tables formatted with a specified style break across pages.
|
|
102785
104135
|
*
|
|
102786
104136
|
* @remarks
|
|
102787
|
-
* [Api set: WordApi
|
|
104137
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104138
|
+
* @beta
|
|
102788
104139
|
*/
|
|
102789
|
-
|
|
104140
|
+
allowBreakAcrossPage?: boolean;
|
|
102790
104141
|
/**
|
|
102791
|
-
* Specifies
|
|
104142
|
+
* Specifies the amount of space to add between the contents and the bottom borders of the cells.
|
|
102792
104143
|
*
|
|
102793
104144
|
* @remarks
|
|
102794
|
-
* [Api set: WordApi
|
|
104145
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104146
|
+
* @beta
|
|
102795
104147
|
*/
|
|
102796
|
-
|
|
104148
|
+
bottomCellMargin?: number;
|
|
102797
104149
|
/**
|
|
102798
|
-
* Specifies
|
|
104150
|
+
* Specifies the spacing (in points) between the cells in a table style.
|
|
102799
104151
|
*
|
|
102800
104152
|
* @remarks
|
|
102801
|
-
* [Api set: WordApi
|
|
104153
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104154
|
+
* @beta
|
|
102802
104155
|
*/
|
|
102803
|
-
|
|
104156
|
+
cellSpacing?: number;
|
|
102804
104157
|
/**
|
|
102805
|
-
* Specifies the
|
|
104158
|
+
* Specifies the amount of space to add between the contents and the left borders of the cells.
|
|
102806
104159
|
*
|
|
102807
104160
|
* @remarks
|
|
102808
|
-
* [Api set: WordApi
|
|
104161
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104162
|
+
* @beta
|
|
102809
104163
|
*/
|
|
102810
|
-
|
|
104164
|
+
leftCellMargin?: number;
|
|
102811
104165
|
/**
|
|
102812
|
-
* Specifies the
|
|
104166
|
+
* Specifies the amount of space to add between the contents and the right borders of the cells.
|
|
102813
104167
|
*
|
|
102814
104168
|
* @remarks
|
|
102815
|
-
* [Api set: WordApi
|
|
104169
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104170
|
+
* @beta
|
|
102816
104171
|
*/
|
|
102817
|
-
|
|
104172
|
+
rightCellMargin?: number;
|
|
102818
104173
|
/**
|
|
102819
|
-
* Specifies the
|
|
104174
|
+
* Specifies the amount of space to add between the contents and the top borders of the cells.
|
|
102820
104175
|
*
|
|
102821
104176
|
* @remarks
|
|
102822
|
-
* [Api set: WordApi
|
|
104177
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104178
|
+
* @beta
|
|
102823
104179
|
*/
|
|
102824
|
-
|
|
104180
|
+
topCellMargin?: number;
|
|
102825
104181
|
}
|
|
102826
104182
|
/** An interface describing the data returned by calling `tableCollection.toJSON()`. */
|
|
102827
104183
|
interface TableCollectionData {
|
|
@@ -103094,6 +104450,59 @@ declare namespace Word {
|
|
|
103094
104450
|
*/
|
|
103095
104451
|
type?: boolean;
|
|
103096
104452
|
}
|
|
104453
|
+
/**
|
|
104454
|
+
* Represents the Border object for text, a paragraph, or a table.
|
|
104455
|
+
*
|
|
104456
|
+
* @remarks
|
|
104457
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104458
|
+
* @beta
|
|
104459
|
+
*/
|
|
104460
|
+
interface BorderLoadOptions {
|
|
104461
|
+
/**
|
|
104462
|
+
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`).
|
|
104463
|
+
*/
|
|
104464
|
+
$all?: boolean;
|
|
104465
|
+
/**
|
|
104466
|
+
* Specifies the line color for the border.
|
|
104467
|
+
*
|
|
104468
|
+
* @remarks
|
|
104469
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104470
|
+
* @beta
|
|
104471
|
+
*/
|
|
104472
|
+
lineColor?: boolean;
|
|
104473
|
+
/**
|
|
104474
|
+
* Specifies the line style for the border.
|
|
104475
|
+
*
|
|
104476
|
+
* @remarks
|
|
104477
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104478
|
+
* @beta
|
|
104479
|
+
*/
|
|
104480
|
+
lineStyle?: boolean;
|
|
104481
|
+
/**
|
|
104482
|
+
* Specifies the line width for the border.
|
|
104483
|
+
*
|
|
104484
|
+
* @remarks
|
|
104485
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104486
|
+
* @beta
|
|
104487
|
+
*/
|
|
104488
|
+
lineWidth?: boolean;
|
|
104489
|
+
/**
|
|
104490
|
+
* Gets the position type of the border.
|
|
104491
|
+
*
|
|
104492
|
+
* @remarks
|
|
104493
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104494
|
+
* @beta
|
|
104495
|
+
*/
|
|
104496
|
+
positionType?: boolean;
|
|
104497
|
+
/**
|
|
104498
|
+
* Specifies whether the border is visible.
|
|
104499
|
+
*
|
|
104500
|
+
* @remarks
|
|
104501
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104502
|
+
* @beta
|
|
104503
|
+
*/
|
|
104504
|
+
visible?: boolean;
|
|
104505
|
+
}
|
|
103097
104506
|
/**
|
|
103098
104507
|
* Represents a comment in the document.
|
|
103099
104508
|
*
|
|
@@ -105209,6 +106618,14 @@ declare namespace Word {
|
|
|
105209
106618
|
* [Api set: WordApi 1.1]
|
|
105210
106619
|
*/
|
|
105211
106620
|
text?: boolean;
|
|
106621
|
+
/**
|
|
106622
|
+
* Gets a string that represents the paragraph identifier in the current session.
|
|
106623
|
+
*
|
|
106624
|
+
* @remarks
|
|
106625
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
106626
|
+
* @beta
|
|
106627
|
+
*/
|
|
106628
|
+
uniqueLocalId?: boolean;
|
|
105212
106629
|
}
|
|
105213
106630
|
/**
|
|
105214
106631
|
* Contains a collection of {@link Word.Paragraph} objects.
|
|
@@ -105417,6 +106834,14 @@ declare namespace Word {
|
|
|
105417
106834
|
* [Api set: WordApi 1.1]
|
|
105418
106835
|
*/
|
|
105419
106836
|
text?: boolean;
|
|
106837
|
+
/**
|
|
106838
|
+
* For EACH ITEM in the collection: Gets a string that represents the paragraph identifier in the current session.
|
|
106839
|
+
*
|
|
106840
|
+
* @remarks
|
|
106841
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
106842
|
+
* @beta
|
|
106843
|
+
*/
|
|
106844
|
+
uniqueLocalId?: boolean;
|
|
105420
106845
|
}
|
|
105421
106846
|
/**
|
|
105422
106847
|
* Represents a style of paragraph in a document.
|
|
@@ -105898,27 +107323,43 @@ declare namespace Word {
|
|
|
105898
107323
|
*/
|
|
105899
107324
|
$all?: boolean;
|
|
105900
107325
|
/**
|
|
105901
|
-
|
|
105902
|
-
|
|
105903
|
-
|
|
105904
|
-
|
|
105905
|
-
|
|
107326
|
+
* For EACH ITEM in the collection: Gets a font object that represents the character formatting of the specified style.
|
|
107327
|
+
*
|
|
107328
|
+
* @remarks
|
|
107329
|
+
* [Api set: WordApi 1.5]
|
|
107330
|
+
*/
|
|
105906
107331
|
font?: Word.Interfaces.FontLoadOptions;
|
|
105907
107332
|
/**
|
|
105908
|
-
|
|
105909
|
-
|
|
105910
|
-
|
|
105911
|
-
|
|
105912
|
-
|
|
105913
|
-
|
|
107333
|
+
* For EACH ITEM in the collection: Gets a ListTemplate object that represents the list formatting for the specified Style object.
|
|
107334
|
+
*
|
|
107335
|
+
* @remarks
|
|
107336
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
107337
|
+
* @beta
|
|
107338
|
+
*/
|
|
105914
107339
|
listTemplate?: Word.Interfaces.ListTemplateLoadOptions;
|
|
105915
107340
|
/**
|
|
105916
|
-
|
|
105917
|
-
|
|
105918
|
-
|
|
105919
|
-
|
|
105920
|
-
|
|
107341
|
+
* For EACH ITEM in the collection: Gets a ParagraphFormat object that represents the paragraph settings for the specified style.
|
|
107342
|
+
*
|
|
107343
|
+
* @remarks
|
|
107344
|
+
* [Api set: WordApi 1.5]
|
|
107345
|
+
*/
|
|
105921
107346
|
paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions;
|
|
107347
|
+
/**
|
|
107348
|
+
* For EACH ITEM in the collection: Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
|
|
107349
|
+
*
|
|
107350
|
+
* @remarks
|
|
107351
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
107352
|
+
* @beta
|
|
107353
|
+
*/
|
|
107354
|
+
shading?: Word.Interfaces.ShadingLoadOptions;
|
|
107355
|
+
/**
|
|
107356
|
+
* For EACH ITEM in the collection: Gets a TableStyle object representing Style properties that can be applied to a table.
|
|
107357
|
+
*
|
|
107358
|
+
* @remarks
|
|
107359
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
107360
|
+
* @beta
|
|
107361
|
+
*/
|
|
107362
|
+
tableStyle?: Word.Interfaces.TableStyleLoadOptions;
|
|
105922
107363
|
/**
|
|
105923
107364
|
* For EACH ITEM in the collection: Gets the name of an existing style to use as the base formatting of another style.
|
|
105924
107365
|
*
|
|
@@ -106017,27 +107458,43 @@ declare namespace Word {
|
|
|
106017
107458
|
*/
|
|
106018
107459
|
$all?: boolean;
|
|
106019
107460
|
/**
|
|
106020
|
-
|
|
106021
|
-
|
|
106022
|
-
|
|
106023
|
-
|
|
106024
|
-
|
|
107461
|
+
* Gets a font object that represents the character formatting of the specified style.
|
|
107462
|
+
*
|
|
107463
|
+
* @remarks
|
|
107464
|
+
* [Api set: WordApi 1.5]
|
|
107465
|
+
*/
|
|
106025
107466
|
font?: Word.Interfaces.FontLoadOptions;
|
|
106026
107467
|
/**
|
|
106027
|
-
|
|
106028
|
-
|
|
106029
|
-
|
|
106030
|
-
|
|
106031
|
-
|
|
106032
|
-
|
|
107468
|
+
* Gets a ListTemplate object that represents the list formatting for the specified Style object.
|
|
107469
|
+
*
|
|
107470
|
+
* @remarks
|
|
107471
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
107472
|
+
* @beta
|
|
107473
|
+
*/
|
|
106033
107474
|
listTemplate?: Word.Interfaces.ListTemplateLoadOptions;
|
|
106034
107475
|
/**
|
|
106035
|
-
|
|
106036
|
-
|
|
106037
|
-
|
|
106038
|
-
|
|
106039
|
-
|
|
107476
|
+
* Gets a ParagraphFormat object that represents the paragraph settings for the specified style.
|
|
107477
|
+
*
|
|
107478
|
+
* @remarks
|
|
107479
|
+
* [Api set: WordApi 1.5]
|
|
107480
|
+
*/
|
|
106040
107481
|
paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions;
|
|
107482
|
+
/**
|
|
107483
|
+
* Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
|
|
107484
|
+
*
|
|
107485
|
+
* @remarks
|
|
107486
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
107487
|
+
* @beta
|
|
107488
|
+
*/
|
|
107489
|
+
shading?: Word.Interfaces.ShadingLoadOptions;
|
|
107490
|
+
/**
|
|
107491
|
+
* Gets a TableStyle object representing Style properties that can be applied to a table.
|
|
107492
|
+
*
|
|
107493
|
+
* @remarks
|
|
107494
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
107495
|
+
* @beta
|
|
107496
|
+
*/
|
|
107497
|
+
tableStyle?: Word.Interfaces.TableStyleLoadOptions;
|
|
106041
107498
|
/**
|
|
106042
107499
|
* Gets the name of an existing style to use as the base formatting of another style.
|
|
106043
107500
|
*
|
|
@@ -106124,6 +107581,43 @@ declare namespace Word {
|
|
|
106124
107581
|
*/
|
|
106125
107582
|
visibility?: boolean;
|
|
106126
107583
|
}
|
|
107584
|
+
/**
|
|
107585
|
+
* Represents the shading object.
|
|
107586
|
+
*
|
|
107587
|
+
* @remarks
|
|
107588
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
107589
|
+
* @beta
|
|
107590
|
+
*/
|
|
107591
|
+
interface ShadingLoadOptions {
|
|
107592
|
+
/**
|
|
107593
|
+
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`).
|
|
107594
|
+
*/
|
|
107595
|
+
$all?: boolean;
|
|
107596
|
+
/**
|
|
107597
|
+
* Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name.
|
|
107598
|
+
*
|
|
107599
|
+
* @remarks
|
|
107600
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
107601
|
+
* @beta
|
|
107602
|
+
*/
|
|
107603
|
+
backgroundPatternColor?: boolean;
|
|
107604
|
+
/**
|
|
107605
|
+
* Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name.
|
|
107606
|
+
*
|
|
107607
|
+
* @remarks
|
|
107608
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
107609
|
+
* @beta
|
|
107610
|
+
*/
|
|
107611
|
+
foregroundPatternColor?: boolean;
|
|
107612
|
+
/**
|
|
107613
|
+
* Specifies the shading texture of the object.
|
|
107614
|
+
*
|
|
107615
|
+
* @remarks
|
|
107616
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
107617
|
+
* @beta
|
|
107618
|
+
*/
|
|
107619
|
+
texture?: boolean;
|
|
107620
|
+
}
|
|
106127
107621
|
/**
|
|
106128
107622
|
* Represents a table in a Word document.
|
|
106129
107623
|
*
|
|
@@ -106311,6 +107805,75 @@ declare namespace Word {
|
|
|
106311
107805
|
*/
|
|
106312
107806
|
width?: boolean;
|
|
106313
107807
|
}
|
|
107808
|
+
/**
|
|
107809
|
+
* Represents the TableStyle object.
|
|
107810
|
+
*
|
|
107811
|
+
* @remarks
|
|
107812
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
107813
|
+
* @beta
|
|
107814
|
+
*/
|
|
107815
|
+
interface TableStyleLoadOptions {
|
|
107816
|
+
/**
|
|
107817
|
+
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`).
|
|
107818
|
+
*/
|
|
107819
|
+
$all?: boolean;
|
|
107820
|
+
/**
|
|
107821
|
+
* Specifies the table's alignment against the page margin.
|
|
107822
|
+
*
|
|
107823
|
+
* @remarks
|
|
107824
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
107825
|
+
* @beta
|
|
107826
|
+
*/
|
|
107827
|
+
alignment?: boolean;
|
|
107828
|
+
/**
|
|
107829
|
+
* Specifies whether lines in tables formatted with a specified style break across pages.
|
|
107830
|
+
*
|
|
107831
|
+
* @remarks
|
|
107832
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
107833
|
+
* @beta
|
|
107834
|
+
*/
|
|
107835
|
+
allowBreakAcrossPage?: boolean;
|
|
107836
|
+
/**
|
|
107837
|
+
* Specifies the amount of space to add between the contents and the bottom borders of the cells.
|
|
107838
|
+
*
|
|
107839
|
+
* @remarks
|
|
107840
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
107841
|
+
* @beta
|
|
107842
|
+
*/
|
|
107843
|
+
bottomCellMargin?: boolean;
|
|
107844
|
+
/**
|
|
107845
|
+
* Specifies the spacing (in points) between the cells in a table style.
|
|
107846
|
+
*
|
|
107847
|
+
* @remarks
|
|
107848
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
107849
|
+
* @beta
|
|
107850
|
+
*/
|
|
107851
|
+
cellSpacing?: boolean;
|
|
107852
|
+
/**
|
|
107853
|
+
* Specifies the amount of space to add between the contents and the left borders of the cells.
|
|
107854
|
+
*
|
|
107855
|
+
* @remarks
|
|
107856
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
107857
|
+
* @beta
|
|
107858
|
+
*/
|
|
107859
|
+
leftCellMargin?: boolean;
|
|
107860
|
+
/**
|
|
107861
|
+
* Specifies the amount of space to add between the contents and the right borders of the cells.
|
|
107862
|
+
*
|
|
107863
|
+
* @remarks
|
|
107864
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
107865
|
+
* @beta
|
|
107866
|
+
*/
|
|
107867
|
+
rightCellMargin?: boolean;
|
|
107868
|
+
/**
|
|
107869
|
+
* Specifies the amount of space to add between the contents and the top borders of the cells.
|
|
107870
|
+
*
|
|
107871
|
+
* @remarks
|
|
107872
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
107873
|
+
* @beta
|
|
107874
|
+
*/
|
|
107875
|
+
topCellMargin?: boolean;
|
|
107876
|
+
}
|
|
106314
107877
|
/**
|
|
106315
107878
|
* Contains the collection of the document's Table objects.
|
|
106316
107879
|
*
|