@types/office-js 1.0.464 → 1.0.465

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/README.md CHANGED
@@ -8,7 +8,7 @@ This package contains type definitions for office-js (https://github.com/OfficeD
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Fri, 07 Feb 2025 19:32:28 GMT
11
+ * Last updated: Mon, 10 Feb 2025 20:04:01 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
office-js/index.d.ts CHANGED
@@ -87914,7 +87914,7 @@ declare namespace Word {
87914
87914
  toJSON(): Word.Interfaces.CommentReplyCollectionData;
87915
87915
  }
87916
87916
  /**
87917
- * Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, and checkbox content controls are supported.
87917
+ * Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported.
87918
87918
  *
87919
87919
  * @remarks
87920
87920
  * [Api set: WordApi 1.1]
@@ -88470,7 +88470,7 @@ declare namespace Word {
88470
88470
  toJSON(): Word.Interfaces.ContentControlData;
88471
88471
  }
88472
88472
  /**
88473
- * Contains a collection of {@link Word.ContentControl} objects. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text and plain text content controls are supported.
88473
+ * Contains a collection of {@link Word.ContentControl} objects. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported.
88474
88474
  *
88475
88475
  * @remarks
88476
88476
  * [Api set: WordApi 1.1]
@@ -88667,11 +88667,11 @@ declare namespace Word {
88667
88667
  */
88668
88668
  track(): Word.ContentControlListItem;
88669
88669
  /**
88670
- * 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.
88670
+ * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
88671
88671
  */
88672
88672
  untrack(): Word.ContentControlListItem;
88673
88673
  /**
88674
- * 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.)
88674
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
88675
88675
  * Whereas the original `Word.ContentControlListItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ContentControlListItemData`) that contains shallow copies of any loaded child properties from the original object.
88676
88676
  */
88677
88677
  toJSON(): Word.Interfaces.ContentControlListItemData;
@@ -88726,11 +88726,11 @@ declare namespace Word {
88726
88726
  */
88727
88727
  track(): Word.ContentControlListItemCollection;
88728
88728
  /**
88729
- * 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.
88729
+ * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
88730
88730
  */
88731
88731
  untrack(): Word.ContentControlListItemCollection;
88732
88732
  /**
88733
- * 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.)
88733
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
88734
88734
  * Whereas the original `Word.ContentControlListItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ContentControlListItemCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
88735
88735
  */
88736
88736
  toJSON(): Word.Interfaces.ContentControlListItemCollectionData;
@@ -90214,11 +90214,11 @@ declare namespace Word {
90214
90214
  */
90215
90215
  track(): Word.DropDownListContentControl;
90216
90216
  /**
90217
- * 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.
90217
+ * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
90218
90218
  */
90219
90219
  untrack(): Word.DropDownListContentControl;
90220
90220
  /**
90221
- * 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.)
90221
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
90222
90222
  * Whereas the original `Word.DropDownListContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DropDownListContentControlData`) that contains shallow copies of any loaded child properties from the original object.
90223
90223
  */
90224
90224
  toJSON(): Word.Interfaces.DropDownListContentControlData;
@@ -90277,11 +90277,11 @@ declare namespace Word {
90277
90277
  */
90278
90278
  track(): Word.ComboBoxContentControl;
90279
90279
  /**
90280
- * 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.
90280
+ * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
90281
90281
  */
90282
90282
  untrack(): Word.ComboBoxContentControl;
90283
90283
  /**
90284
- * 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.)
90284
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
90285
90285
  * Whereas the original `Word.ComboBoxContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ComboBoxContentControlData`) that contains shallow copies of any loaded child properties from the original object.
90286
90286
  */
90287
90287
  toJSON(): Word.Interfaces.ComboBoxContentControlData;
@@ -96760,51 +96760,62 @@ declare namespace Word {
96760
96760
  evenPages = "EvenPages",
96761
96761
  }
96762
96762
  /**
96763
+ * Represents the types of body objects.
96764
+ *
96763
96765
  * @remarks
96764
96766
  * [Api set: WordApi 1.3]
96765
96767
  */
96766
96768
  enum BodyType {
96767
96769
  /**
96770
+ * Unknown body type.
96768
96771
  * @remarks
96769
96772
  * [Api set: WordApi 1.3]
96770
96773
  */
96771
96774
  unknown = "Unknown",
96772
96775
  /**
96776
+ * Main document body.
96773
96777
  * @remarks
96774
96778
  * [Api set: WordApi 1.3]
96775
96779
  */
96776
96780
  mainDoc = "MainDoc",
96777
96781
  /**
96782
+ * Section body.
96778
96783
  * @remarks
96779
96784
  * [Api set: WordApi 1.3]
96780
96785
  */
96781
96786
  section = "Section",
96782
96787
  /**
96788
+ * Header body.
96783
96789
  * @remarks
96784
96790
  * [Api set: WordApi 1.3]
96785
96791
  */
96786
96792
  header = "Header",
96787
96793
  /**
96794
+ * Footer body.
96788
96795
  * @remarks
96789
96796
  * [Api set: WordApi 1.3]
96790
96797
  */
96791
96798
  footer = "Footer",
96792
96799
  /**
96800
+ * Table cell body.
96793
96801
  * @remarks
96794
96802
  * [Api set: WordApi 1.3]
96795
96803
  */
96796
96804
  tableCell = "TableCell",
96797
96805
  /**
96806
+ * Footnote body.
96798
96807
  * @remarks
96799
96808
  * [Api set: WordApi 1.5]
96800
96809
  */
96801
96810
  footnote = "Footnote",
96802
96811
  /**
96812
+ * Endnote body.
96803
96813
  * @remarks
96804
96814
  * [Api set: WordApi 1.5]
96805
96815
  */
96806
96816
  endnote = "Endnote",
96807
96817
  /**
96818
+ * Note body e.g., endnote, footnote.
96808
96819
  * @remarks
96809
96820
  * [Api set: WordApi 1.5]
96810
96821
  */
@@ -96913,6 +96924,8 @@ declare namespace Word {
96913
96924
  svg = "Svg",
96914
96925
  }
96915
96926
  /**
96927
+ * Represents the location of a range. You can get range by calling getRange on different objects such as {@link Word.Paragraph} and {@link Word.ContentControl}.
96928
+ *
96916
96929
  * @remarks
96917
96930
  * [Api set: WordApi 1.3]
96918
96931
  */
@@ -96924,25 +96937,25 @@ declare namespace Word {
96924
96937
  */
96925
96938
  whole = "Whole",
96926
96939
  /**
96927
- * The starting point of the object. For content control, it is the point after the opening tag.
96940
+ * The starting point of the object. For content control, it's the point after the opening tag.
96928
96941
  * @remarks
96929
96942
  * [Api set: WordApi 1.3]
96930
96943
  */
96931
96944
  start = "Start",
96932
96945
  /**
96933
- * The ending point of the object. For paragraph, it is the point before the EOP. For content control, it is the point before the closing tag.
96946
+ * The ending point of the object. For paragraph, it's the point before the EOP (end of paragraph). For content control, it's the point before the closing tag.
96934
96947
  * @remarks
96935
96948
  * [Api set: WordApi 1.3]
96936
96949
  */
96937
96950
  end = "End",
96938
96951
  /**
96939
- * For content control only. It is the point before the opening tag.
96952
+ * For content control only. It's the point before the opening tag.
96940
96953
  * @remarks
96941
96954
  * [Api set: WordApi 1.3]
96942
96955
  */
96943
96956
  before = "Before",
96944
96957
  /**
96945
- * The point after the object. If the object is a paragraph content control or table content control, it is the point after the EOP or Table characters.
96958
+ * The point after the object. If the object is a paragraph content control or table content control, it's the point after the EOP or Table characters.
96946
96959
  * @remarks
96947
96960
  * [Api set: WordApi 1.3]
96948
96961
  */
@@ -103934,7 +103947,7 @@ declare namespace Word {
103934
103947
  id?: boolean;
103935
103948
  }
103936
103949
  /**
103937
- * Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, and checkbox content controls are supported.
103950
+ * Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported.
103938
103951
  *
103939
103952
  * @remarks
103940
103953
  * [Api set: WordApi 1.1]
@@ -104107,7 +104120,7 @@ declare namespace Word {
104107
104120
  type?: boolean;
104108
104121
  }
104109
104122
  /**
104110
- * Contains a collection of {@link Word.ContentControl} objects. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text and plain text content controls are supported.
104123
+ * Contains a collection of {@link Word.ContentControl} objects. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported.
104111
104124
  *
104112
104125
  * @remarks
104113
104126
  * [Api set: WordApi 1.1]
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.464",
3
+ "version": "1.0.465",
4
4
  "description": "TypeScript definitions for office-js",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
6
6
  "license": "MIT",
@@ -46,6 +46,6 @@
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
48
  "peerDependencies": {},
49
- "typesPublisherContentHash": "d3543dcb2e7aa5f497e2bdc719c71dbccd014b5e7e45de0a0833ea4eca7efd4c",
49
+ "typesPublisherContentHash": "9c20920bcf9deb6576f1d2d7734a26cb9f784325d564d61aef4c6087466d71bb",
50
50
  "typeScriptVersion": "5.0"
51
51
  }