@types/office-js-preview 1.0.410 → 1.0.412
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 +1805 -282
- office-js-preview/package.json +2 -2
office-js-preview/index.d.ts
CHANGED
|
@@ -8984,11 +8984,12 @@ declare namespace Office {
|
|
|
8984
8984
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
8985
8985
|
*
|
|
8986
8986
|
* **Important**: This enum can only be used to assign values to the
|
|
8987
|
-
* {@link https://learn.microsoft.com/javascript/api/
|
|
8988
|
-
*
|
|
8987
|
+
* {@link https://learn.microsoft.com/javascript/api/outlook/office.spamreportingeventcompletedoptions?view=outlook-js-preview&preserve-view=true#outlook-office-spamreportingeventcompletedoptions-moveitemto-member | moveItemTo}
|
|
8988
|
+
* property of the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | event.completed}
|
|
8989
|
+
* method. If you're on an Outlook on Windows version that only supports the `postProcessingAction` property,
|
|
8989
8990
|
* you must assign it different string values. For a list of supported string values, see
|
|
8990
|
-
* {@link https://learn.microsoft.com/javascript/api/
|
|
8991
|
-
* Office.
|
|
8991
|
+
* {@link https://learn.microsoft.com/javascript/api/outlook/office.spamreportingeventcompletedoptions?view=outlook-js-preview&preserve-view=true#outlook-office-spamreportingeventcompletedoptions-postprocessingaction-member |
|
|
8992
|
+
* Office.SpamReportingEventCompletedOptions.postProcessingAction}.
|
|
8992
8993
|
*
|
|
8993
8994
|
* @beta
|
|
8994
8995
|
*/
|
|
@@ -9710,6 +9711,29 @@ declare namespace Office {
|
|
|
9710
9711
|
*/
|
|
9711
9712
|
Beta = "beta"
|
|
9712
9713
|
}
|
|
9714
|
+
/**
|
|
9715
|
+
* Specifies the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough#available-send-mode-options | send mode option}
|
|
9716
|
+
* that overrides the option set in the manifest at runtime.
|
|
9717
|
+
*
|
|
9718
|
+
* For information on how to implement a Smart Alerts add-in, see
|
|
9719
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Use Smart Alerts and the OnMessageSend and OnAppointmentSend events in your Outlook add-in}.
|
|
9720
|
+
*
|
|
9721
|
+
* @remarks
|
|
9722
|
+
* [Api set: Mailbox preview]
|
|
9723
|
+
*
|
|
9724
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
9725
|
+
*
|
|
9726
|
+
* @beta
|
|
9727
|
+
*/
|
|
9728
|
+
enum SendModeOverride {
|
|
9729
|
+
/**
|
|
9730
|
+
* Provides the **Send Anyway** option in a Smart Alerts dialog when the mail item doesn't meet the conditions of the event-based add-in.
|
|
9731
|
+
* To learn more, see the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough#prompt-user | **prompt user** send mode option}.
|
|
9732
|
+
*
|
|
9733
|
+
* @beta
|
|
9734
|
+
*/
|
|
9735
|
+
PromptUser = "promptUser"
|
|
9736
|
+
}
|
|
9713
9737
|
/**
|
|
9714
9738
|
* Specifies the source of the selected data in an item (see `Office.mailbox.item.getSelectedDataAsync` for details).
|
|
9715
9739
|
*
|
|
@@ -19766,9 +19790,75 @@ declare namespace Office {
|
|
|
19766
19790
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19767
19791
|
*/
|
|
19768
19792
|
allowEvent?: boolean;
|
|
19793
|
+
/**
|
|
19794
|
+
* When you use the {@link Office.MailboxEvent.completed | completed method} to signal completion of an event handler and set its `allowEvent` property to `false`,
|
|
19795
|
+
* this property customizes the text of the **Don't Send** button in the Smart Alerts dialog. Custom text must be 20 characters or less.
|
|
19796
|
+
*
|
|
19797
|
+
* For an example, see the
|
|
19798
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough#customize-the-dont-send-button-optional-preview | Smart Alerts walkthrough}.
|
|
19799
|
+
*
|
|
19800
|
+
* @remarks
|
|
19801
|
+
*
|
|
19802
|
+
* [Api set: Mailbox preview]
|
|
19803
|
+
*
|
|
19804
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
|
|
19805
|
+
*
|
|
19806
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19807
|
+
*
|
|
19808
|
+
* @beta
|
|
19809
|
+
*/
|
|
19810
|
+
cancelLabel?: string;
|
|
19811
|
+
/**
|
|
19812
|
+
* When you use the {@link Office.MailboxEvent.completed | completed method} to signal completion of an event handler and set its `allowEvent` property to `false`,
|
|
19813
|
+
* this property specifies the ID of the task pane that opens when the **Don't Send** button is selected from the Smart Alerts dialog.
|
|
19814
|
+
*
|
|
19815
|
+
* For an example, see the
|
|
19816
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough#customize-the-dont-send-button-optional-preview | Smart Alerts walkthrough}.
|
|
19817
|
+
*
|
|
19818
|
+
* @remarks
|
|
19819
|
+
*
|
|
19820
|
+
* [Api set: Mailbox preview]
|
|
19821
|
+
*
|
|
19822
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
|
|
19823
|
+
*
|
|
19824
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19825
|
+
*
|
|
19826
|
+
* **Important**:
|
|
19827
|
+
*
|
|
19828
|
+
* The `commandId` value must match the task pane ID specified in the manifest of your add-in. The markup depends on the type of manifest your
|
|
19829
|
+
* add-in uses.
|
|
19830
|
+
*
|
|
19831
|
+
* - **XML manifest**: The `id` attribute of the {@link https://learn.microsoft.com/javascript/api/manifest/control | Control} element representing the task pane.
|
|
19832
|
+
*
|
|
19833
|
+
* - **Unified manifest for Microsoft 365 (preview)**: The "id" property of the task pane command in the "controls" array.
|
|
19834
|
+
*
|
|
19835
|
+
* If you specify the `contextData` option in your `event.completed` call, you must also assign a task pane ID to the `commandId` option.
|
|
19836
|
+
* Otherwise, the JSON data assigned to `contextData` is ignored.
|
|
19837
|
+
*
|
|
19838
|
+
* @beta
|
|
19839
|
+
*/
|
|
19840
|
+
commandId?: string;
|
|
19841
|
+
/**
|
|
19842
|
+
* When you use the {@link Office.MailboxEvent.completed | completed method} to signal completion of an event handler and set its `allowEvent` property to `false`,
|
|
19843
|
+
* this property specifies any JSON data passed to the add-in for processing when the **Don't Send** button is selected from the Smart Alerts dialog.
|
|
19844
|
+
*
|
|
19845
|
+
* @remarks
|
|
19846
|
+
*
|
|
19847
|
+
* [Api set: Mailbox preview]
|
|
19848
|
+
*
|
|
19849
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
|
|
19850
|
+
*
|
|
19851
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19852
|
+
*
|
|
19853
|
+
* **Important**: If you specify the `contextData` option in your `event.completed` call, you must also assign a task pane ID to the `commandId` option.
|
|
19854
|
+
* Otherwise, the JSON data assigned to `contextData` is ignored.
|
|
19855
|
+
*
|
|
19856
|
+
* @beta
|
|
19857
|
+
*/
|
|
19858
|
+
contextData?: object;
|
|
19769
19859
|
/**
|
|
19770
19860
|
* When you use the {@link Office.MailboxEvent.completed | completed method} to signal completion of an event handler and set its `allowEvent` property
|
|
19771
|
-
* to `false`, this property sets the error message
|
|
19861
|
+
* to `false`, this property sets the error message displayed to the user. For an example, see the
|
|
19772
19862
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts walkthrough}.
|
|
19773
19863
|
*
|
|
19774
19864
|
* @remarks
|
|
@@ -19780,6 +19870,29 @@ declare namespace Office {
|
|
|
19780
19870
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19781
19871
|
*/
|
|
19782
19872
|
errorMessage?: string;
|
|
19873
|
+
/**
|
|
19874
|
+
* When you use the {@link Office.MailboxEvent.completed | completed method} to signal completion of an event handler
|
|
19875
|
+
* and set its `allowEvent` property to `false`, this property overrides the
|
|
19876
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough#available-send-mode-options | send mode option}
|
|
19877
|
+
* specified in the manifest at runtime.
|
|
19878
|
+
*
|
|
19879
|
+
* For an example, see the
|
|
19880
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough#override-the-send-mode-option-at-runtime-optional-preview | Smart Alerts walkthrough}.
|
|
19881
|
+
*
|
|
19882
|
+
* @remarks
|
|
19883
|
+
*
|
|
19884
|
+
* [Api set: Mailbox preview]
|
|
19885
|
+
*
|
|
19886
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
|
|
19887
|
+
*
|
|
19888
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19889
|
+
*
|
|
19890
|
+
* **Important**: Currently, `sendModeOverride` can only be set to the
|
|
19891
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough#prompt-user | prompt user} option.
|
|
19892
|
+
*
|
|
19893
|
+
* @beta
|
|
19894
|
+
*/
|
|
19895
|
+
sendModeOverride?: Office.MailboxEnums.SendModeOverride | string;
|
|
19783
19896
|
}
|
|
19784
19897
|
/**
|
|
19785
19898
|
* Provides information about the `Office.EventType.SpamReporting` event that occurs when an unsolicited message is reported.
|
|
@@ -88501,6 +88614,414 @@ declare namespace Excel {
|
|
|
88501
88614
|
////////////////////////////////////////////////////////////////
|
|
88502
88615
|
|
|
88503
88616
|
declare namespace Word {
|
|
88617
|
+
/**
|
|
88618
|
+
* Represents the color scheme of a critique in the document, affecting underline and highlight.
|
|
88619
|
+
*
|
|
88620
|
+
* @remarks
|
|
88621
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88622
|
+
* @beta
|
|
88623
|
+
*/
|
|
88624
|
+
enum CritiqueColorScheme {
|
|
88625
|
+
/**
|
|
88626
|
+
* Red color.
|
|
88627
|
+
* @remarks
|
|
88628
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88629
|
+
* @beta
|
|
88630
|
+
*/
|
|
88631
|
+
red = "Red",
|
|
88632
|
+
/**
|
|
88633
|
+
* Green color.
|
|
88634
|
+
* @remarks
|
|
88635
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88636
|
+
* @beta
|
|
88637
|
+
*/
|
|
88638
|
+
green = "Green",
|
|
88639
|
+
/**
|
|
88640
|
+
* Blue color.
|
|
88641
|
+
* @remarks
|
|
88642
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88643
|
+
* @beta
|
|
88644
|
+
*/
|
|
88645
|
+
blue = "Blue",
|
|
88646
|
+
/**
|
|
88647
|
+
* Lavender color.
|
|
88648
|
+
* @remarks
|
|
88649
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88650
|
+
* @beta
|
|
88651
|
+
*/
|
|
88652
|
+
lavender = "Lavender",
|
|
88653
|
+
/**
|
|
88654
|
+
* Berry color.
|
|
88655
|
+
* @remarks
|
|
88656
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88657
|
+
* @beta
|
|
88658
|
+
*/
|
|
88659
|
+
berry = "Berry",
|
|
88660
|
+
}
|
|
88661
|
+
/**
|
|
88662
|
+
* Critique that will be rendered as underline for the specified part of paragraph in the document.
|
|
88663
|
+
*
|
|
88664
|
+
* @remarks
|
|
88665
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88666
|
+
* @beta
|
|
88667
|
+
*/
|
|
88668
|
+
interface Critique {
|
|
88669
|
+
/**
|
|
88670
|
+
* Gets the color scheme of the critique.
|
|
88671
|
+
*
|
|
88672
|
+
* @remarks
|
|
88673
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88674
|
+
* @beta
|
|
88675
|
+
*/
|
|
88676
|
+
colorScheme: Word.CritiqueColorScheme | "Red" | "Green" | "Blue" | "Lavender" | "Berry";
|
|
88677
|
+
/**
|
|
88678
|
+
* Gets the length of the critique inside paragraph.
|
|
88679
|
+
*
|
|
88680
|
+
* @remarks
|
|
88681
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88682
|
+
* @beta
|
|
88683
|
+
*/
|
|
88684
|
+
length: number;
|
|
88685
|
+
/**
|
|
88686
|
+
* Gets the start index of the critique inside paragraph.
|
|
88687
|
+
*
|
|
88688
|
+
* @remarks
|
|
88689
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88690
|
+
* @beta
|
|
88691
|
+
*/
|
|
88692
|
+
start: number;
|
|
88693
|
+
}
|
|
88694
|
+
/**
|
|
88695
|
+
* Represents an annotation wrapper around critique displayed in the document.
|
|
88696
|
+
*
|
|
88697
|
+
* @remarks
|
|
88698
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88699
|
+
* @beta
|
|
88700
|
+
*/
|
|
88701
|
+
class CritiqueAnnotation extends OfficeExtension.ClientObject {
|
|
88702
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
88703
|
+
context: RequestContext;
|
|
88704
|
+
/**
|
|
88705
|
+
* Gets the range of text that is annotated.
|
|
88706
|
+
*
|
|
88707
|
+
* @remarks
|
|
88708
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88709
|
+
* @beta
|
|
88710
|
+
*/
|
|
88711
|
+
readonly range: Word.Range;
|
|
88712
|
+
/**
|
|
88713
|
+
* Gets the critique that was passed when the annotation was inserted.
|
|
88714
|
+
*
|
|
88715
|
+
* @remarks
|
|
88716
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88717
|
+
* @beta
|
|
88718
|
+
*/
|
|
88719
|
+
readonly critique: Word.Critique;
|
|
88720
|
+
/**
|
|
88721
|
+
* Accepts the critique. This will change the annotation state to `accepted`.
|
|
88722
|
+
*
|
|
88723
|
+
* @remarks
|
|
88724
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88725
|
+
* @beta
|
|
88726
|
+
*/
|
|
88727
|
+
accept(): void;
|
|
88728
|
+
/**
|
|
88729
|
+
* Rejects the critique. This will change the annotation state to `rejected`.
|
|
88730
|
+
*
|
|
88731
|
+
* @remarks
|
|
88732
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88733
|
+
* @beta
|
|
88734
|
+
*/
|
|
88735
|
+
reject(): void;
|
|
88736
|
+
/**
|
|
88737
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
88738
|
+
*
|
|
88739
|
+
* @param options Provides options for which properties of the object to load.
|
|
88740
|
+
*/
|
|
88741
|
+
load(options?: Word.Interfaces.CritiqueAnnotationLoadOptions): Word.CritiqueAnnotation;
|
|
88742
|
+
/**
|
|
88743
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
88744
|
+
*
|
|
88745
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
88746
|
+
*/
|
|
88747
|
+
load(propertyNames?: string | string[]): Word.CritiqueAnnotation;
|
|
88748
|
+
/**
|
|
88749
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
88750
|
+
*
|
|
88751
|
+
* @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.
|
|
88752
|
+
*/
|
|
88753
|
+
load(propertyNamesAndPaths?: {
|
|
88754
|
+
select?: string;
|
|
88755
|
+
expand?: string;
|
|
88756
|
+
}): Word.CritiqueAnnotation;
|
|
88757
|
+
/**
|
|
88758
|
+
* 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.
|
|
88759
|
+
*/
|
|
88760
|
+
track(): Word.CritiqueAnnotation;
|
|
88761
|
+
/**
|
|
88762
|
+
* 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.
|
|
88763
|
+
*/
|
|
88764
|
+
untrack(): Word.CritiqueAnnotation;
|
|
88765
|
+
/**
|
|
88766
|
+
* 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.)
|
|
88767
|
+
* Whereas the original Word.CritiqueAnnotation object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CritiqueAnnotationData`) that contains shallow copies of any loaded child properties from the original object.
|
|
88768
|
+
*/
|
|
88769
|
+
toJSON(): Word.Interfaces.CritiqueAnnotationData;
|
|
88770
|
+
}
|
|
88771
|
+
/**
|
|
88772
|
+
* Represents the state of the annotation.
|
|
88773
|
+
*
|
|
88774
|
+
* @remarks
|
|
88775
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88776
|
+
* @beta
|
|
88777
|
+
*/
|
|
88778
|
+
enum AnnotationState {
|
|
88779
|
+
/**
|
|
88780
|
+
* Created.
|
|
88781
|
+
* @remarks
|
|
88782
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88783
|
+
* @beta
|
|
88784
|
+
*/
|
|
88785
|
+
created = "Created",
|
|
88786
|
+
/**
|
|
88787
|
+
* Accepted.
|
|
88788
|
+
* @remarks
|
|
88789
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88790
|
+
* @beta
|
|
88791
|
+
*/
|
|
88792
|
+
accepted = "Accepted",
|
|
88793
|
+
/**
|
|
88794
|
+
* Rejected.
|
|
88795
|
+
* @remarks
|
|
88796
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88797
|
+
* @beta
|
|
88798
|
+
*/
|
|
88799
|
+
rejected = "Rejected",
|
|
88800
|
+
}
|
|
88801
|
+
/**
|
|
88802
|
+
* Annotations set produced by the add-in. Currently supporting only critiques.
|
|
88803
|
+
*
|
|
88804
|
+
* @remarks
|
|
88805
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88806
|
+
* @beta
|
|
88807
|
+
*/
|
|
88808
|
+
interface AnnotationSet {
|
|
88809
|
+
/**
|
|
88810
|
+
* Critiques.
|
|
88811
|
+
*
|
|
88812
|
+
* @remarks
|
|
88813
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88814
|
+
* @beta
|
|
88815
|
+
*/
|
|
88816
|
+
critiques: Word.Critique[];
|
|
88817
|
+
}
|
|
88818
|
+
/**
|
|
88819
|
+
* Represents an annotation attached to a paragraph.
|
|
88820
|
+
*
|
|
88821
|
+
* @remarks
|
|
88822
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88823
|
+
* @beta
|
|
88824
|
+
*/
|
|
88825
|
+
class Annotation extends OfficeExtension.ClientObject {
|
|
88826
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
88827
|
+
context: RequestContext;
|
|
88828
|
+
/**
|
|
88829
|
+
* Gets the critique annotation object.
|
|
88830
|
+
*
|
|
88831
|
+
* @remarks
|
|
88832
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88833
|
+
* @beta
|
|
88834
|
+
*/
|
|
88835
|
+
readonly critiqueAnnotation: Word.CritiqueAnnotation;
|
|
88836
|
+
/**
|
|
88837
|
+
* Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects.
|
|
88838
|
+
*
|
|
88839
|
+
* @remarks
|
|
88840
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88841
|
+
* @beta
|
|
88842
|
+
*/
|
|
88843
|
+
readonly id: string;
|
|
88844
|
+
/**
|
|
88845
|
+
* Gets the state of the annotation.
|
|
88846
|
+
*
|
|
88847
|
+
* @remarks
|
|
88848
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88849
|
+
* @beta
|
|
88850
|
+
*/
|
|
88851
|
+
readonly state: Word.AnnotationState | "Created" | "Accepted" | "Rejected";
|
|
88852
|
+
/**
|
|
88853
|
+
* Deletes the annotation.
|
|
88854
|
+
*
|
|
88855
|
+
* @remarks
|
|
88856
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88857
|
+
* @beta
|
|
88858
|
+
*/
|
|
88859
|
+
delete(): void;
|
|
88860
|
+
/**
|
|
88861
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
88862
|
+
*
|
|
88863
|
+
* @param options Provides options for which properties of the object to load.
|
|
88864
|
+
*/
|
|
88865
|
+
load(options?: Word.Interfaces.AnnotationLoadOptions): Word.Annotation;
|
|
88866
|
+
/**
|
|
88867
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
88868
|
+
*
|
|
88869
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
88870
|
+
*/
|
|
88871
|
+
load(propertyNames?: string | string[]): Word.Annotation;
|
|
88872
|
+
/**
|
|
88873
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
88874
|
+
*
|
|
88875
|
+
* @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.
|
|
88876
|
+
*/
|
|
88877
|
+
load(propertyNamesAndPaths?: {
|
|
88878
|
+
select?: string;
|
|
88879
|
+
expand?: string;
|
|
88880
|
+
}): Word.Annotation;
|
|
88881
|
+
/**
|
|
88882
|
+
* 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.
|
|
88883
|
+
*/
|
|
88884
|
+
track(): Word.Annotation;
|
|
88885
|
+
/**
|
|
88886
|
+
* 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.
|
|
88887
|
+
*/
|
|
88888
|
+
untrack(): Word.Annotation;
|
|
88889
|
+
/**
|
|
88890
|
+
* 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.)
|
|
88891
|
+
* Whereas the original Word.Annotation object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.AnnotationData`) that contains shallow copies of any loaded child properties from the original object.
|
|
88892
|
+
*/
|
|
88893
|
+
toJSON(): Word.Interfaces.AnnotationData;
|
|
88894
|
+
}
|
|
88895
|
+
/**
|
|
88896
|
+
* Holds annotation information that is passed back on annotation added event.
|
|
88897
|
+
*
|
|
88898
|
+
* @remarks
|
|
88899
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88900
|
+
* @beta
|
|
88901
|
+
*/
|
|
88902
|
+
interface AnnotationInsertedEventArgs {
|
|
88903
|
+
/**
|
|
88904
|
+
* Specifies the annotation IDs for which the event was fired.
|
|
88905
|
+
*
|
|
88906
|
+
* @remarks
|
|
88907
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88908
|
+
* @beta
|
|
88909
|
+
*/
|
|
88910
|
+
ids: string[];
|
|
88911
|
+
}
|
|
88912
|
+
/**
|
|
88913
|
+
* Holds annotation information that is passed back on annotation inserted event.
|
|
88914
|
+
*
|
|
88915
|
+
* @remarks
|
|
88916
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88917
|
+
* @beta
|
|
88918
|
+
*/
|
|
88919
|
+
interface AnnotationClickedEventArgs {
|
|
88920
|
+
/**
|
|
88921
|
+
* Specifies the annotation ID for which the event was fired.
|
|
88922
|
+
*
|
|
88923
|
+
* @remarks
|
|
88924
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88925
|
+
* @beta
|
|
88926
|
+
*/
|
|
88927
|
+
id: string;
|
|
88928
|
+
}
|
|
88929
|
+
/**
|
|
88930
|
+
* Holds annotation information that is passed back on annotation removed event.
|
|
88931
|
+
*
|
|
88932
|
+
* @remarks
|
|
88933
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88934
|
+
* @beta
|
|
88935
|
+
*/
|
|
88936
|
+
interface AnnotationRemovedEventArgs {
|
|
88937
|
+
/**
|
|
88938
|
+
* Specifies the annotation IDs for which the event was fired.
|
|
88939
|
+
*
|
|
88940
|
+
* @remarks
|
|
88941
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88942
|
+
* @beta
|
|
88943
|
+
*/
|
|
88944
|
+
ids: string[];
|
|
88945
|
+
}
|
|
88946
|
+
/**
|
|
88947
|
+
* Holds annotation information that is passed back on annotation hovered event.
|
|
88948
|
+
*
|
|
88949
|
+
* @remarks
|
|
88950
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88951
|
+
* @beta
|
|
88952
|
+
*/
|
|
88953
|
+
interface AnnotationHoveredEventArgs {
|
|
88954
|
+
/**
|
|
88955
|
+
* Specifies the annotation ID for which the event was fired.
|
|
88956
|
+
*
|
|
88957
|
+
* @remarks
|
|
88958
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88959
|
+
* @beta
|
|
88960
|
+
*/
|
|
88961
|
+
id: string;
|
|
88962
|
+
}
|
|
88963
|
+
/**
|
|
88964
|
+
* Contains a collection of {@link Word.Annotation} objects.
|
|
88965
|
+
*
|
|
88966
|
+
* @remarks
|
|
88967
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88968
|
+
* @beta
|
|
88969
|
+
*/
|
|
88970
|
+
class AnnotationCollection extends OfficeExtension.ClientObject {
|
|
88971
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
88972
|
+
context: RequestContext;
|
|
88973
|
+
/** Gets the loaded child items in this collection. */
|
|
88974
|
+
readonly items: Word.Annotation[];
|
|
88975
|
+
/**
|
|
88976
|
+
* Gets the first annotation in this collection. Throws an `ItemNotFound` error if this collection is empty.
|
|
88977
|
+
*
|
|
88978
|
+
* @remarks
|
|
88979
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88980
|
+
* @beta
|
|
88981
|
+
*/
|
|
88982
|
+
getFirst(): Word.Annotation;
|
|
88983
|
+
/**
|
|
88984
|
+
* Gets the first annotation in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`.
|
|
88985
|
+
For further information,
|
|
88986
|
+
see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
88987
|
+
*
|
|
88988
|
+
* @remarks
|
|
88989
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88990
|
+
* @beta
|
|
88991
|
+
*/
|
|
88992
|
+
getFirstOrNullObject(): Word.Annotation;
|
|
88993
|
+
/**
|
|
88994
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
88995
|
+
*
|
|
88996
|
+
* @param options Provides options for which properties of the object to load.
|
|
88997
|
+
*/
|
|
88998
|
+
load(options?: Word.Interfaces.AnnotationCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.AnnotationCollection;
|
|
88999
|
+
/**
|
|
89000
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
89001
|
+
*
|
|
89002
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
89003
|
+
*/
|
|
89004
|
+
load(propertyNames?: string | string[]): Word.AnnotationCollection;
|
|
89005
|
+
/**
|
|
89006
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
89007
|
+
*
|
|
89008
|
+
* @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.
|
|
89009
|
+
*/
|
|
89010
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.AnnotationCollection;
|
|
89011
|
+
/**
|
|
89012
|
+
* 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.
|
|
89013
|
+
*/
|
|
89014
|
+
track(): Word.AnnotationCollection;
|
|
89015
|
+
/**
|
|
89016
|
+
* 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.
|
|
89017
|
+
*/
|
|
89018
|
+
untrack(): Word.AnnotationCollection;
|
|
89019
|
+
/**
|
|
89020
|
+
* 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.)
|
|
89021
|
+
* Whereas the original `Word.AnnotationCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.AnnotationCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
89022
|
+
*/
|
|
89023
|
+
toJSON(): Word.Interfaces.AnnotationCollectionData;
|
|
89024
|
+
}
|
|
88504
89025
|
/**
|
|
88505
89026
|
* Represents the application object.
|
|
88506
89027
|
*
|
|
@@ -88519,6 +89040,25 @@ declare namespace Word {
|
|
|
88519
89040
|
* @param base64File Optional. The Base64-encoded .docx file. The default value is null.
|
|
88520
89041
|
*/
|
|
88521
89042
|
createDocument(base64File?: string): Word.DocumentCreated;
|
|
89043
|
+
/**
|
|
89044
|
+
* Opens a document and displays it in a new tab or window.
|
|
89045
|
+
*
|
|
89046
|
+
* @remarks
|
|
89047
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
89048
|
+
*
|
|
89049
|
+
* The following are examples for the various supported clients and platforms.
|
|
89050
|
+
*
|
|
89051
|
+
* - Remote or cloud location example: `https://microsoft.sharepoint.com/some/path/Document.docx`
|
|
89052
|
+
*
|
|
89053
|
+
* - Local location examples for Windows: `C:\\Users\\Someone\\Documents\\Document.docx` (includes required escaped backslashes), `file://mycomputer/myfolder/Document.docx`
|
|
89054
|
+
*
|
|
89055
|
+
* - Local location example for Mac and iOS: `/User/someone/document.docx`
|
|
89056
|
+
*
|
|
89057
|
+
* @beta
|
|
89058
|
+
*
|
|
89059
|
+
* @param fileLocation Required. The absolute location of the .docx file. Word on the web only supports remote (cloud) locations, while Word on Windows, Mac, and iOS support local and remote locations.
|
|
89060
|
+
*/
|
|
89061
|
+
openDocument(fileLocation: string): void;
|
|
88522
89062
|
/**
|
|
88523
89063
|
* Parse styles from template Base64 file and return JSON format of retrieved styles as a string.
|
|
88524
89064
|
*
|
|
@@ -88613,7 +89153,7 @@ declare namespace Word {
|
|
|
88613
89153
|
*/
|
|
88614
89154
|
readonly parentBody: Word.Body;
|
|
88615
89155
|
/**
|
|
88616
|
-
* Gets the parent body of the body. For example, a table cell body's parent body could be a header. If there isn't a parent body, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
89156
|
+
* Gets the parent body of the body. For example, a table cell body's parent body could be a header. If there isn't a parent body, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
88617
89157
|
*
|
|
88618
89158
|
* @remarks
|
|
88619
89159
|
* [Api set: WordApi 1.3]
|
|
@@ -88627,7 +89167,7 @@ declare namespace Word {
|
|
|
88627
89167
|
*/
|
|
88628
89168
|
readonly parentContentControl: Word.ContentControl;
|
|
88629
89169
|
/**
|
|
88630
|
-
* Gets the content control that contains the body. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
89170
|
+
* Gets the content control that contains the body. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
88631
89171
|
*
|
|
88632
89172
|
* @remarks
|
|
88633
89173
|
* [Api set: WordApi 1.3]
|
|
@@ -88641,7 +89181,7 @@ declare namespace Word {
|
|
|
88641
89181
|
*/
|
|
88642
89182
|
readonly parentSection: Word.Section;
|
|
88643
89183
|
/**
|
|
88644
|
-
* Gets the parent section of the body. If there isn't a parent section, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
89184
|
+
* Gets the parent section of the body. If there isn't a parent section, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
88645
89185
|
*
|
|
88646
89186
|
* @remarks
|
|
88647
89187
|
* [Api set: WordApi 1.3]
|
|
@@ -88729,16 +89269,6 @@ declare namespace Word {
|
|
|
88729
89269
|
* [Api set: WordApi 1.1]
|
|
88730
89270
|
*/
|
|
88731
89271
|
getOoxml(): OfficeExtension.ClientResult<string>;
|
|
88732
|
-
/**
|
|
88733
|
-
* Gets the paragraph by its unique ID in GUID format. Throws an `ItemNotFound` error if the collection is empty.
|
|
88734
|
-
*
|
|
88735
|
-
* @remarks
|
|
88736
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88737
|
-
* @beta
|
|
88738
|
-
*
|
|
88739
|
-
* @param id Required. Unique paragraph ID in GUID format.
|
|
88740
|
-
*/
|
|
88741
|
-
getParagraphById(id: string): Word.Paragraph;
|
|
88742
89272
|
/**
|
|
88743
89273
|
* Gets the whole body, or the starting or ending point of the body, as a range.
|
|
88744
89274
|
*
|
|
@@ -88766,6 +89296,14 @@ declare namespace Word {
|
|
|
88766
89296
|
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
88767
89297
|
*/
|
|
88768
89298
|
getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
|
|
89299
|
+
/**
|
|
89300
|
+
* Gets the collection of the TrackedChange objects in the body.
|
|
89301
|
+
*
|
|
89302
|
+
* @remarks
|
|
89303
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
89304
|
+
* @beta
|
|
89305
|
+
*/
|
|
89306
|
+
getTrackedChanges(): Word.TrackedChangeCollection;
|
|
88769
89307
|
/**
|
|
88770
89308
|
* Inserts a break at the specified location in the main document.
|
|
88771
89309
|
*
|
|
@@ -88967,41 +89505,11 @@ declare namespace Word {
|
|
|
88967
89505
|
*/
|
|
88968
89506
|
readonly onCommentSelected: OfficeExtension.EventHandlers<Word.CommentEventArgs>;
|
|
88969
89507
|
/**
|
|
88970
|
-
*
|
|
88971
|
-
*
|
|
88972
|
-
* @remarks
|
|
88973
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88974
|
-
*
|
|
88975
|
-
* @eventproperty
|
|
88976
|
-
* @beta
|
|
88977
|
-
*/
|
|
88978
|
-
readonly onParagraphAdded: OfficeExtension.EventHandlers<Word.ParagraphAddedEventArgs>;
|
|
88979
|
-
/**
|
|
88980
|
-
* Occurs when paragraphs are changed.
|
|
88981
|
-
*
|
|
88982
|
-
* @remarks
|
|
88983
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88984
|
-
*
|
|
88985
|
-
* @eventproperty
|
|
88986
|
-
* @beta
|
|
88987
|
-
*/
|
|
88988
|
-
readonly onParagraphChanged: OfficeExtension.EventHandlers<Word.ParagraphChangedEventArgs>;
|
|
88989
|
-
/**
|
|
88990
|
-
* Occurs when paragraphs are deleted.
|
|
88991
|
-
*
|
|
88992
|
-
* @remarks
|
|
88993
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
88994
|
-
*
|
|
88995
|
-
* @eventproperty
|
|
88996
|
-
* @beta
|
|
88997
|
-
*/
|
|
88998
|
-
readonly onParagraphDeleted: OfficeExtension.EventHandlers<Word.ParagraphDeletedEventArgs>;
|
|
88999
|
-
/**
|
|
89000
|
-
* 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.
|
|
89508
|
+
* 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.
|
|
89001
89509
|
*/
|
|
89002
89510
|
track(): Word.Body;
|
|
89003
89511
|
/**
|
|
89004
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
89512
|
+
* 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.
|
|
89005
89513
|
*/
|
|
89006
89514
|
untrack(): Word.Body;
|
|
89007
89515
|
/**
|
|
@@ -89035,7 +89543,7 @@ declare namespace Word {
|
|
|
89035
89543
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
89036
89544
|
* @beta
|
|
89037
89545
|
*/
|
|
89038
|
-
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";
|
|
89546
|
+
lineStyle: Word.LineStyle | "DashDot" | "DashDotDot" | "DashDotStroked" | "DashLargeGap" | "DashSmallGap" | "Dot" | "Double" | "DoubleWavy" | "Emboss3D" | "Engrave3D" | "Inset" | "Mixed" | "None" | "Outset" | "Single" | "SingleWavy" | "ThickThinLargeGap" | "ThickThinMedGap" | "ThickThinSmallGap" | "ThinThickLargeGap" | "ThinThickMedGap" | "ThinThickSmallGap" | "ThinThickThinLargeGap" | "ThinThickThinMedGap" | "ThinThickThinSmallGap" | "Triple";
|
|
89039
89547
|
/**
|
|
89040
89548
|
* Specifies the line width for the border.
|
|
89041
89549
|
*
|
|
@@ -89103,6 +89611,140 @@ declare namespace Word {
|
|
|
89103
89611
|
*/
|
|
89104
89612
|
toJSON(): Word.Interfaces.BorderData;
|
|
89105
89613
|
}
|
|
89614
|
+
/**
|
|
89615
|
+
* Represents the collection of border styles.
|
|
89616
|
+
*
|
|
89617
|
+
* @remarks
|
|
89618
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
89619
|
+
* @beta
|
|
89620
|
+
*/
|
|
89621
|
+
class BorderCollection extends OfficeExtension.ClientObject {
|
|
89622
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
89623
|
+
context: RequestContext;
|
|
89624
|
+
/** Gets the loaded child items in this collection. */
|
|
89625
|
+
readonly items: Word.Border[];
|
|
89626
|
+
/**
|
|
89627
|
+
* Specifies the 24-bit color of the inside borders.
|
|
89628
|
+
*
|
|
89629
|
+
* @remarks
|
|
89630
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
89631
|
+
* @beta
|
|
89632
|
+
*/
|
|
89633
|
+
insideLineColor: string;
|
|
89634
|
+
/**
|
|
89635
|
+
* Specifies the line style of the inside borders.
|
|
89636
|
+
*
|
|
89637
|
+
* @remarks
|
|
89638
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
89639
|
+
* @beta
|
|
89640
|
+
*/
|
|
89641
|
+
insideLineStyle: Word.LineStyle | "DashDot" | "DashDotDot" | "DashDotStroked" | "DashLargeGap" | "DashSmallGap" | "Dot" | "Double" | "DoubleWavy" | "Emboss3D" | "Engrave3D" | "Inset" | "Mixed" | "None" | "Outset" | "Single" | "SingleWavy" | "ThickThinLargeGap" | "ThickThinMedGap" | "ThickThinSmallGap" | "ThinThickLargeGap" | "ThinThickMedGap" | "ThinThickSmallGap" | "ThinThickThinLargeGap" | "ThinThickThinMedGap" | "ThinThickThinSmallGap" | "Triple";
|
|
89642
|
+
/**
|
|
89643
|
+
* Specifies the line width of the inside borders.
|
|
89644
|
+
*
|
|
89645
|
+
* @remarks
|
|
89646
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
89647
|
+
* @beta
|
|
89648
|
+
*/
|
|
89649
|
+
insideLineWidth: Word.LineWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
|
|
89650
|
+
/**
|
|
89651
|
+
* Specifies the 24-bit color of the outside borders.
|
|
89652
|
+
*
|
|
89653
|
+
* @remarks
|
|
89654
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
89655
|
+
* @beta
|
|
89656
|
+
*/
|
|
89657
|
+
outsideLineColor: string;
|
|
89658
|
+
/**
|
|
89659
|
+
* Specifies the line style of the outside borders.
|
|
89660
|
+
*
|
|
89661
|
+
* @remarks
|
|
89662
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
89663
|
+
* @beta
|
|
89664
|
+
*/
|
|
89665
|
+
outsideLineStyle: Word.LineStyle | "DashDot" | "DashDotDot" | "DashDotStroked" | "DashLargeGap" | "DashSmallGap" | "Dot" | "Double" | "DoubleWavy" | "Emboss3D" | "Engrave3D" | "Inset" | "Mixed" | "None" | "Outset" | "Single" | "SingleWavy" | "ThickThinLargeGap" | "ThickThinMedGap" | "ThickThinSmallGap" | "ThinThickLargeGap" | "ThinThickMedGap" | "ThinThickSmallGap" | "ThinThickThinLargeGap" | "ThinThickThinMedGap" | "ThinThickThinSmallGap" | "Triple";
|
|
89666
|
+
/**
|
|
89667
|
+
* Specifies the line width of the outside borders.
|
|
89668
|
+
*
|
|
89669
|
+
* @remarks
|
|
89670
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
89671
|
+
* @beta
|
|
89672
|
+
*/
|
|
89673
|
+
outsideLineWidth: Word.LineWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
|
|
89674
|
+
/**
|
|
89675
|
+
* Gets the border that has the specified position type.
|
|
89676
|
+
*
|
|
89677
|
+
* @remarks
|
|
89678
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
89679
|
+
* @beta
|
|
89680
|
+
*/
|
|
89681
|
+
getByPositionType(positionType: Word.BorderPositionType): Word.Border;
|
|
89682
|
+
/**
|
|
89683
|
+
* Gets the border that has the specified position type.
|
|
89684
|
+
*
|
|
89685
|
+
* @remarks
|
|
89686
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
89687
|
+
* @beta
|
|
89688
|
+
*/
|
|
89689
|
+
getByPositionType(positionType: "Top" | "Left" | "Bottom" | "Right" | "Horizontal" | "Vertical" | "DiagonalDown" | "DiagonalUp"): Word.Border;
|
|
89690
|
+
/**
|
|
89691
|
+
* Gets the first border in this collection. Throws an `ItemNotFound` error if this collection is empty.
|
|
89692
|
+
*
|
|
89693
|
+
* @remarks
|
|
89694
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
89695
|
+
* @beta
|
|
89696
|
+
*/
|
|
89697
|
+
getFirst(): Word.Border;
|
|
89698
|
+
/**
|
|
89699
|
+
* Gets the first border in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
89700
|
+
*
|
|
89701
|
+
* @remarks
|
|
89702
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
89703
|
+
* @beta
|
|
89704
|
+
*/
|
|
89705
|
+
getFirstOrNullObject(): Word.Border;
|
|
89706
|
+
/**
|
|
89707
|
+
* Gets a Border object by its index in the collection.
|
|
89708
|
+
*
|
|
89709
|
+
* @remarks
|
|
89710
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
89711
|
+
* @beta
|
|
89712
|
+
*
|
|
89713
|
+
* @param index A number that identifies the index location of a Border object.
|
|
89714
|
+
*/
|
|
89715
|
+
getItem(index: number): Word.Border;
|
|
89716
|
+
/**
|
|
89717
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
89718
|
+
*
|
|
89719
|
+
* @param options Provides options for which properties of the object to load.
|
|
89720
|
+
*/
|
|
89721
|
+
load(options?: Word.Interfaces.BorderCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.BorderCollection;
|
|
89722
|
+
/**
|
|
89723
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
89724
|
+
*
|
|
89725
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
89726
|
+
*/
|
|
89727
|
+
load(propertyNames?: string | string[]): Word.BorderCollection;
|
|
89728
|
+
/**
|
|
89729
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
89730
|
+
*
|
|
89731
|
+
* @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.
|
|
89732
|
+
*/
|
|
89733
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.BorderCollection;
|
|
89734
|
+
/**
|
|
89735
|
+
* 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.
|
|
89736
|
+
*/
|
|
89737
|
+
track(): Word.BorderCollection;
|
|
89738
|
+
/**
|
|
89739
|
+
* 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.
|
|
89740
|
+
*/
|
|
89741
|
+
untrack(): Word.BorderCollection;
|
|
89742
|
+
/**
|
|
89743
|
+
* 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.)
|
|
89744
|
+
* Whereas the original `Word.BorderCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BorderCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
89745
|
+
*/
|
|
89746
|
+
toJSON(): Word.Interfaces.BorderCollectionData;
|
|
89747
|
+
}
|
|
89106
89748
|
/**
|
|
89107
89749
|
* Represents a comment in the document.
|
|
89108
89750
|
*
|
|
@@ -89221,11 +89863,11 @@ declare namespace Word {
|
|
|
89221
89863
|
expand?: string;
|
|
89222
89864
|
}): Word.Comment;
|
|
89223
89865
|
/**
|
|
89224
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
89866
|
+
* 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.
|
|
89225
89867
|
*/
|
|
89226
89868
|
track(): Word.Comment;
|
|
89227
89869
|
/**
|
|
89228
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
89870
|
+
* 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.
|
|
89229
89871
|
*/
|
|
89230
89872
|
untrack(): Word.Comment;
|
|
89231
89873
|
/**
|
|
@@ -89253,7 +89895,7 @@ declare namespace Word {
|
|
|
89253
89895
|
*/
|
|
89254
89896
|
getFirst(): Word.Comment;
|
|
89255
89897
|
/**
|
|
89256
|
-
* Gets the first comment in the collection. If the collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
89898
|
+
* Gets the first comment in the collection. If the collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
89257
89899
|
*
|
|
89258
89900
|
* @remarks
|
|
89259
89901
|
* [Api set: WordApi 1.4]
|
|
@@ -89278,11 +89920,11 @@ declare namespace Word {
|
|
|
89278
89920
|
*/
|
|
89279
89921
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CommentCollection;
|
|
89280
89922
|
/**
|
|
89281
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
89923
|
+
* 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.
|
|
89282
89924
|
*/
|
|
89283
89925
|
track(): Word.CommentCollection;
|
|
89284
89926
|
/**
|
|
89285
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
89927
|
+
* 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.
|
|
89286
89928
|
*/
|
|
89287
89929
|
untrack(): Word.CommentCollection;
|
|
89288
89930
|
/**
|
|
@@ -89387,11 +90029,11 @@ declare namespace Word {
|
|
|
89387
90029
|
expand?: string;
|
|
89388
90030
|
}): Word.CommentContentRange;
|
|
89389
90031
|
/**
|
|
89390
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
90032
|
+
* 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.
|
|
89391
90033
|
*/
|
|
89392
90034
|
track(): Word.CommentContentRange;
|
|
89393
90035
|
/**
|
|
89394
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
90036
|
+
* 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.
|
|
89395
90037
|
*/
|
|
89396
90038
|
untrack(): Word.CommentContentRange;
|
|
89397
90039
|
/**
|
|
@@ -89495,11 +90137,11 @@ declare namespace Word {
|
|
|
89495
90137
|
expand?: string;
|
|
89496
90138
|
}): Word.CommentReply;
|
|
89497
90139
|
/**
|
|
89498
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
90140
|
+
* 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.
|
|
89499
90141
|
*/
|
|
89500
90142
|
track(): Word.CommentReply;
|
|
89501
90143
|
/**
|
|
89502
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
90144
|
+
* 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.
|
|
89503
90145
|
*/
|
|
89504
90146
|
untrack(): Word.CommentReply;
|
|
89505
90147
|
/**
|
|
@@ -89527,7 +90169,7 @@ declare namespace Word {
|
|
|
89527
90169
|
*/
|
|
89528
90170
|
getFirst(): Word.CommentReply;
|
|
89529
90171
|
/**
|
|
89530
|
-
* Gets the first comment reply in the collection. If the collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
90172
|
+
* Gets the first comment reply in the collection. If the collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
89531
90173
|
*
|
|
89532
90174
|
* @remarks
|
|
89533
90175
|
* [Api set: WordApi 1.4]
|
|
@@ -89552,11 +90194,11 @@ declare namespace Word {
|
|
|
89552
90194
|
*/
|
|
89553
90195
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CommentReplyCollection;
|
|
89554
90196
|
/**
|
|
89555
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
90197
|
+
* 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.
|
|
89556
90198
|
*/
|
|
89557
90199
|
track(): Word.CommentReplyCollection;
|
|
89558
90200
|
/**
|
|
89559
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
90201
|
+
* 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.
|
|
89560
90202
|
*/
|
|
89561
90203
|
untrack(): Word.CommentReplyCollection;
|
|
89562
90204
|
/**
|
|
@@ -89645,7 +90287,7 @@ declare namespace Word {
|
|
|
89645
90287
|
*/
|
|
89646
90288
|
readonly parentContentControl: Word.ContentControl;
|
|
89647
90289
|
/**
|
|
89648
|
-
* Gets the content control that contains the content control. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
90290
|
+
* Gets the content control that contains the content control. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
89649
90291
|
*
|
|
89650
90292
|
* @remarks
|
|
89651
90293
|
* [Api set: WordApi 1.3]
|
|
@@ -89666,14 +90308,14 @@ declare namespace Word {
|
|
|
89666
90308
|
*/
|
|
89667
90309
|
readonly parentTableCell: Word.TableCell;
|
|
89668
90310
|
/**
|
|
89669
|
-
* Gets the table cell that contains the content control. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
90311
|
+
* Gets the table cell that contains the content control. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
89670
90312
|
*
|
|
89671
90313
|
* @remarks
|
|
89672
90314
|
* [Api set: WordApi 1.3]
|
|
89673
90315
|
*/
|
|
89674
90316
|
readonly parentTableCellOrNullObject: Word.TableCell;
|
|
89675
90317
|
/**
|
|
89676
|
-
* Gets the table that contains the content control. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
90318
|
+
* Gets the table that contains the content control. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
89677
90319
|
*
|
|
89678
90320
|
* @remarks
|
|
89679
90321
|
* [Api set: WordApi 1.3]
|
|
@@ -89877,6 +90519,14 @@ declare namespace Word {
|
|
|
89877
90519
|
* @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection.
|
|
89878
90520
|
*/
|
|
89879
90521
|
getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection;
|
|
90522
|
+
/**
|
|
90523
|
+
* Gets the collection of the TrackedChange objects in the content control.
|
|
90524
|
+
*
|
|
90525
|
+
* @remarks
|
|
90526
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
90527
|
+
* @beta
|
|
90528
|
+
*/
|
|
90529
|
+
getTrackedChanges(): Word.TrackedChangeCollection;
|
|
89880
90530
|
/**
|
|
89881
90531
|
* Inserts a break at the specified location in the main document. This method cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls.
|
|
89882
90532
|
*
|
|
@@ -90114,11 +90764,11 @@ declare namespace Word {
|
|
|
90114
90764
|
*/
|
|
90115
90765
|
readonly onSelectionChanged: OfficeExtension.EventHandlers<Word.ContentControlSelectionChangedEventArgs>;
|
|
90116
90766
|
/**
|
|
90117
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
90767
|
+
* 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.
|
|
90118
90768
|
*/
|
|
90119
90769
|
track(): Word.ContentControl;
|
|
90120
90770
|
/**
|
|
90121
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
90771
|
+
* 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.
|
|
90122
90772
|
*/
|
|
90123
90773
|
untrack(): Word.ContentControl;
|
|
90124
90774
|
/**
|
|
@@ -90157,7 +90807,7 @@ declare namespace Word {
|
|
|
90157
90807
|
*/
|
|
90158
90808
|
getById(id: number): Word.ContentControl;
|
|
90159
90809
|
/**
|
|
90160
|
-
* Gets a content control by its identifier. If there isn't a content control with the identifier in this collection, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
90810
|
+
* Gets a content control by its identifier. If there isn't a content control with the identifier in this collection, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
90161
90811
|
*
|
|
90162
90812
|
* @remarks
|
|
90163
90813
|
* [Api set: WordApi 1.3]
|
|
@@ -90200,7 +90850,7 @@ declare namespace Word {
|
|
|
90200
90850
|
*/
|
|
90201
90851
|
getFirst(): Word.ContentControl;
|
|
90202
90852
|
/**
|
|
90203
|
-
* Gets the first content control 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://
|
|
90853
|
+
* Gets the first content control in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
90204
90854
|
*
|
|
90205
90855
|
* @remarks
|
|
90206
90856
|
* [Api set: WordApi 1.3]
|
|
@@ -90234,11 +90884,11 @@ declare namespace Word {
|
|
|
90234
90884
|
*/
|
|
90235
90885
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ContentControlCollection;
|
|
90236
90886
|
/**
|
|
90237
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
90887
|
+
* 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.
|
|
90238
90888
|
*/
|
|
90239
90889
|
track(): Word.ContentControlCollection;
|
|
90240
90890
|
/**
|
|
90241
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
90891
|
+
* 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.
|
|
90242
90892
|
*/
|
|
90243
90893
|
untrack(): Word.ContentControlCollection;
|
|
90244
90894
|
/**
|
|
@@ -90329,11 +90979,11 @@ declare namespace Word {
|
|
|
90329
90979
|
expand?: string;
|
|
90330
90980
|
}): Word.CustomProperty;
|
|
90331
90981
|
/**
|
|
90332
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
90982
|
+
* 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.
|
|
90333
90983
|
*/
|
|
90334
90984
|
track(): Word.CustomProperty;
|
|
90335
90985
|
/**
|
|
90336
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
90986
|
+
* 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.
|
|
90337
90987
|
*/
|
|
90338
90988
|
untrack(): Word.CustomProperty;
|
|
90339
90989
|
/**
|
|
@@ -90387,7 +91037,7 @@ declare namespace Word {
|
|
|
90387
91037
|
*/
|
|
90388
91038
|
getItem(key: string): Word.CustomProperty;
|
|
90389
91039
|
/**
|
|
90390
|
-
* Gets a custom property object by its key, which is case-insensitive. If the custom property does not exist, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
91040
|
+
* Gets a custom property object by its key, which is case-insensitive. If the custom property does not exist, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
90391
91041
|
*
|
|
90392
91042
|
* @remarks
|
|
90393
91043
|
* [Api set: WordApi 1.3]
|
|
@@ -90414,11 +91064,11 @@ declare namespace Word {
|
|
|
90414
91064
|
*/
|
|
90415
91065
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CustomPropertyCollection;
|
|
90416
91066
|
/**
|
|
90417
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
91067
|
+
* 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.
|
|
90418
91068
|
*/
|
|
90419
91069
|
track(): Word.CustomPropertyCollection;
|
|
90420
91070
|
/**
|
|
90421
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
91071
|
+
* 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.
|
|
90422
91072
|
*/
|
|
90423
91073
|
untrack(): Word.CustomPropertyCollection;
|
|
90424
91074
|
/**
|
|
@@ -90693,11 +91343,11 @@ declare namespace Word {
|
|
|
90693
91343
|
expand?: string;
|
|
90694
91344
|
}): Word.CustomXmlPart;
|
|
90695
91345
|
/**
|
|
90696
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
91346
|
+
* 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.
|
|
90697
91347
|
*/
|
|
90698
91348
|
track(): Word.CustomXmlPart;
|
|
90699
91349
|
/**
|
|
90700
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
91350
|
+
* 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.
|
|
90701
91351
|
*/
|
|
90702
91352
|
untrack(): Word.CustomXmlPart;
|
|
90703
91353
|
/**
|
|
@@ -90752,7 +91402,7 @@ declare namespace Word {
|
|
|
90752
91402
|
*/
|
|
90753
91403
|
getItem(id: string): Word.CustomXmlPart;
|
|
90754
91404
|
/**
|
|
90755
|
-
* Gets a custom XML part based on its ID. If the CustomXmlPart does not exist, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
91405
|
+
* Gets a custom XML part based on its ID. If the CustomXmlPart does not exist, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
90756
91406
|
*
|
|
90757
91407
|
* @remarks
|
|
90758
91408
|
* [Api set: WordApi 1.4]
|
|
@@ -90779,11 +91429,11 @@ declare namespace Word {
|
|
|
90779
91429
|
*/
|
|
90780
91430
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CustomXmlPartCollection;
|
|
90781
91431
|
/**
|
|
90782
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
91432
|
+
* 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.
|
|
90783
91433
|
*/
|
|
90784
91434
|
track(): Word.CustomXmlPartCollection;
|
|
90785
91435
|
/**
|
|
90786
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
91436
|
+
* 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.
|
|
90787
91437
|
*/
|
|
90788
91438
|
untrack(): Word.CustomXmlPartCollection;
|
|
90789
91439
|
/**
|
|
@@ -90820,7 +91470,7 @@ declare namespace Word {
|
|
|
90820
91470
|
*/
|
|
90821
91471
|
getItem(id: string): Word.CustomXmlPart;
|
|
90822
91472
|
/**
|
|
90823
|
-
* Gets a custom XML part based on its ID. If the CustomXmlPart does not exist in the collection, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
91473
|
+
* Gets a custom XML part based on its ID. If the CustomXmlPart does not exist in the collection, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
90824
91474
|
*
|
|
90825
91475
|
* @remarks
|
|
90826
91476
|
* [Api set: WordApi 1.4]
|
|
@@ -90836,7 +91486,7 @@ declare namespace Word {
|
|
|
90836
91486
|
*/
|
|
90837
91487
|
getOnlyItem(): Word.CustomXmlPart;
|
|
90838
91488
|
/**
|
|
90839
|
-
* If the collection contains exactly one item, this method returns it. Otherwise, this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
91489
|
+
* If the collection contains exactly one item, this method returns it. Otherwise, this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
90840
91490
|
*
|
|
90841
91491
|
* @remarks
|
|
90842
91492
|
* [Api set: WordApi 1.4]
|
|
@@ -90861,11 +91511,11 @@ declare namespace Word {
|
|
|
90861
91511
|
*/
|
|
90862
91512
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CustomXmlPartScopedCollection;
|
|
90863
91513
|
/**
|
|
90864
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
91514
|
+
* 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.
|
|
90865
91515
|
*/
|
|
90866
91516
|
track(): Word.CustomXmlPartScopedCollection;
|
|
90867
91517
|
/**
|
|
90868
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
91518
|
+
* 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.
|
|
90869
91519
|
*/
|
|
90870
91520
|
untrack(): Word.CustomXmlPartScopedCollection;
|
|
90871
91521
|
/**
|
|
@@ -90994,6 +91644,16 @@ declare namespace Word {
|
|
|
90994
91644
|
* @param name Required. The bookmark name, which is case-insensitive.
|
|
90995
91645
|
*/
|
|
90996
91646
|
deleteBookmark(name: string): void;
|
|
91647
|
+
/**
|
|
91648
|
+
* Gets the annotation by ID. Throws an `ItemNotFound` error if annotation isn't found.
|
|
91649
|
+
*
|
|
91650
|
+
* @remarks
|
|
91651
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
91652
|
+
* @beta
|
|
91653
|
+
*
|
|
91654
|
+
* @param id The ID of the annotation to get.
|
|
91655
|
+
*/
|
|
91656
|
+
getAnnotationById(id: string): Word.Annotation;
|
|
90997
91657
|
/**
|
|
90998
91658
|
* Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark does not exist.
|
|
90999
91659
|
*
|
|
@@ -91004,7 +91664,7 @@ declare namespace Word {
|
|
|
91004
91664
|
*/
|
|
91005
91665
|
getBookmarkRange(name: string): Word.Range;
|
|
91006
91666
|
/**
|
|
91007
|
-
* Gets a bookmark's range. If the bookmark does not exist, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
91667
|
+
* Gets a bookmark's range. If the bookmark does not exist, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
91008
91668
|
*
|
|
91009
91669
|
* @remarks
|
|
91010
91670
|
* [Api set: WordApi 1.4]
|
|
@@ -91039,6 +91699,16 @@ declare namespace Word {
|
|
|
91039
91699
|
* [Api set: WordApi 1.5]
|
|
91040
91700
|
*/
|
|
91041
91701
|
getFootnoteBody(): Word.Body;
|
|
91702
|
+
/**
|
|
91703
|
+
* Gets the paragraph by its unique local ID. Throws an `ItemNotFound` error if the collection is empty.
|
|
91704
|
+
*
|
|
91705
|
+
* @remarks
|
|
91706
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
91707
|
+
* @beta
|
|
91708
|
+
*
|
|
91709
|
+
* @param id Required. Unique local ID in standard 8-4-4-4-12 GUID format without curly braces. Note that the ID differs across sessions and coauthors.
|
|
91710
|
+
*/
|
|
91711
|
+
getParagraphByUniqueLocalId(id: string): Word.Paragraph;
|
|
91042
91712
|
/**
|
|
91043
91713
|
* Gets the current selection of the document. Multiple selections are not supported.
|
|
91044
91714
|
*
|
|
@@ -91053,6 +91723,16 @@ declare namespace Word {
|
|
|
91053
91723
|
* [Api set: WordApi 1.5]
|
|
91054
91724
|
*/
|
|
91055
91725
|
getStyles(): Word.StyleCollection;
|
|
91726
|
+
/**
|
|
91727
|
+
* Import styles from a JSON-formatted string.
|
|
91728
|
+
*
|
|
91729
|
+
* @remarks
|
|
91730
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
91731
|
+
* @beta
|
|
91732
|
+
*
|
|
91733
|
+
* @param stylesJson Required. A JSON-formatted string representing the styles.
|
|
91734
|
+
*/
|
|
91735
|
+
importStylesFromJson(stylesJson: string): OfficeExtension.ClientResult<string[]>;
|
|
91056
91736
|
/**
|
|
91057
91737
|
* Inserts a document into the target document at a specific location with additional properties.
|
|
91058
91738
|
Headers, footers, watermarks, and other section properties are copied by default.
|
|
@@ -91125,6 +91805,46 @@ declare namespace Word {
|
|
|
91125
91805
|
select?: string;
|
|
91126
91806
|
expand?: string;
|
|
91127
91807
|
}): Word.Document;
|
|
91808
|
+
/**
|
|
91809
|
+
* Occurs when the user clicks an annotation (or selects it using **Alt+Down**).
|
|
91810
|
+
*
|
|
91811
|
+
* @remarks
|
|
91812
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
91813
|
+
*
|
|
91814
|
+
* @eventproperty
|
|
91815
|
+
* @beta
|
|
91816
|
+
*/
|
|
91817
|
+
readonly onAnnotationClicked: OfficeExtension.EventHandlers<Word.AnnotationClickedEventArgs>;
|
|
91818
|
+
/**
|
|
91819
|
+
* Occurs when the user hovers the cursor over an annotation.
|
|
91820
|
+
*
|
|
91821
|
+
* @remarks
|
|
91822
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
91823
|
+
*
|
|
91824
|
+
* @eventproperty
|
|
91825
|
+
* @beta
|
|
91826
|
+
*/
|
|
91827
|
+
readonly onAnnotationHovered: OfficeExtension.EventHandlers<Word.AnnotationHoveredEventArgs>;
|
|
91828
|
+
/**
|
|
91829
|
+
* Occurs when the user adds one or more annotations.
|
|
91830
|
+
*
|
|
91831
|
+
* @remarks
|
|
91832
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
91833
|
+
*
|
|
91834
|
+
* @eventproperty
|
|
91835
|
+
* @beta
|
|
91836
|
+
*/
|
|
91837
|
+
readonly onAnnotationInserted: OfficeExtension.EventHandlers<Word.AnnotationInsertedEventArgs>;
|
|
91838
|
+
/**
|
|
91839
|
+
* Occurs when the user deletes one or more annotations.
|
|
91840
|
+
*
|
|
91841
|
+
* @remarks
|
|
91842
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
91843
|
+
*
|
|
91844
|
+
* @eventproperty
|
|
91845
|
+
* @beta
|
|
91846
|
+
*/
|
|
91847
|
+
readonly onAnnotationRemoved: OfficeExtension.EventHandlers<Word.AnnotationRemovedEventArgs>;
|
|
91128
91848
|
/**
|
|
91129
91849
|
* Occurs when a content control is added. Run context.sync() in the handler to get the new content control's properties.
|
|
91130
91850
|
*
|
|
@@ -91135,11 +91855,41 @@ declare namespace Word {
|
|
|
91135
91855
|
*/
|
|
91136
91856
|
readonly onContentControlAdded: OfficeExtension.EventHandlers<Word.ContentControlAddedEventArgs>;
|
|
91137
91857
|
/**
|
|
91138
|
-
*
|
|
91858
|
+
* Occurs when the user adds new paragraphs.
|
|
91859
|
+
*
|
|
91860
|
+
* @remarks
|
|
91861
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
91862
|
+
*
|
|
91863
|
+
* @eventproperty
|
|
91864
|
+
* @beta
|
|
91865
|
+
*/
|
|
91866
|
+
readonly onParagraphAdded: OfficeExtension.EventHandlers<Word.ParagraphAddedEventArgs>;
|
|
91867
|
+
/**
|
|
91868
|
+
* Occurs when the user changes paragraphs.
|
|
91869
|
+
*
|
|
91870
|
+
* @remarks
|
|
91871
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
91872
|
+
*
|
|
91873
|
+
* @eventproperty
|
|
91874
|
+
* @beta
|
|
91875
|
+
*/
|
|
91876
|
+
readonly onParagraphChanged: OfficeExtension.EventHandlers<Word.ParagraphChangedEventArgs>;
|
|
91877
|
+
/**
|
|
91878
|
+
* Occurs when the user deletes paragraphs.
|
|
91879
|
+
*
|
|
91880
|
+
* @remarks
|
|
91881
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
91882
|
+
*
|
|
91883
|
+
* @eventproperty
|
|
91884
|
+
* @beta
|
|
91885
|
+
*/
|
|
91886
|
+
readonly onParagraphDeleted: OfficeExtension.EventHandlers<Word.ParagraphDeletedEventArgs>;
|
|
91887
|
+
/**
|
|
91888
|
+
* 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.
|
|
91139
91889
|
*/
|
|
91140
91890
|
track(): Word.Document;
|
|
91141
91891
|
/**
|
|
91142
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
91892
|
+
* 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.
|
|
91143
91893
|
*/
|
|
91144
91894
|
untrack(): Word.Document;
|
|
91145
91895
|
/**
|
|
@@ -91253,7 +92003,7 @@ declare namespace Word {
|
|
|
91253
92003
|
*/
|
|
91254
92004
|
getBookmarkRange(name: string): Word.Range;
|
|
91255
92005
|
/**
|
|
91256
|
-
* Gets a bookmark's range. If the bookmark does not exist, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
92006
|
+
* Gets a bookmark's range. If the bookmark does not exist, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
91257
92007
|
*
|
|
91258
92008
|
* @remarks
|
|
91259
92009
|
* [Api set: WordApiHiddenDocument 1.4]
|
|
@@ -91344,11 +92094,11 @@ declare namespace Word {
|
|
|
91344
92094
|
expand?: string;
|
|
91345
92095
|
}): Word.DocumentCreated;
|
|
91346
92096
|
/**
|
|
91347
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
92097
|
+
* 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.
|
|
91348
92098
|
*/
|
|
91349
92099
|
track(): Word.DocumentCreated;
|
|
91350
92100
|
/**
|
|
91351
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
92101
|
+
* 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.
|
|
91352
92102
|
*/
|
|
91353
92103
|
untrack(): Word.DocumentCreated;
|
|
91354
92104
|
/**
|
|
@@ -91522,11 +92272,11 @@ declare namespace Word {
|
|
|
91522
92272
|
expand?: string;
|
|
91523
92273
|
}): Word.DocumentProperties;
|
|
91524
92274
|
/**
|
|
91525
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
92275
|
+
* 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.
|
|
91526
92276
|
*/
|
|
91527
92277
|
track(): Word.DocumentProperties;
|
|
91528
92278
|
/**
|
|
91529
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
92279
|
+
* 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.
|
|
91530
92280
|
*/
|
|
91531
92281
|
untrack(): Word.DocumentProperties;
|
|
91532
92282
|
/**
|
|
@@ -91559,7 +92309,7 @@ declare namespace Word {
|
|
|
91559
92309
|
*/
|
|
91560
92310
|
readonly parentContentControl: Word.ContentControl;
|
|
91561
92311
|
/**
|
|
91562
|
-
* Gets the content control that contains the field. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
92312
|
+
* Gets the content control that contains the field. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
91563
92313
|
*
|
|
91564
92314
|
* @remarks
|
|
91565
92315
|
* [Api set: WordApi 1.4]
|
|
@@ -91580,14 +92330,14 @@ declare namespace Word {
|
|
|
91580
92330
|
*/
|
|
91581
92331
|
readonly parentTableCell: Word.TableCell;
|
|
91582
92332
|
/**
|
|
91583
|
-
* Gets the table cell that contains the field. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
92333
|
+
* Gets the table cell that contains the field. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
91584
92334
|
*
|
|
91585
92335
|
* @remarks
|
|
91586
92336
|
* [Api set: WordApi 1.4]
|
|
91587
92337
|
*/
|
|
91588
92338
|
readonly parentTableCellOrNullObject: Word.TableCell;
|
|
91589
92339
|
/**
|
|
91590
|
-
* Gets the table that contains the field. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
92340
|
+
* Gets the table that contains the field. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
91591
92341
|
*
|
|
91592
92342
|
* @remarks
|
|
91593
92343
|
* [Api set: WordApi 1.4]
|
|
@@ -91668,7 +92418,7 @@ declare namespace Word {
|
|
|
91668
92418
|
*/
|
|
91669
92419
|
getNext(): Word.Field;
|
|
91670
92420
|
/**
|
|
91671
|
-
* Gets the next field. If this field is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
92421
|
+
* Gets the next field. If this field is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
91672
92422
|
*
|
|
91673
92423
|
* @remarks
|
|
91674
92424
|
* [Api set: WordApi 1.4]
|
|
@@ -91721,11 +92471,11 @@ declare namespace Word {
|
|
|
91721
92471
|
expand?: string;
|
|
91722
92472
|
}): Word.Field;
|
|
91723
92473
|
/**
|
|
91724
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
92474
|
+
* 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.
|
|
91725
92475
|
*/
|
|
91726
92476
|
track(): Word.Field;
|
|
91727
92477
|
/**
|
|
91728
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
92478
|
+
* 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.
|
|
91729
92479
|
*/
|
|
91730
92480
|
untrack(): Word.Field;
|
|
91731
92481
|
/**
|
|
@@ -91753,7 +92503,7 @@ declare namespace Word {
|
|
|
91753
92503
|
*/
|
|
91754
92504
|
getFirst(): Word.Field;
|
|
91755
92505
|
/**
|
|
91756
|
-
* Gets the first field 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://
|
|
92506
|
+
* Gets the first field in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
91757
92507
|
*
|
|
91758
92508
|
* @remarks
|
|
91759
92509
|
* [Api set: WordApi 1.4]
|
|
@@ -91787,11 +92537,11 @@ declare namespace Word {
|
|
|
91787
92537
|
*/
|
|
91788
92538
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.FieldCollection;
|
|
91789
92539
|
/**
|
|
91790
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
92540
|
+
* 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.
|
|
91791
92541
|
*/
|
|
91792
92542
|
track(): Word.FieldCollection;
|
|
91793
92543
|
/**
|
|
91794
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
92544
|
+
* 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.
|
|
91795
92545
|
*/
|
|
91796
92546
|
untrack(): Word.FieldCollection;
|
|
91797
92547
|
/**
|
|
@@ -91830,6 +92580,14 @@ declare namespace Word {
|
|
|
91830
92580
|
* [Api set: WordApi 1.1]
|
|
91831
92581
|
*/
|
|
91832
92582
|
doubleStrikeThrough: boolean;
|
|
92583
|
+
/**
|
|
92584
|
+
* Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false.
|
|
92585
|
+
*
|
|
92586
|
+
* @remarks
|
|
92587
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
92588
|
+
* @beta
|
|
92589
|
+
*/
|
|
92590
|
+
hidden: boolean;
|
|
91833
92591
|
/**
|
|
91834
92592
|
* Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or null for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font.
|
|
91835
92593
|
*
|
|
@@ -91916,11 +92674,11 @@ declare namespace Word {
|
|
|
91916
92674
|
expand?: string;
|
|
91917
92675
|
}): Word.Font;
|
|
91918
92676
|
/**
|
|
91919
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
92677
|
+
* 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.
|
|
91920
92678
|
*/
|
|
91921
92679
|
track(): Word.Font;
|
|
91922
92680
|
/**
|
|
91923
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
92681
|
+
* 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.
|
|
91924
92682
|
*/
|
|
91925
92683
|
untrack(): Word.Font;
|
|
91926
92684
|
/**
|
|
@@ -91953,7 +92711,7 @@ declare namespace Word {
|
|
|
91953
92711
|
*/
|
|
91954
92712
|
readonly parentContentControl: Word.ContentControl;
|
|
91955
92713
|
/**
|
|
91956
|
-
* Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
92714
|
+
* Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
91957
92715
|
*
|
|
91958
92716
|
* @remarks
|
|
91959
92717
|
* [Api set: WordApi 1.3]
|
|
@@ -91974,14 +92732,14 @@ declare namespace Word {
|
|
|
91974
92732
|
*/
|
|
91975
92733
|
readonly parentTableCell: Word.TableCell;
|
|
91976
92734
|
/**
|
|
91977
|
-
* Gets the table cell that contains the inline image. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
92735
|
+
* Gets the table cell that contains the inline image. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
91978
92736
|
*
|
|
91979
92737
|
* @remarks
|
|
91980
92738
|
* [Api set: WordApi 1.3]
|
|
91981
92739
|
*/
|
|
91982
92740
|
readonly parentTableCellOrNullObject: Word.TableCell;
|
|
91983
92741
|
/**
|
|
91984
|
-
* Gets the table that contains the inline image. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
92742
|
+
* Gets the table that contains the inline image. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
91985
92743
|
*
|
|
91986
92744
|
* @remarks
|
|
91987
92745
|
* [Api set: WordApi 1.3]
|
|
@@ -92067,7 +92825,7 @@ declare namespace Word {
|
|
|
92067
92825
|
*/
|
|
92068
92826
|
getNext(): Word.InlinePicture;
|
|
92069
92827
|
/**
|
|
92070
|
-
* Gets the next inline image. If this inline image is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
92828
|
+
* Gets the next inline image. If this inline image is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
92071
92829
|
*
|
|
92072
92830
|
* @remarks
|
|
92073
92831
|
* [Api set: WordApi 1.3]
|
|
@@ -92199,11 +92957,11 @@ declare namespace Word {
|
|
|
92199
92957
|
expand?: string;
|
|
92200
92958
|
}): Word.InlinePicture;
|
|
92201
92959
|
/**
|
|
92202
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
92960
|
+
* 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.
|
|
92203
92961
|
*/
|
|
92204
92962
|
track(): Word.InlinePicture;
|
|
92205
92963
|
/**
|
|
92206
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
92964
|
+
* 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.
|
|
92207
92965
|
*/
|
|
92208
92966
|
untrack(): Word.InlinePicture;
|
|
92209
92967
|
/**
|
|
@@ -92231,7 +92989,7 @@ declare namespace Word {
|
|
|
92231
92989
|
*/
|
|
92232
92990
|
getFirst(): Word.InlinePicture;
|
|
92233
92991
|
/**
|
|
92234
|
-
* Gets the first inline image 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://
|
|
92992
|
+
* Gets the first inline image in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
92235
92993
|
*
|
|
92236
92994
|
* @remarks
|
|
92237
92995
|
* [Api set: WordApi 1.3]
|
|
@@ -92256,11 +93014,11 @@ declare namespace Word {
|
|
|
92256
93014
|
*/
|
|
92257
93015
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.InlinePictureCollection;
|
|
92258
93016
|
/**
|
|
92259
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
93017
|
+
* 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.
|
|
92260
93018
|
*/
|
|
92261
93019
|
track(): Word.InlinePictureCollection;
|
|
92262
93020
|
/**
|
|
92263
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
93021
|
+
* 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.
|
|
92264
93022
|
*/
|
|
92265
93023
|
untrack(): Word.InlinePictureCollection;
|
|
92266
93024
|
/**
|
|
@@ -92485,11 +93243,11 @@ declare namespace Word {
|
|
|
92485
93243
|
expand?: string;
|
|
92486
93244
|
}): Word.List;
|
|
92487
93245
|
/**
|
|
92488
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
93246
|
+
* 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.
|
|
92489
93247
|
*/
|
|
92490
93248
|
track(): Word.List;
|
|
92491
93249
|
/**
|
|
92492
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
93250
|
+
* 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.
|
|
92493
93251
|
*/
|
|
92494
93252
|
untrack(): Word.List;
|
|
92495
93253
|
/**
|
|
@@ -92519,7 +93277,7 @@ declare namespace Word {
|
|
|
92519
93277
|
*/
|
|
92520
93278
|
getById(id: number): Word.List;
|
|
92521
93279
|
/**
|
|
92522
|
-
* Gets a list by its identifier. If there isn't a list with the identifier in this collection, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
93280
|
+
* Gets a list by its identifier. If there isn't a list with the identifier in this collection, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
92523
93281
|
*
|
|
92524
93282
|
* @remarks
|
|
92525
93283
|
* [Api set: WordApi 1.3]
|
|
@@ -92535,7 +93293,7 @@ declare namespace Word {
|
|
|
92535
93293
|
*/
|
|
92536
93294
|
getFirst(): Word.List;
|
|
92537
93295
|
/**
|
|
92538
|
-
* Gets the first list 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://
|
|
93296
|
+
* Gets the first list in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
92539
93297
|
*
|
|
92540
93298
|
* @remarks
|
|
92541
93299
|
* [Api set: WordApi 1.3]
|
|
@@ -92569,11 +93327,11 @@ declare namespace Word {
|
|
|
92569
93327
|
*/
|
|
92570
93328
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ListCollection;
|
|
92571
93329
|
/**
|
|
92572
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
93330
|
+
* 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.
|
|
92573
93331
|
*/
|
|
92574
93332
|
track(): Word.ListCollection;
|
|
92575
93333
|
/**
|
|
92576
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
93334
|
+
* 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.
|
|
92577
93335
|
*/
|
|
92578
93336
|
untrack(): Word.ListCollection;
|
|
92579
93337
|
/**
|
|
@@ -92630,7 +93388,7 @@ declare namespace Word {
|
|
|
92630
93388
|
*/
|
|
92631
93389
|
getAncestor(parentOnly?: boolean): Word.Paragraph;
|
|
92632
93390
|
/**
|
|
92633
|
-
* Gets the list item parent, or the closest ancestor if the parent does not exist. If the list item has no ancestor, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
93391
|
+
* Gets the list item parent, or the closest ancestor if the parent does not exist. If the list item has no ancestor, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
92634
93392
|
*
|
|
92635
93393
|
* @remarks
|
|
92636
93394
|
* [Api set: WordApi 1.3]
|
|
@@ -92669,11 +93427,11 @@ declare namespace Word {
|
|
|
92669
93427
|
expand?: string;
|
|
92670
93428
|
}): Word.ListItem;
|
|
92671
93429
|
/**
|
|
92672
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
93430
|
+
* 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.
|
|
92673
93431
|
*/
|
|
92674
93432
|
track(): Word.ListItem;
|
|
92675
93433
|
/**
|
|
92676
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
93434
|
+
* 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.
|
|
92677
93435
|
*/
|
|
92678
93436
|
untrack(): Word.ListItem;
|
|
92679
93437
|
/**
|
|
@@ -92810,11 +93568,11 @@ declare namespace Word {
|
|
|
92810
93568
|
expand?: string;
|
|
92811
93569
|
}): Word.ListLevel;
|
|
92812
93570
|
/**
|
|
92813
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
93571
|
+
* 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.
|
|
92814
93572
|
*/
|
|
92815
93573
|
track(): Word.ListLevel;
|
|
92816
93574
|
/**
|
|
92817
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
93575
|
+
* 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.
|
|
92818
93576
|
*/
|
|
92819
93577
|
untrack(): Word.ListLevel;
|
|
92820
93578
|
/**
|
|
@@ -92844,7 +93602,7 @@ declare namespace Word {
|
|
|
92844
93602
|
*/
|
|
92845
93603
|
getFirst(): Word.ListLevel;
|
|
92846
93604
|
/**
|
|
92847
|
-
* Gets the first list level 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://
|
|
93605
|
+
* Gets the first list level in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
92848
93606
|
*
|
|
92849
93607
|
* @remarks
|
|
92850
93608
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -92870,11 +93628,11 @@ declare namespace Word {
|
|
|
92870
93628
|
*/
|
|
92871
93629
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ListLevelCollection;
|
|
92872
93630
|
/**
|
|
92873
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
93631
|
+
* 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.
|
|
92874
93632
|
*/
|
|
92875
93633
|
track(): Word.ListLevelCollection;
|
|
92876
93634
|
/**
|
|
92877
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
93635
|
+
* 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.
|
|
92878
93636
|
*/
|
|
92879
93637
|
untrack(): Word.ListLevelCollection;
|
|
92880
93638
|
/**
|
|
@@ -92939,11 +93697,11 @@ declare namespace Word {
|
|
|
92939
93697
|
expand?: string;
|
|
92940
93698
|
}): Word.ListTemplate;
|
|
92941
93699
|
/**
|
|
92942
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
93700
|
+
* 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.
|
|
92943
93701
|
*/
|
|
92944
93702
|
track(): Word.ListTemplate;
|
|
92945
93703
|
/**
|
|
92946
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
93704
|
+
* 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.
|
|
92947
93705
|
*/
|
|
92948
93706
|
untrack(): Word.ListTemplate;
|
|
92949
93707
|
/**
|
|
@@ -93005,7 +93763,7 @@ declare namespace Word {
|
|
|
93005
93763
|
*/
|
|
93006
93764
|
getNext(): Word.NoteItem;
|
|
93007
93765
|
/**
|
|
93008
|
-
* Gets the next note item of the same type. If this note item is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
93766
|
+
* Gets the next note item of the same type. If this note item is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
93009
93767
|
*
|
|
93010
93768
|
* @remarks
|
|
93011
93769
|
* [Api set: WordApi 1.5]
|
|
@@ -93033,11 +93791,11 @@ declare namespace Word {
|
|
|
93033
93791
|
expand?: string;
|
|
93034
93792
|
}): Word.NoteItem;
|
|
93035
93793
|
/**
|
|
93036
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
93794
|
+
* 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.
|
|
93037
93795
|
*/
|
|
93038
93796
|
track(): Word.NoteItem;
|
|
93039
93797
|
/**
|
|
93040
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
93798
|
+
* 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.
|
|
93041
93799
|
*/
|
|
93042
93800
|
untrack(): Word.NoteItem;
|
|
93043
93801
|
/**
|
|
@@ -93065,7 +93823,7 @@ declare namespace Word {
|
|
|
93065
93823
|
*/
|
|
93066
93824
|
getFirst(): Word.NoteItem;
|
|
93067
93825
|
/**
|
|
93068
|
-
* Gets the first note item 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://
|
|
93826
|
+
* Gets the first note item in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
93069
93827
|
*
|
|
93070
93828
|
* @remarks
|
|
93071
93829
|
* [Api set: WordApi 1.5]
|
|
@@ -93090,11 +93848,11 @@ declare namespace Word {
|
|
|
93090
93848
|
*/
|
|
93091
93849
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.NoteItemCollection;
|
|
93092
93850
|
/**
|
|
93093
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
93851
|
+
* 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.
|
|
93094
93852
|
*/
|
|
93095
93853
|
track(): Word.NoteItemCollection;
|
|
93096
93854
|
/**
|
|
93097
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
93855
|
+
* 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.
|
|
93098
93856
|
*/
|
|
93099
93857
|
untrack(): Word.NoteItemCollection;
|
|
93100
93858
|
/**
|
|
@@ -93169,14 +93927,14 @@ declare namespace Word {
|
|
|
93169
93927
|
*/
|
|
93170
93928
|
readonly listItem: Word.ListItem;
|
|
93171
93929
|
/**
|
|
93172
|
-
* Gets the ListItem for the paragraph. If the paragraph is not part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
93930
|
+
* Gets the ListItem for the paragraph. If the paragraph is not part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
93173
93931
|
*
|
|
93174
93932
|
* @remarks
|
|
93175
93933
|
* [Api set: WordApi 1.3]
|
|
93176
93934
|
*/
|
|
93177
93935
|
readonly listItemOrNullObject: Word.ListItem;
|
|
93178
93936
|
/**
|
|
93179
|
-
* Gets the List to which this paragraph belongs. If the paragraph is not in a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
93937
|
+
* Gets the List to which this paragraph belongs. If the paragraph is not in a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
93180
93938
|
*
|
|
93181
93939
|
* @remarks
|
|
93182
93940
|
* [Api set: WordApi 1.3]
|
|
@@ -93197,7 +93955,7 @@ declare namespace Word {
|
|
|
93197
93955
|
*/
|
|
93198
93956
|
readonly parentContentControl: Word.ContentControl;
|
|
93199
93957
|
/**
|
|
93200
|
-
* Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
93958
|
+
* Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
93201
93959
|
*
|
|
93202
93960
|
* @remarks
|
|
93203
93961
|
* [Api set: WordApi 1.3]
|
|
@@ -93218,14 +93976,14 @@ declare namespace Word {
|
|
|
93218
93976
|
*/
|
|
93219
93977
|
readonly parentTableCell: Word.TableCell;
|
|
93220
93978
|
/**
|
|
93221
|
-
* Gets the table cell that contains the paragraph. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
93979
|
+
* Gets the table cell that contains the paragraph. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
93222
93980
|
*
|
|
93223
93981
|
* @remarks
|
|
93224
93982
|
* [Api set: WordApi 1.3]
|
|
93225
93983
|
*/
|
|
93226
93984
|
readonly parentTableCellOrNullObject: Word.TableCell;
|
|
93227
93985
|
/**
|
|
93228
|
-
* Gets the table that contains the paragraph. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
93986
|
+
* Gets the table that contains the paragraph. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
93229
93987
|
*
|
|
93230
93988
|
* @remarks
|
|
93231
93989
|
* [Api set: WordApi 1.3]
|
|
@@ -93344,7 +94102,7 @@ declare namespace Word {
|
|
|
93344
94102
|
*/
|
|
93345
94103
|
readonly text: string;
|
|
93346
94104
|
/**
|
|
93347
|
-
* Gets a string that represents the paragraph identifier in the current session.
|
|
94105
|
+
* Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors.
|
|
93348
94106
|
*
|
|
93349
94107
|
* @remarks
|
|
93350
94108
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -93390,6 +94148,14 @@ declare namespace Word {
|
|
|
93390
94148
|
* [Api set: WordApi 1.3]
|
|
93391
94149
|
*/
|
|
93392
94150
|
detachFromList(): void;
|
|
94151
|
+
/**
|
|
94152
|
+
* Gets annotations set on this Paragraph object.
|
|
94153
|
+
*
|
|
94154
|
+
* @remarks
|
|
94155
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
94156
|
+
* @beta
|
|
94157
|
+
*/
|
|
94158
|
+
getAnnotations(): Word.AnnotationCollection;
|
|
93393
94159
|
/**
|
|
93394
94160
|
* Gets comments associated with the paragraph.
|
|
93395
94161
|
*
|
|
@@ -93423,7 +94189,7 @@ declare namespace Word {
|
|
|
93423
94189
|
*/
|
|
93424
94190
|
getNext(): Word.Paragraph;
|
|
93425
94191
|
/**
|
|
93426
|
-
* Gets the next paragraph. If the paragraph is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
94192
|
+
* Gets the next paragraph. If the paragraph is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
93427
94193
|
*
|
|
93428
94194
|
* @remarks
|
|
93429
94195
|
* [Api set: WordApi 1.3]
|
|
@@ -93444,7 +94210,7 @@ declare namespace Word {
|
|
|
93444
94210
|
*/
|
|
93445
94211
|
getPrevious(): Word.Paragraph;
|
|
93446
94212
|
/**
|
|
93447
|
-
* Gets the previous paragraph. If the paragraph is the first one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
94213
|
+
* Gets the previous paragraph. If the paragraph is the first one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
93448
94214
|
*
|
|
93449
94215
|
* @remarks
|
|
93450
94216
|
* [Api set: WordApi 1.3]
|
|
@@ -93487,6 +94253,25 @@ declare namespace Word {
|
|
|
93487
94253
|
* @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection.
|
|
93488
94254
|
*/
|
|
93489
94255
|
getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection;
|
|
94256
|
+
/**
|
|
94257
|
+
* Gets the collection of the TrackedChange objects in the paragraph.
|
|
94258
|
+
*
|
|
94259
|
+
* @remarks
|
|
94260
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
94261
|
+
* @beta
|
|
94262
|
+
*/
|
|
94263
|
+
getTrackedChanges(): Word.TrackedChangeCollection;
|
|
94264
|
+
/**
|
|
94265
|
+
* Inserts annotations on this Paragraph object.
|
|
94266
|
+
*
|
|
94267
|
+
* @remarks
|
|
94268
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
94269
|
+
* @beta
|
|
94270
|
+
*
|
|
94271
|
+
* @param annotations Annotations to set.
|
|
94272
|
+
* @returns An array of the inserted annotations identifiers.
|
|
94273
|
+
*/
|
|
94274
|
+
insertAnnotations(annotations: Word.AnnotationSet): OfficeExtension.ClientResult<string[]>;
|
|
93490
94275
|
/**
|
|
93491
94276
|
* Inserts a break at the specified location in the main document.
|
|
93492
94277
|
*
|
|
@@ -93706,11 +94491,11 @@ declare namespace Word {
|
|
|
93706
94491
|
*/
|
|
93707
94492
|
readonly onCommentSelected: OfficeExtension.EventHandlers<Word.CommentEventArgs>;
|
|
93708
94493
|
/**
|
|
93709
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
94494
|
+
* 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.
|
|
93710
94495
|
*/
|
|
93711
94496
|
track(): Word.Paragraph;
|
|
93712
94497
|
/**
|
|
93713
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
94498
|
+
* 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.
|
|
93714
94499
|
*/
|
|
93715
94500
|
untrack(): Word.Paragraph;
|
|
93716
94501
|
/**
|
|
@@ -93738,7 +94523,7 @@ declare namespace Word {
|
|
|
93738
94523
|
*/
|
|
93739
94524
|
getFirst(): Word.Paragraph;
|
|
93740
94525
|
/**
|
|
93741
|
-
* Gets the first paragraph in this collection. If the collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
94526
|
+
* Gets the first paragraph in this collection. If the collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
93742
94527
|
*
|
|
93743
94528
|
* @remarks
|
|
93744
94529
|
* [Api set: WordApi 1.3]
|
|
@@ -93752,7 +94537,7 @@ declare namespace Word {
|
|
|
93752
94537
|
*/
|
|
93753
94538
|
getLast(): Word.Paragraph;
|
|
93754
94539
|
/**
|
|
93755
|
-
* Gets the last paragraph in this collection. If the collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
94540
|
+
* Gets the last paragraph in this collection. If the collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
93756
94541
|
*
|
|
93757
94542
|
* @remarks
|
|
93758
94543
|
* [Api set: WordApi 1.3]
|
|
@@ -93777,11 +94562,11 @@ declare namespace Word {
|
|
|
93777
94562
|
*/
|
|
93778
94563
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ParagraphCollection;
|
|
93779
94564
|
/**
|
|
93780
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
94565
|
+
* 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.
|
|
93781
94566
|
*/
|
|
93782
94567
|
track(): Word.ParagraphCollection;
|
|
93783
94568
|
/**
|
|
93784
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
94569
|
+
* 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.
|
|
93785
94570
|
*/
|
|
93786
94571
|
untrack(): Word.ParagraphCollection;
|
|
93787
94572
|
/**
|
|
@@ -93927,11 +94712,11 @@ declare namespace Word {
|
|
|
93927
94712
|
expand?: string;
|
|
93928
94713
|
}): Word.ParagraphFormat;
|
|
93929
94714
|
/**
|
|
93930
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
94715
|
+
* 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.
|
|
93931
94716
|
*/
|
|
93932
94717
|
track(): Word.ParagraphFormat;
|
|
93933
94718
|
/**
|
|
93934
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
94719
|
+
* 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.
|
|
93935
94720
|
*/
|
|
93936
94721
|
untrack(): Word.ParagraphFormat;
|
|
93937
94722
|
/**
|
|
@@ -94020,7 +94805,7 @@ declare namespace Word {
|
|
|
94020
94805
|
*/
|
|
94021
94806
|
readonly parentContentControl: Word.ContentControl;
|
|
94022
94807
|
/**
|
|
94023
|
-
* Gets the content control that contains the range. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
94808
|
+
* Gets the content control that contains the range. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
94024
94809
|
*
|
|
94025
94810
|
* @remarks
|
|
94026
94811
|
* [Api set: WordApi 1.3]
|
|
@@ -94041,14 +94826,14 @@ declare namespace Word {
|
|
|
94041
94826
|
*/
|
|
94042
94827
|
readonly parentTableCell: Word.TableCell;
|
|
94043
94828
|
/**
|
|
94044
|
-
* Gets the table cell that contains the range. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
94829
|
+
* Gets the table cell that contains the range. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
94045
94830
|
*
|
|
94046
94831
|
* @remarks
|
|
94047
94832
|
* [Api set: WordApi 1.3]
|
|
94048
94833
|
*/
|
|
94049
94834
|
readonly parentTableCellOrNullObject: Word.TableCell;
|
|
94050
94835
|
/**
|
|
94051
|
-
* Gets the table that contains the range. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
94836
|
+
* Gets the table that contains the range. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
94052
94837
|
*
|
|
94053
94838
|
* @remarks
|
|
94054
94839
|
* [Api set: WordApi 1.3]
|
|
@@ -94137,7 +94922,7 @@ declare namespace Word {
|
|
|
94137
94922
|
*/
|
|
94138
94923
|
expandTo(range: Word.Range): Word.Range;
|
|
94139
94924
|
/**
|
|
94140
|
-
* Returns a new range that extends from this range in either direction to cover another range. This range is not changed. If the two ranges do not have a union, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
94925
|
+
* Returns a new range that extends from this range in either direction to cover another range. This range is not changed. If the two ranges do not have a union, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
94141
94926
|
*
|
|
94142
94927
|
* @remarks
|
|
94143
94928
|
* [Api set: WordApi 1.3]
|
|
@@ -94199,7 +94984,7 @@ declare namespace Word {
|
|
|
94199
94984
|
*/
|
|
94200
94985
|
getNextTextRange(endingMarks: string[], trimSpacing?: boolean): Word.Range;
|
|
94201
94986
|
/**
|
|
94202
|
-
* Gets the next text range by using punctuation marks and/or other ending marks. If this text range is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
94987
|
+
* Gets the next text range by using punctuation marks and/or other ending marks. If this text range is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
94203
94988
|
*
|
|
94204
94989
|
* @remarks
|
|
94205
94990
|
* [Api set: WordApi 1.3]
|
|
@@ -94252,6 +95037,14 @@ declare namespace Word {
|
|
|
94252
95037
|
* @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection.
|
|
94253
95038
|
*/
|
|
94254
95039
|
getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection;
|
|
95040
|
+
/**
|
|
95041
|
+
* Gets the collection of the TrackedChange objects in the range.
|
|
95042
|
+
*
|
|
95043
|
+
* @remarks
|
|
95044
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
95045
|
+
* @beta
|
|
95046
|
+
*/
|
|
95047
|
+
getTrackedChanges(): Word.TrackedChangeCollection;
|
|
94255
95048
|
/**
|
|
94256
95049
|
* Inserts a bookmark on the range. If a bookmark of the same name exists somewhere, it is deleted first.
|
|
94257
95050
|
*
|
|
@@ -94416,7 +95209,7 @@ declare namespace Word {
|
|
|
94416
95209
|
*/
|
|
94417
95210
|
intersectWith(range: Word.Range): Word.Range;
|
|
94418
95211
|
/**
|
|
94419
|
-
* Returns a new range as the intersection of this range with another range. This range is not changed. If the two ranges are not overlapped or adjacent, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
95212
|
+
* Returns a new range as the intersection of this range with another range. This range is not changed. If the two ranges are not overlapped or adjacent, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
94420
95213
|
*
|
|
94421
95214
|
* @remarks
|
|
94422
95215
|
* [Api set: WordApi 1.3]
|
|
@@ -94534,11 +95327,11 @@ declare namespace Word {
|
|
|
94534
95327
|
*/
|
|
94535
95328
|
readonly onCommentSelected: OfficeExtension.EventHandlers<Word.CommentEventArgs>;
|
|
94536
95329
|
/**
|
|
94537
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
95330
|
+
* 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.
|
|
94538
95331
|
*/
|
|
94539
95332
|
track(): Word.Range;
|
|
94540
95333
|
/**
|
|
94541
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
95334
|
+
* 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.
|
|
94542
95335
|
*/
|
|
94543
95336
|
untrack(): Word.Range;
|
|
94544
95337
|
/**
|
|
@@ -94566,7 +95359,7 @@ declare namespace Word {
|
|
|
94566
95359
|
*/
|
|
94567
95360
|
getFirst(): Word.Range;
|
|
94568
95361
|
/**
|
|
94569
|
-
* Gets the first range 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://
|
|
95362
|
+
* Gets the first range in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
94570
95363
|
*
|
|
94571
95364
|
* @remarks
|
|
94572
95365
|
* [Api set: WordApi 1.3]
|
|
@@ -94591,11 +95384,11 @@ declare namespace Word {
|
|
|
94591
95384
|
*/
|
|
94592
95385
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.RangeCollection;
|
|
94593
95386
|
/**
|
|
94594
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
95387
|
+
* 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.
|
|
94595
95388
|
*/
|
|
94596
95389
|
track(): Word.RangeCollection;
|
|
94597
95390
|
/**
|
|
94598
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
95391
|
+
* 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.
|
|
94599
95392
|
*/
|
|
94600
95393
|
untrack(): Word.RangeCollection;
|
|
94601
95394
|
/**
|
|
@@ -94665,7 +95458,7 @@ declare namespace Word {
|
|
|
94665
95458
|
}
|
|
94666
95459
|
/**
|
|
94667
95460
|
* Specifies the options to be included in a search operation.
|
|
94668
|
-
To learn more about how to use search options in the Word JavaScript APIs, read {@link https://
|
|
95461
|
+
To learn more about how to use search options in the Word JavaScript APIs, read {@link https://learn.microsoft.com/office/dev/add-ins/word/search-option-guidance | Use search options to find text in your Word add-in}.
|
|
94669
95462
|
*
|
|
94670
95463
|
* @remarks
|
|
94671
95464
|
* [Api set: WordApi 1.1]
|
|
@@ -94829,7 +95622,7 @@ declare namespace Word {
|
|
|
94829
95622
|
*/
|
|
94830
95623
|
getNext(): Word.Section;
|
|
94831
95624
|
/**
|
|
94832
|
-
* Gets the next section. If this section is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
95625
|
+
* Gets the next section. If this section is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
94833
95626
|
*
|
|
94834
95627
|
* @remarks
|
|
94835
95628
|
* [Api set: WordApi 1.3]
|
|
@@ -94857,11 +95650,11 @@ declare namespace Word {
|
|
|
94857
95650
|
expand?: string;
|
|
94858
95651
|
}): Word.Section;
|
|
94859
95652
|
/**
|
|
94860
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
95653
|
+
* 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.
|
|
94861
95654
|
*/
|
|
94862
95655
|
track(): Word.Section;
|
|
94863
95656
|
/**
|
|
94864
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
95657
|
+
* 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.
|
|
94865
95658
|
*/
|
|
94866
95659
|
untrack(): Word.Section;
|
|
94867
95660
|
/**
|
|
@@ -94889,7 +95682,7 @@ declare namespace Word {
|
|
|
94889
95682
|
*/
|
|
94890
95683
|
getFirst(): Word.Section;
|
|
94891
95684
|
/**
|
|
94892
|
-
* Gets the first section 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://
|
|
95685
|
+
* Gets the first section in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
94893
95686
|
*
|
|
94894
95687
|
* @remarks
|
|
94895
95688
|
* [Api set: WordApi 1.3]
|
|
@@ -94914,11 +95707,11 @@ declare namespace Word {
|
|
|
94914
95707
|
*/
|
|
94915
95708
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.SectionCollection;
|
|
94916
95709
|
/**
|
|
94917
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
95710
|
+
* 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.
|
|
94918
95711
|
*/
|
|
94919
95712
|
track(): Word.SectionCollection;
|
|
94920
95713
|
/**
|
|
94921
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
95714
|
+
* 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.
|
|
94922
95715
|
*/
|
|
94923
95716
|
untrack(): Word.SectionCollection;
|
|
94924
95717
|
/**
|
|
@@ -94987,11 +95780,11 @@ declare namespace Word {
|
|
|
94987
95780
|
expand?: string;
|
|
94988
95781
|
}): Word.Setting;
|
|
94989
95782
|
/**
|
|
94990
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
95783
|
+
* 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.
|
|
94991
95784
|
*/
|
|
94992
95785
|
track(): Word.Setting;
|
|
94993
95786
|
/**
|
|
94994
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
95787
|
+
* 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.
|
|
94995
95788
|
*/
|
|
94996
95789
|
untrack(): Word.Setting;
|
|
94997
95790
|
/**
|
|
@@ -95045,7 +95838,7 @@ declare namespace Word {
|
|
|
95045
95838
|
*/
|
|
95046
95839
|
getItem(key: string): Word.Setting;
|
|
95047
95840
|
/**
|
|
95048
|
-
* Gets a setting object by its key, which is case-sensitive. If the setting does not exist, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
95841
|
+
* Gets a setting object by its key, which is case-sensitive. If the setting does not exist, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
95049
95842
|
*
|
|
95050
95843
|
* @remarks
|
|
95051
95844
|
* [Api set: WordApi 1.4]
|
|
@@ -95072,11 +95865,11 @@ declare namespace Word {
|
|
|
95072
95865
|
*/
|
|
95073
95866
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.SettingCollection;
|
|
95074
95867
|
/**
|
|
95075
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
95868
|
+
* 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.
|
|
95076
95869
|
*/
|
|
95077
95870
|
track(): Word.SettingCollection;
|
|
95078
95871
|
/**
|
|
95079
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
95872
|
+
* 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.
|
|
95080
95873
|
*/
|
|
95081
95874
|
untrack(): Word.SettingCollection;
|
|
95082
95875
|
/**
|
|
@@ -95149,11 +95942,11 @@ declare namespace Word {
|
|
|
95149
95942
|
*/
|
|
95150
95943
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.StyleCollection;
|
|
95151
95944
|
/**
|
|
95152
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
95945
|
+
* 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.
|
|
95153
95946
|
*/
|
|
95154
95947
|
track(): Word.StyleCollection;
|
|
95155
95948
|
/**
|
|
95156
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
95949
|
+
* 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.
|
|
95157
95950
|
*/
|
|
95158
95951
|
untrack(): Word.StyleCollection;
|
|
95159
95952
|
/**
|
|
@@ -95171,6 +95964,14 @@ declare namespace Word {
|
|
|
95171
95964
|
class Style extends OfficeExtension.ClientObject {
|
|
95172
95965
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
95173
95966
|
context: RequestContext;
|
|
95967
|
+
/**
|
|
95968
|
+
* Specifies a BorderCollection object that represents all the borders for the specified style.
|
|
95969
|
+
*
|
|
95970
|
+
* @remarks
|
|
95971
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
95972
|
+
* @beta
|
|
95973
|
+
*/
|
|
95974
|
+
readonly borders: Word.BorderCollection;
|
|
95174
95975
|
/**
|
|
95175
95976
|
* Gets a font object that represents the character formatting of the specified style.
|
|
95176
95977
|
*
|
|
@@ -95331,11 +96132,11 @@ declare namespace Word {
|
|
|
95331
96132
|
expand?: string;
|
|
95332
96133
|
}): Word.Style;
|
|
95333
96134
|
/**
|
|
95334
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
96135
|
+
* 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.
|
|
95335
96136
|
*/
|
|
95336
96137
|
track(): Word.Style;
|
|
95337
96138
|
/**
|
|
95338
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
96139
|
+
* 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.
|
|
95339
96140
|
*/
|
|
95340
96141
|
untrack(): Word.Style;
|
|
95341
96142
|
/**
|
|
@@ -95473,7 +96274,7 @@ declare namespace Word {
|
|
|
95473
96274
|
*/
|
|
95474
96275
|
readonly parentContentControl: Word.ContentControl;
|
|
95475
96276
|
/**
|
|
95476
|
-
* Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
96277
|
+
* Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
95477
96278
|
*
|
|
95478
96279
|
* @remarks
|
|
95479
96280
|
* [Api set: WordApi 1.3]
|
|
@@ -95494,14 +96295,14 @@ declare namespace Word {
|
|
|
95494
96295
|
*/
|
|
95495
96296
|
readonly parentTableCell: Word.TableCell;
|
|
95496
96297
|
/**
|
|
95497
|
-
* Gets the table cell that contains this table. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
96298
|
+
* Gets the table cell that contains this table. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
95498
96299
|
*
|
|
95499
96300
|
* @remarks
|
|
95500
96301
|
* [Api set: WordApi 1.3]
|
|
95501
96302
|
*/
|
|
95502
96303
|
readonly parentTableCellOrNullObject: Word.TableCell;
|
|
95503
96304
|
/**
|
|
95504
|
-
* Gets the table that contains this table. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
96305
|
+
* Gets the table that contains this table. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
95505
96306
|
*
|
|
95506
96307
|
* @remarks
|
|
95507
96308
|
* [Api set: WordApi 1.3]
|
|
@@ -95747,7 +96548,7 @@ declare namespace Word {
|
|
|
95747
96548
|
*/
|
|
95748
96549
|
getCell(rowIndex: number, cellIndex: number): Word.TableCell;
|
|
95749
96550
|
/**
|
|
95750
|
-
* Gets the table cell at a specified row and column. If the specified table cell does not exist, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
96551
|
+
* Gets the table cell at a specified row and column. If the specified table cell does not exist, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
95751
96552
|
*
|
|
95752
96553
|
* @remarks
|
|
95753
96554
|
* [Api set: WordApi 1.3]
|
|
@@ -95782,7 +96583,7 @@ declare namespace Word {
|
|
|
95782
96583
|
*/
|
|
95783
96584
|
getNext(): Word.Table;
|
|
95784
96585
|
/**
|
|
95785
|
-
* Gets the next table. If this table is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
96586
|
+
* Gets the next table. If this table is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
95786
96587
|
*
|
|
95787
96588
|
* @remarks
|
|
95788
96589
|
* [Api set: WordApi 1.3]
|
|
@@ -95796,7 +96597,7 @@ declare namespace Word {
|
|
|
95796
96597
|
*/
|
|
95797
96598
|
getParagraphAfter(): Word.Paragraph;
|
|
95798
96599
|
/**
|
|
95799
|
-
* Gets the paragraph after the table. If there isn't a paragraph after the table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
96600
|
+
* Gets the paragraph after the table. If there isn't a paragraph after the table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
95800
96601
|
*
|
|
95801
96602
|
* @remarks
|
|
95802
96603
|
* [Api set: WordApi 1.3]
|
|
@@ -95810,7 +96611,7 @@ declare namespace Word {
|
|
|
95810
96611
|
*/
|
|
95811
96612
|
getParagraphBefore(): Word.Paragraph;
|
|
95812
96613
|
/**
|
|
95813
|
-
* Gets the paragraph before the table. If there isn't a paragraph before the table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
96614
|
+
* Gets the paragraph before the table. If there isn't a paragraph before the table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
95814
96615
|
*
|
|
95815
96616
|
* @remarks
|
|
95816
96617
|
* [Api set: WordApi 1.3]
|
|
@@ -95944,11 +96745,11 @@ declare namespace Word {
|
|
|
95944
96745
|
expand?: string;
|
|
95945
96746
|
}): Word.Table;
|
|
95946
96747
|
/**
|
|
95947
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
96748
|
+
* 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.
|
|
95948
96749
|
*/
|
|
95949
96750
|
track(): Word.Table;
|
|
95950
96751
|
/**
|
|
95951
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
96752
|
+
* 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.
|
|
95952
96753
|
*/
|
|
95953
96754
|
untrack(): Word.Table;
|
|
95954
96755
|
/**
|
|
@@ -96085,7 +96886,7 @@ declare namespace Word {
|
|
|
96085
96886
|
*/
|
|
96086
96887
|
getFirst(): Word.Table;
|
|
96087
96888
|
/**
|
|
96088
|
-
* 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://
|
|
96889
|
+
* 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://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
96089
96890
|
*
|
|
96090
96891
|
* @remarks
|
|
96091
96892
|
* [Api set: WordApi 1.3]
|
|
@@ -96110,11 +96911,11 @@ declare namespace Word {
|
|
|
96110
96911
|
*/
|
|
96111
96912
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableCollection;
|
|
96112
96913
|
/**
|
|
96113
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
96914
|
+
* 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.
|
|
96114
96915
|
*/
|
|
96115
96916
|
track(): Word.TableCollection;
|
|
96116
96917
|
/**
|
|
96117
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
96918
|
+
* 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.
|
|
96118
96919
|
*/
|
|
96119
96920
|
untrack(): Word.TableCollection;
|
|
96120
96921
|
/**
|
|
@@ -96296,7 +97097,7 @@ declare namespace Word {
|
|
|
96296
97097
|
*/
|
|
96297
97098
|
getNext(): Word.TableRow;
|
|
96298
97099
|
/**
|
|
96299
|
-
* Gets the next row. If this row is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
97100
|
+
* Gets the next row. If this row is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
96300
97101
|
*
|
|
96301
97102
|
* @remarks
|
|
96302
97103
|
* [Api set: WordApi 1.3]
|
|
@@ -96406,11 +97207,11 @@ declare namespace Word {
|
|
|
96406
97207
|
expand?: string;
|
|
96407
97208
|
}): Word.TableRow;
|
|
96408
97209
|
/**
|
|
96409
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
97210
|
+
* 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.
|
|
96410
97211
|
*/
|
|
96411
97212
|
track(): Word.TableRow;
|
|
96412
97213
|
/**
|
|
96413
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
97214
|
+
* 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.
|
|
96414
97215
|
*/
|
|
96415
97216
|
untrack(): Word.TableRow;
|
|
96416
97217
|
/**
|
|
@@ -96438,7 +97239,7 @@ declare namespace Word {
|
|
|
96438
97239
|
*/
|
|
96439
97240
|
getFirst(): Word.TableRow;
|
|
96440
97241
|
/**
|
|
96441
|
-
* Gets the first row 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://
|
|
97242
|
+
* Gets the first row in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
96442
97243
|
*
|
|
96443
97244
|
* @remarks
|
|
96444
97245
|
* [Api set: WordApi 1.3]
|
|
@@ -96463,11 +97264,11 @@ declare namespace Word {
|
|
|
96463
97264
|
*/
|
|
96464
97265
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableRowCollection;
|
|
96465
97266
|
/**
|
|
96466
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
97267
|
+
* 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.
|
|
96467
97268
|
*/
|
|
96468
97269
|
track(): Word.TableRowCollection;
|
|
96469
97270
|
/**
|
|
96470
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
97271
|
+
* 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.
|
|
96471
97272
|
*/
|
|
96472
97273
|
untrack(): Word.TableRowCollection;
|
|
96473
97274
|
/**
|
|
@@ -96628,7 +97429,7 @@ declare namespace Word {
|
|
|
96628
97429
|
*/
|
|
96629
97430
|
getNext(): Word.TableCell;
|
|
96630
97431
|
/**
|
|
96631
|
-
* Gets the next cell. If this cell is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
97432
|
+
* Gets the next cell. If this cell is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
96632
97433
|
*
|
|
96633
97434
|
* @remarks
|
|
96634
97435
|
* [Api set: WordApi 1.3]
|
|
@@ -96708,11 +97509,11 @@ declare namespace Word {
|
|
|
96708
97509
|
expand?: string;
|
|
96709
97510
|
}): Word.TableCell;
|
|
96710
97511
|
/**
|
|
96711
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
97512
|
+
* 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.
|
|
96712
97513
|
*/
|
|
96713
97514
|
track(): Word.TableCell;
|
|
96714
97515
|
/**
|
|
96715
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
97516
|
+
* 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.
|
|
96716
97517
|
*/
|
|
96717
97518
|
untrack(): Word.TableCell;
|
|
96718
97519
|
/**
|
|
@@ -96740,7 +97541,7 @@ declare namespace Word {
|
|
|
96740
97541
|
*/
|
|
96741
97542
|
getFirst(): Word.TableCell;
|
|
96742
97543
|
/**
|
|
96743
|
-
* Gets the first table cell 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://
|
|
97544
|
+
* Gets the first table cell in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
96744
97545
|
*
|
|
96745
97546
|
* @remarks
|
|
96746
97547
|
* [Api set: WordApi 1.3]
|
|
@@ -96765,11 +97566,11 @@ declare namespace Word {
|
|
|
96765
97566
|
*/
|
|
96766
97567
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableCellCollection;
|
|
96767
97568
|
/**
|
|
96768
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
97569
|
+
* 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.
|
|
96769
97570
|
*/
|
|
96770
97571
|
track(): Word.TableCellCollection;
|
|
96771
97572
|
/**
|
|
96772
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
97573
|
+
* 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.
|
|
96773
97574
|
*/
|
|
96774
97575
|
untrack(): Word.TableCellCollection;
|
|
96775
97576
|
/**
|
|
@@ -96838,11 +97639,11 @@ declare namespace Word {
|
|
|
96838
97639
|
expand?: string;
|
|
96839
97640
|
}): Word.TableBorder;
|
|
96840
97641
|
/**
|
|
96841
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://
|
|
97642
|
+
* 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.
|
|
96842
97643
|
*/
|
|
96843
97644
|
track(): Word.TableBorder;
|
|
96844
97645
|
/**
|
|
96845
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://
|
|
97646
|
+
* 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.
|
|
96846
97647
|
*/
|
|
96847
97648
|
untrack(): Word.TableBorder;
|
|
96848
97649
|
/**
|
|
@@ -96851,6 +97652,217 @@ declare namespace Word {
|
|
|
96851
97652
|
*/
|
|
96852
97653
|
toJSON(): Word.Interfaces.TableBorderData;
|
|
96853
97654
|
}
|
|
97655
|
+
/**
|
|
97656
|
+
* Represents a tracked change in a Word document.
|
|
97657
|
+
*
|
|
97658
|
+
* @remarks
|
|
97659
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97660
|
+
* @beta
|
|
97661
|
+
*/
|
|
97662
|
+
class TrackedChange extends OfficeExtension.ClientObject {
|
|
97663
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
97664
|
+
context: RequestContext;
|
|
97665
|
+
/**
|
|
97666
|
+
* Specifies the author of the tracked change.
|
|
97667
|
+
*
|
|
97668
|
+
* @remarks
|
|
97669
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97670
|
+
* @beta
|
|
97671
|
+
*/
|
|
97672
|
+
readonly author: string;
|
|
97673
|
+
/**
|
|
97674
|
+
* Specifies the date of the tracked change.
|
|
97675
|
+
*
|
|
97676
|
+
* @remarks
|
|
97677
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97678
|
+
* @beta
|
|
97679
|
+
*/
|
|
97680
|
+
readonly date: Date;
|
|
97681
|
+
/**
|
|
97682
|
+
* Specifies the text of the tracked change.
|
|
97683
|
+
*
|
|
97684
|
+
* @remarks
|
|
97685
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97686
|
+
* @beta
|
|
97687
|
+
*/
|
|
97688
|
+
readonly text: string;
|
|
97689
|
+
/**
|
|
97690
|
+
* Specifies the type of the tracked change.
|
|
97691
|
+
*
|
|
97692
|
+
* @remarks
|
|
97693
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97694
|
+
* @beta
|
|
97695
|
+
*/
|
|
97696
|
+
readonly type: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted";
|
|
97697
|
+
/**
|
|
97698
|
+
* Accepts the tracked change.
|
|
97699
|
+
*
|
|
97700
|
+
* @remarks
|
|
97701
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97702
|
+
* @beta
|
|
97703
|
+
*/
|
|
97704
|
+
accept(): void;
|
|
97705
|
+
/**
|
|
97706
|
+
* Gets the next tracked change. Throws an `ItemNotFound` error if this tracked change is the last one.
|
|
97707
|
+
*
|
|
97708
|
+
* @remarks
|
|
97709
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97710
|
+
* @beta
|
|
97711
|
+
*/
|
|
97712
|
+
getNext(): Word.TrackedChange;
|
|
97713
|
+
/**
|
|
97714
|
+
* Gets the next tracked change. If this tracked change is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
97715
|
+
*
|
|
97716
|
+
* @remarks
|
|
97717
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97718
|
+
* @beta
|
|
97719
|
+
*/
|
|
97720
|
+
getNextOrNullObject(): Word.TrackedChange;
|
|
97721
|
+
/**
|
|
97722
|
+
* Gets the range of the tracked change.
|
|
97723
|
+
*
|
|
97724
|
+
* @remarks
|
|
97725
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97726
|
+
* @beta
|
|
97727
|
+
*/
|
|
97728
|
+
getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range;
|
|
97729
|
+
/**
|
|
97730
|
+
* Rejects the tracked change.
|
|
97731
|
+
*
|
|
97732
|
+
* @remarks
|
|
97733
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97734
|
+
* @beta
|
|
97735
|
+
*/
|
|
97736
|
+
reject(): void;
|
|
97737
|
+
/**
|
|
97738
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97739
|
+
*
|
|
97740
|
+
* @param options Provides options for which properties of the object to load.
|
|
97741
|
+
*/
|
|
97742
|
+
load(options?: Word.Interfaces.TrackedChangeLoadOptions): Word.TrackedChange;
|
|
97743
|
+
/**
|
|
97744
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97745
|
+
*
|
|
97746
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
97747
|
+
*/
|
|
97748
|
+
load(propertyNames?: string | string[]): Word.TrackedChange;
|
|
97749
|
+
/**
|
|
97750
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97751
|
+
*
|
|
97752
|
+
* @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.
|
|
97753
|
+
*/
|
|
97754
|
+
load(propertyNamesAndPaths?: {
|
|
97755
|
+
select?: string;
|
|
97756
|
+
expand?: string;
|
|
97757
|
+
}): Word.TrackedChange;
|
|
97758
|
+
/**
|
|
97759
|
+
* 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.
|
|
97760
|
+
*/
|
|
97761
|
+
track(): Word.TrackedChange;
|
|
97762
|
+
/**
|
|
97763
|
+
* 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.
|
|
97764
|
+
*/
|
|
97765
|
+
untrack(): Word.TrackedChange;
|
|
97766
|
+
/**
|
|
97767
|
+
* 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.)
|
|
97768
|
+
* Whereas the original Word.TrackedChange object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeData`) that contains shallow copies of any loaded child properties from the original object.
|
|
97769
|
+
*/
|
|
97770
|
+
toJSON(): Word.Interfaces.TrackedChangeData;
|
|
97771
|
+
}
|
|
97772
|
+
/**
|
|
97773
|
+
* Contains a collection of {@link Word.TrackedChange} objects.
|
|
97774
|
+
*
|
|
97775
|
+
* @remarks
|
|
97776
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97777
|
+
* @beta
|
|
97778
|
+
*/
|
|
97779
|
+
class TrackedChangeCollection extends OfficeExtension.ClientObject {
|
|
97780
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
97781
|
+
context: RequestContext;
|
|
97782
|
+
/** Gets the loaded child items in this collection. */
|
|
97783
|
+
readonly items: Word.TrackedChange[];
|
|
97784
|
+
/**
|
|
97785
|
+
* Accepts all the tracked changes in the collection.
|
|
97786
|
+
*
|
|
97787
|
+
* @remarks
|
|
97788
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97789
|
+
* @beta
|
|
97790
|
+
*/
|
|
97791
|
+
acceptAll(): void;
|
|
97792
|
+
/**
|
|
97793
|
+
* Gets the number of TrackedChange objects in the collection.
|
|
97794
|
+
*
|
|
97795
|
+
* @remarks
|
|
97796
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97797
|
+
* @beta
|
|
97798
|
+
*/
|
|
97799
|
+
getCount(): OfficeExtension.ClientResult<number>;
|
|
97800
|
+
/**
|
|
97801
|
+
* Gets the first TrackedChange in this collection. Throws an `ItemNotFound` error if this collection is empty.
|
|
97802
|
+
*
|
|
97803
|
+
* @remarks
|
|
97804
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97805
|
+
* @beta
|
|
97806
|
+
*/
|
|
97807
|
+
getFirst(): Word.TrackedChange;
|
|
97808
|
+
/**
|
|
97809
|
+
* Gets the first TrackedChange in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
97810
|
+
*
|
|
97811
|
+
* @remarks
|
|
97812
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97813
|
+
* @beta
|
|
97814
|
+
*/
|
|
97815
|
+
getFirstOrNullObject(): Word.TrackedChange;
|
|
97816
|
+
/**
|
|
97817
|
+
* Gets a TrackedChange object by its index in the collection.
|
|
97818
|
+
*
|
|
97819
|
+
* @remarks
|
|
97820
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97821
|
+
* @beta
|
|
97822
|
+
*
|
|
97823
|
+
* @param index A number that identifies the index location of a TrackedChange object.
|
|
97824
|
+
*/
|
|
97825
|
+
getItem(index: number): Word.TrackedChange;
|
|
97826
|
+
/**
|
|
97827
|
+
* Rejects all the tracked changes in the collection.
|
|
97828
|
+
*
|
|
97829
|
+
* @remarks
|
|
97830
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97831
|
+
* @beta
|
|
97832
|
+
*/
|
|
97833
|
+
rejectAll(): void;
|
|
97834
|
+
/**
|
|
97835
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97836
|
+
*
|
|
97837
|
+
* @param options Provides options for which properties of the object to load.
|
|
97838
|
+
*/
|
|
97839
|
+
load(options?: Word.Interfaces.TrackedChangeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TrackedChangeCollection;
|
|
97840
|
+
/**
|
|
97841
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97842
|
+
*
|
|
97843
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
97844
|
+
*/
|
|
97845
|
+
load(propertyNames?: string | string[]): Word.TrackedChangeCollection;
|
|
97846
|
+
/**
|
|
97847
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97848
|
+
*
|
|
97849
|
+
* @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.
|
|
97850
|
+
*/
|
|
97851
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TrackedChangeCollection;
|
|
97852
|
+
/**
|
|
97853
|
+
* 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.
|
|
97854
|
+
*/
|
|
97855
|
+
track(): Word.TrackedChangeCollection;
|
|
97856
|
+
/**
|
|
97857
|
+
* 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.
|
|
97858
|
+
*/
|
|
97859
|
+
untrack(): Word.TrackedChangeCollection;
|
|
97860
|
+
/**
|
|
97861
|
+
* 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.)
|
|
97862
|
+
* Whereas the original `Word.TrackedChangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
97863
|
+
*/
|
|
97864
|
+
toJSON(): Word.Interfaces.TrackedChangeCollectionData;
|
|
97865
|
+
}
|
|
96854
97866
|
/**
|
|
96855
97867
|
* ChangeTracking mode.
|
|
96856
97868
|
*
|
|
@@ -96923,6 +97935,43 @@ declare namespace Word {
|
|
|
96923
97935
|
*/
|
|
96924
97936
|
deleted = "Deleted",
|
|
96925
97937
|
}
|
|
97938
|
+
/**
|
|
97939
|
+
* TrackedChange type.
|
|
97940
|
+
*
|
|
97941
|
+
* @remarks
|
|
97942
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97943
|
+
* @beta
|
|
97944
|
+
*/
|
|
97945
|
+
enum TrackedChangeType {
|
|
97946
|
+
/**
|
|
97947
|
+
* No revision.
|
|
97948
|
+
* @remarks
|
|
97949
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97950
|
+
* @beta
|
|
97951
|
+
*/
|
|
97952
|
+
none = "None",
|
|
97953
|
+
/**
|
|
97954
|
+
* Add change.
|
|
97955
|
+
* @remarks
|
|
97956
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97957
|
+
* @beta
|
|
97958
|
+
*/
|
|
97959
|
+
added = "Added",
|
|
97960
|
+
/**
|
|
97961
|
+
* Delete change.
|
|
97962
|
+
* @remarks
|
|
97963
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97964
|
+
* @beta
|
|
97965
|
+
*/
|
|
97966
|
+
deleted = "Deleted",
|
|
97967
|
+
/**
|
|
97968
|
+
* Format change.
|
|
97969
|
+
* @remarks
|
|
97970
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97971
|
+
* @beta
|
|
97972
|
+
*/
|
|
97973
|
+
formatted = "Formatted",
|
|
97974
|
+
}
|
|
96926
97975
|
/**
|
|
96927
97976
|
* Note item type
|
|
96928
97977
|
*
|
|
@@ -97040,6 +98089,34 @@ declare namespace Word {
|
|
|
97040
98089
|
* @beta
|
|
97041
98090
|
*/
|
|
97042
98091
|
paragraphDeleted = "ParagraphDeleted",
|
|
98092
|
+
/**
|
|
98093
|
+
* Represents that an annotation was clicked (or selected with **Alt+Down**) in the document.
|
|
98094
|
+
* @remarks
|
|
98095
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98096
|
+
* @beta
|
|
98097
|
+
*/
|
|
98098
|
+
annotationClicked = "AnnotationClicked",
|
|
98099
|
+
/**
|
|
98100
|
+
* Represents that an annotation was hovered over in the document.
|
|
98101
|
+
* @remarks
|
|
98102
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98103
|
+
* @beta
|
|
98104
|
+
*/
|
|
98105
|
+
annotationHovered = "AnnotationHovered",
|
|
98106
|
+
/**
|
|
98107
|
+
* Represents that one or more annotations were added in the document.
|
|
98108
|
+
* @remarks
|
|
98109
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98110
|
+
* @beta
|
|
98111
|
+
*/
|
|
98112
|
+
annotationInserted = "AnnotationInserted",
|
|
98113
|
+
/**
|
|
98114
|
+
* Represents that one or more annotations were deleted from the document.
|
|
98115
|
+
* @remarks
|
|
98116
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
98117
|
+
* @beta
|
|
98118
|
+
*/
|
|
98119
|
+
annotationRemoved = "AnnotationRemoved",
|
|
97043
98120
|
}
|
|
97044
98121
|
/**
|
|
97045
98122
|
* An enum that specifies an event's source. It can be local or remote (through coauthoring).
|
|
@@ -97082,7 +98159,7 @@ declare namespace Word {
|
|
|
97082
98159
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97083
98160
|
* @beta
|
|
97084
98161
|
*/
|
|
97085
|
-
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
98162
|
+
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
|
|
97086
98163
|
/**
|
|
97087
98164
|
* Gets the content control IDs.
|
|
97088
98165
|
*
|
|
@@ -97113,7 +98190,7 @@ declare namespace Word {
|
|
|
97113
98190
|
* @remarks
|
|
97114
98191
|
* [Api set: WordApi 1.5]
|
|
97115
98192
|
*/
|
|
97116
|
-
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
98193
|
+
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
|
|
97117
98194
|
/**
|
|
97118
98195
|
* Gets the content control IDs.
|
|
97119
98196
|
*
|
|
@@ -97142,7 +98219,7 @@ declare namespace Word {
|
|
|
97142
98219
|
* @remarks
|
|
97143
98220
|
* [Api set: WordApi 1.5]
|
|
97144
98221
|
*/
|
|
97145
|
-
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
98222
|
+
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
|
|
97146
98223
|
/**
|
|
97147
98224
|
* Gets the content control IDs.
|
|
97148
98225
|
*
|
|
@@ -97171,7 +98248,7 @@ declare namespace Word {
|
|
|
97171
98248
|
* @remarks
|
|
97172
98249
|
* [Api set: WordApi 1.5]
|
|
97173
98250
|
*/
|
|
97174
|
-
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
98251
|
+
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
|
|
97175
98252
|
/**
|
|
97176
98253
|
* Gets the content control IDs.
|
|
97177
98254
|
*
|
|
@@ -97200,7 +98277,7 @@ declare namespace Word {
|
|
|
97200
98277
|
* @remarks
|
|
97201
98278
|
* [Api set: WordApi 1.5]
|
|
97202
98279
|
*/
|
|
97203
|
-
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
98280
|
+
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
|
|
97204
98281
|
/**
|
|
97205
98282
|
* Gets the content control IDs.
|
|
97206
98283
|
*
|
|
@@ -97229,7 +98306,7 @@ declare namespace Word {
|
|
|
97229
98306
|
* @remarks
|
|
97230
98307
|
* [Api set: WordApi 1.5]
|
|
97231
98308
|
*/
|
|
97232
|
-
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
98309
|
+
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
|
|
97233
98310
|
/**
|
|
97234
98311
|
* Gets the content control IDs.
|
|
97235
98312
|
*
|
|
@@ -97258,7 +98335,7 @@ declare namespace Word {
|
|
|
97258
98335
|
* @remarks
|
|
97259
98336
|
* [Api set: WordApi 1.5]
|
|
97260
98337
|
*/
|
|
97261
|
-
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
98338
|
+
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
|
|
97262
98339
|
/**
|
|
97263
98340
|
* Gets the content control IDs.
|
|
97264
98341
|
*
|
|
@@ -97283,29 +98360,29 @@ declare namespace Word {
|
|
|
97283
98360
|
*/
|
|
97284
98361
|
interface ParagraphAddedEventArgs {
|
|
97285
98362
|
/**
|
|
97286
|
-
*
|
|
98363
|
+
* The source of the event. It can be local or remote (through coauthoring).
|
|
97287
98364
|
*
|
|
97288
98365
|
* @remarks
|
|
97289
98366
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97290
98367
|
* @beta
|
|
97291
98368
|
*/
|
|
97292
|
-
|
|
98369
|
+
source: Word.EventSource | "Local" | "Remote";
|
|
97293
98370
|
/**
|
|
97294
|
-
* The
|
|
98371
|
+
* The event type. See Word.EventType for details.
|
|
97295
98372
|
*
|
|
97296
98373
|
* @remarks
|
|
97297
98374
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97298
98375
|
* @beta
|
|
97299
98376
|
*/
|
|
97300
|
-
|
|
98377
|
+
type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
|
|
97301
98378
|
/**
|
|
97302
|
-
*
|
|
98379
|
+
* Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors.
|
|
97303
98380
|
*
|
|
97304
98381
|
* @remarks
|
|
97305
98382
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97306
98383
|
* @beta
|
|
97307
98384
|
*/
|
|
97308
|
-
|
|
98385
|
+
uniqueLocalIds: string[];
|
|
97309
98386
|
}
|
|
97310
98387
|
/**
|
|
97311
98388
|
* Provides information about the paragraphs that raised the paragraphChanged event.
|
|
@@ -97316,29 +98393,29 @@ declare namespace Word {
|
|
|
97316
98393
|
*/
|
|
97317
98394
|
interface ParagraphChangedEventArgs {
|
|
97318
98395
|
/**
|
|
97319
|
-
*
|
|
98396
|
+
* The source of the event. It can be local or remote (through coauthoring).
|
|
97320
98397
|
*
|
|
97321
98398
|
* @remarks
|
|
97322
98399
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97323
98400
|
* @beta
|
|
97324
98401
|
*/
|
|
97325
|
-
|
|
98402
|
+
source: Word.EventSource | "Local" | "Remote";
|
|
97326
98403
|
/**
|
|
97327
|
-
* The
|
|
98404
|
+
* The event type. See Word.EventType for details.
|
|
97328
98405
|
*
|
|
97329
98406
|
* @remarks
|
|
97330
98407
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97331
98408
|
* @beta
|
|
97332
98409
|
*/
|
|
97333
|
-
|
|
98410
|
+
type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
|
|
97334
98411
|
/**
|
|
97335
|
-
*
|
|
98412
|
+
* Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors.
|
|
97336
98413
|
*
|
|
97337
98414
|
* @remarks
|
|
97338
98415
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97339
98416
|
* @beta
|
|
97340
98417
|
*/
|
|
97341
|
-
|
|
98418
|
+
uniqueLocalIds: string[];
|
|
97342
98419
|
}
|
|
97343
98420
|
/**
|
|
97344
98421
|
* Provides information about the paragraphs that raised the paragraphDeleted event.
|
|
@@ -97349,29 +98426,29 @@ declare namespace Word {
|
|
|
97349
98426
|
*/
|
|
97350
98427
|
interface ParagraphDeletedEventArgs {
|
|
97351
98428
|
/**
|
|
97352
|
-
*
|
|
98429
|
+
* The source of the event. It can be local or remote (through coauthoring).
|
|
97353
98430
|
*
|
|
97354
98431
|
* @remarks
|
|
97355
98432
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97356
98433
|
* @beta
|
|
97357
98434
|
*/
|
|
97358
|
-
|
|
98435
|
+
source: Word.EventSource | "Local" | "Remote";
|
|
97359
98436
|
/**
|
|
97360
|
-
* The
|
|
98437
|
+
* The event type. See Word.EventType for details.
|
|
97361
98438
|
*
|
|
97362
98439
|
* @remarks
|
|
97363
98440
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97364
98441
|
* @beta
|
|
97365
98442
|
*/
|
|
97366
|
-
|
|
98443
|
+
type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
|
|
97367
98444
|
/**
|
|
97368
|
-
*
|
|
98445
|
+
* Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors.
|
|
97369
98446
|
*
|
|
97370
98447
|
* @remarks
|
|
97371
98448
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97372
98449
|
* @beta
|
|
97373
98450
|
*/
|
|
97374
|
-
|
|
98451
|
+
uniqueLocalIds: string[];
|
|
97375
98452
|
}
|
|
97376
98453
|
/**
|
|
97377
98454
|
* Provides information about the comments that raised the comment event.
|
|
@@ -97412,7 +98489,7 @@ declare namespace Word {
|
|
|
97412
98489
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
97413
98490
|
* @beta
|
|
97414
98491
|
*/
|
|
97415
|
-
type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
98492
|
+
type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
|
|
97416
98493
|
}
|
|
97417
98494
|
/**
|
|
97418
98495
|
* A structure for the ID and reply IDs of this comment.
|
|
@@ -98355,6 +99432,13 @@ declare namespace Word {
|
|
|
98355
99432
|
* @beta
|
|
98356
99433
|
*/
|
|
98357
99434
|
inset = "Inset",
|
|
99435
|
+
/**
|
|
99436
|
+
* Mixed line style.
|
|
99437
|
+
* @remarks
|
|
99438
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
99439
|
+
* @beta
|
|
99440
|
+
*/
|
|
99441
|
+
mixed = "Mixed",
|
|
98358
99442
|
/**
|
|
98359
99443
|
* Represents that there's no line style.
|
|
98360
99444
|
* @remarks
|
|
@@ -101033,6 +102117,10 @@ declare namespace Word {
|
|
|
101033
102117
|
*/
|
|
101034
102118
|
$skip?: number;
|
|
101035
102119
|
}
|
|
102120
|
+
/** An interface for updating data on the AnnotationCollection object, for use in `annotationCollection.set({ ... })`. */
|
|
102121
|
+
interface AnnotationCollectionUpdateData {
|
|
102122
|
+
items?: Word.Interfaces.AnnotationData[];
|
|
102123
|
+
}
|
|
101036
102124
|
/** An interface for updating data on the Body object, for use in `body.set({ ... })`. */
|
|
101037
102125
|
interface BodyUpdateData {
|
|
101038
102126
|
/**
|
|
@@ -101074,7 +102162,7 @@ declare namespace Word {
|
|
|
101074
102162
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
101075
102163
|
* @beta
|
|
101076
102164
|
*/
|
|
101077
|
-
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";
|
|
102165
|
+
lineStyle?: Word.LineStyle | "DashDot" | "DashDotDot" | "DashDotStroked" | "DashLargeGap" | "DashSmallGap" | "Dot" | "Double" | "DoubleWavy" | "Emboss3D" | "Engrave3D" | "Inset" | "Mixed" | "None" | "Outset" | "Single" | "SingleWavy" | "ThickThinLargeGap" | "ThickThinMedGap" | "ThickThinSmallGap" | "ThinThickLargeGap" | "ThinThickMedGap" | "ThinThickSmallGap" | "ThinThickThinLargeGap" | "ThinThickThinMedGap" | "ThinThickThinSmallGap" | "Triple";
|
|
101078
102166
|
/**
|
|
101079
102167
|
* Specifies the line width for the border.
|
|
101080
102168
|
*
|
|
@@ -101092,6 +102180,58 @@ declare namespace Word {
|
|
|
101092
102180
|
*/
|
|
101093
102181
|
visible?: boolean;
|
|
101094
102182
|
}
|
|
102183
|
+
/** An interface for updating data on the BorderCollection object, for use in `borderCollection.set({ ... })`. */
|
|
102184
|
+
interface BorderCollectionUpdateData {
|
|
102185
|
+
/**
|
|
102186
|
+
* Specifies the 24-bit color of the inside borders.
|
|
102187
|
+
*
|
|
102188
|
+
* @remarks
|
|
102189
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102190
|
+
* @beta
|
|
102191
|
+
*/
|
|
102192
|
+
insideLineColor?: string;
|
|
102193
|
+
/**
|
|
102194
|
+
* Specifies the line style of the inside borders.
|
|
102195
|
+
*
|
|
102196
|
+
* @remarks
|
|
102197
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102198
|
+
* @beta
|
|
102199
|
+
*/
|
|
102200
|
+
insideLineStyle?: Word.LineStyle | "DashDot" | "DashDotDot" | "DashDotStroked" | "DashLargeGap" | "DashSmallGap" | "Dot" | "Double" | "DoubleWavy" | "Emboss3D" | "Engrave3D" | "Inset" | "Mixed" | "None" | "Outset" | "Single" | "SingleWavy" | "ThickThinLargeGap" | "ThickThinMedGap" | "ThickThinSmallGap" | "ThinThickLargeGap" | "ThinThickMedGap" | "ThinThickSmallGap" | "ThinThickThinLargeGap" | "ThinThickThinMedGap" | "ThinThickThinSmallGap" | "Triple";
|
|
102201
|
+
/**
|
|
102202
|
+
* Specifies the line width of the inside borders.
|
|
102203
|
+
*
|
|
102204
|
+
* @remarks
|
|
102205
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102206
|
+
* @beta
|
|
102207
|
+
*/
|
|
102208
|
+
insideLineWidth?: Word.LineWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
|
|
102209
|
+
/**
|
|
102210
|
+
* Specifies the 24-bit color of the outside borders.
|
|
102211
|
+
*
|
|
102212
|
+
* @remarks
|
|
102213
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102214
|
+
* @beta
|
|
102215
|
+
*/
|
|
102216
|
+
outsideLineColor?: string;
|
|
102217
|
+
/**
|
|
102218
|
+
* Specifies the line style of the outside borders.
|
|
102219
|
+
*
|
|
102220
|
+
* @remarks
|
|
102221
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102222
|
+
* @beta
|
|
102223
|
+
*/
|
|
102224
|
+
outsideLineStyle?: Word.LineStyle | "DashDot" | "DashDotDot" | "DashDotStroked" | "DashLargeGap" | "DashSmallGap" | "Dot" | "Double" | "DoubleWavy" | "Emboss3D" | "Engrave3D" | "Inset" | "Mixed" | "None" | "Outset" | "Single" | "SingleWavy" | "ThickThinLargeGap" | "ThickThinMedGap" | "ThickThinSmallGap" | "ThinThickLargeGap" | "ThinThickMedGap" | "ThinThickSmallGap" | "ThinThickThinLargeGap" | "ThinThickThinMedGap" | "ThinThickThinSmallGap" | "Triple";
|
|
102225
|
+
/**
|
|
102226
|
+
* Specifies the line width of the outside borders.
|
|
102227
|
+
*
|
|
102228
|
+
* @remarks
|
|
102229
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102230
|
+
* @beta
|
|
102231
|
+
*/
|
|
102232
|
+
outsideLineWidth?: Word.LineWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
|
|
102233
|
+
items?: Word.Interfaces.BorderData[];
|
|
102234
|
+
}
|
|
101095
102235
|
/** An interface for updating data on the Comment object, for use in `comment.set({ ... })`. */
|
|
101096
102236
|
interface CommentUpdateData {
|
|
101097
102237
|
/**
|
|
@@ -101465,6 +102605,14 @@ declare namespace Word {
|
|
|
101465
102605
|
* [Api set: WordApi 1.1]
|
|
101466
102606
|
*/
|
|
101467
102607
|
doubleStrikeThrough?: boolean;
|
|
102608
|
+
/**
|
|
102609
|
+
* Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false.
|
|
102610
|
+
*
|
|
102611
|
+
* @remarks
|
|
102612
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102613
|
+
* @beta
|
|
102614
|
+
*/
|
|
102615
|
+
hidden?: boolean;
|
|
101468
102616
|
/**
|
|
101469
102617
|
* Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or null for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font.
|
|
101470
102618
|
*
|
|
@@ -101729,7 +102877,7 @@ declare namespace Word {
|
|
|
101729
102877
|
*/
|
|
101730
102878
|
listItem?: Word.Interfaces.ListItemUpdateData;
|
|
101731
102879
|
/**
|
|
101732
|
-
* Gets the ListItem for the paragraph. If the paragraph is not part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
102880
|
+
* Gets the ListItem for the paragraph. If the paragraph is not part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
101733
102881
|
*
|
|
101734
102882
|
* @remarks
|
|
101735
102883
|
* [Api set: WordApi 1.3]
|
|
@@ -102046,6 +103194,14 @@ declare namespace Word {
|
|
|
102046
103194
|
}
|
|
102047
103195
|
/** An interface for updating data on the Style object, for use in `style.set({ ... })`. */
|
|
102048
103196
|
interface StyleUpdateData {
|
|
103197
|
+
/**
|
|
103198
|
+
* Specifies a BorderCollection object that represents all the borders for the specified style.
|
|
103199
|
+
*
|
|
103200
|
+
* @remarks
|
|
103201
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
103202
|
+
* @beta
|
|
103203
|
+
*/
|
|
103204
|
+
borders?: Word.Interfaces.BorderCollectionUpdateData;
|
|
102049
103205
|
/**
|
|
102050
103206
|
* Gets a font object that represents the character formatting of the specified style.
|
|
102051
103207
|
*
|
|
@@ -102433,6 +103589,44 @@ declare namespace Word {
|
|
|
102433
103589
|
*/
|
|
102434
103590
|
width?: number;
|
|
102435
103591
|
}
|
|
103592
|
+
/** An interface for updating data on the TrackedChangeCollection object, for use in `trackedChangeCollection.set({ ... })`. */
|
|
103593
|
+
interface TrackedChangeCollectionUpdateData {
|
|
103594
|
+
items?: Word.Interfaces.TrackedChangeData[];
|
|
103595
|
+
}
|
|
103596
|
+
/** An interface describing the data returned by calling `critiqueAnnotation.toJSON()`. */
|
|
103597
|
+
interface CritiqueAnnotationData {
|
|
103598
|
+
/**
|
|
103599
|
+
* Gets the critique that was passed when the annotation was inserted.
|
|
103600
|
+
*
|
|
103601
|
+
* @remarks
|
|
103602
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
103603
|
+
* @beta
|
|
103604
|
+
*/
|
|
103605
|
+
critique?: Word.Critique;
|
|
103606
|
+
}
|
|
103607
|
+
/** An interface describing the data returned by calling `annotation.toJSON()`. */
|
|
103608
|
+
interface AnnotationData {
|
|
103609
|
+
/**
|
|
103610
|
+
* Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects.
|
|
103611
|
+
*
|
|
103612
|
+
* @remarks
|
|
103613
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
103614
|
+
* @beta
|
|
103615
|
+
*/
|
|
103616
|
+
id?: string;
|
|
103617
|
+
/**
|
|
103618
|
+
* Gets the state of the annotation.
|
|
103619
|
+
*
|
|
103620
|
+
* @remarks
|
|
103621
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
103622
|
+
* @beta
|
|
103623
|
+
*/
|
|
103624
|
+
state?: Word.AnnotationState | "Created" | "Accepted" | "Rejected";
|
|
103625
|
+
}
|
|
103626
|
+
/** An interface describing the data returned by calling `annotationCollection.toJSON()`. */
|
|
103627
|
+
interface AnnotationCollectionData {
|
|
103628
|
+
items?: Word.Interfaces.AnnotationData[];
|
|
103629
|
+
}
|
|
102436
103630
|
/** An interface describing the data returned by calling `body.toJSON()`. */
|
|
102437
103631
|
interface BodyData {
|
|
102438
103632
|
/**
|
|
@@ -102530,7 +103724,7 @@ declare namespace Word {
|
|
|
102530
103724
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
102531
103725
|
* @beta
|
|
102532
103726
|
*/
|
|
102533
|
-
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";
|
|
103727
|
+
lineStyle?: Word.LineStyle | "DashDot" | "DashDotDot" | "DashDotStroked" | "DashLargeGap" | "DashSmallGap" | "Dot" | "Double" | "DoubleWavy" | "Emboss3D" | "Engrave3D" | "Inset" | "Mixed" | "None" | "Outset" | "Single" | "SingleWavy" | "ThickThinLargeGap" | "ThickThinMedGap" | "ThickThinSmallGap" | "ThinThickLargeGap" | "ThinThickMedGap" | "ThinThickSmallGap" | "ThinThickThinLargeGap" | "ThinThickThinMedGap" | "ThinThickThinSmallGap" | "Triple";
|
|
102534
103728
|
/**
|
|
102535
103729
|
* Specifies the line width for the border.
|
|
102536
103730
|
*
|
|
@@ -102556,6 +103750,10 @@ declare namespace Word {
|
|
|
102556
103750
|
*/
|
|
102557
103751
|
visible?: boolean;
|
|
102558
103752
|
}
|
|
103753
|
+
/** An interface describing the data returned by calling `borderCollection.toJSON()`. */
|
|
103754
|
+
interface BorderCollectionData {
|
|
103755
|
+
items?: Word.Interfaces.BorderData[];
|
|
103756
|
+
}
|
|
102559
103757
|
/** An interface describing the data returned by calling `comment.toJSON()`. */
|
|
102560
103758
|
interface CommentData {
|
|
102561
103759
|
/**
|
|
@@ -103256,6 +104454,14 @@ declare namespace Word {
|
|
|
103256
104454
|
* [Api set: WordApi 1.1]
|
|
103257
104455
|
*/
|
|
103258
104456
|
doubleStrikeThrough?: boolean;
|
|
104457
|
+
/**
|
|
104458
|
+
* Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false.
|
|
104459
|
+
*
|
|
104460
|
+
* @remarks
|
|
104461
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104462
|
+
* @beta
|
|
104463
|
+
*/
|
|
104464
|
+
hidden?: boolean;
|
|
103259
104465
|
/**
|
|
103260
104466
|
* Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or null for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font.
|
|
103261
104467
|
*
|
|
@@ -103602,7 +104808,7 @@ declare namespace Word {
|
|
|
103602
104808
|
*/
|
|
103603
104809
|
listItem?: Word.Interfaces.ListItemData;
|
|
103604
104810
|
/**
|
|
103605
|
-
* Gets the ListItem for the paragraph. If the paragraph is not part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
104811
|
+
* Gets the ListItem for the paragraph. If the paragraph is not part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
103606
104812
|
*
|
|
103607
104813
|
* @remarks
|
|
103608
104814
|
* [Api set: WordApi 1.3]
|
|
@@ -103721,7 +104927,7 @@ declare namespace Word {
|
|
|
103721
104927
|
*/
|
|
103722
104928
|
text?: string;
|
|
103723
104929
|
/**
|
|
103724
|
-
* Gets a string that represents the paragraph identifier in the current session.
|
|
104930
|
+
* Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors.
|
|
103725
104931
|
*
|
|
103726
104932
|
* @remarks
|
|
103727
104933
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -103990,6 +105196,14 @@ declare namespace Word {
|
|
|
103990
105196
|
}
|
|
103991
105197
|
/** An interface describing the data returned by calling `style.toJSON()`. */
|
|
103992
105198
|
interface StyleData {
|
|
105199
|
+
/**
|
|
105200
|
+
* Specifies a BorderCollection object that represents all the borders for the specified style.
|
|
105201
|
+
*
|
|
105202
|
+
* @remarks
|
|
105203
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
105204
|
+
* @beta
|
|
105205
|
+
*/
|
|
105206
|
+
borders?: Word.Interfaces.BorderData[];
|
|
103993
105207
|
/**
|
|
103994
105208
|
* Gets a font object that represents the character formatting of the specified style.
|
|
103995
105209
|
*
|
|
@@ -104532,6 +105746,148 @@ declare namespace Word {
|
|
|
104532
105746
|
*/
|
|
104533
105747
|
width?: number;
|
|
104534
105748
|
}
|
|
105749
|
+
/** An interface describing the data returned by calling `trackedChange.toJSON()`. */
|
|
105750
|
+
interface TrackedChangeData {
|
|
105751
|
+
/**
|
|
105752
|
+
* Specifies the author of the tracked change.
|
|
105753
|
+
*
|
|
105754
|
+
* @remarks
|
|
105755
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
105756
|
+
* @beta
|
|
105757
|
+
*/
|
|
105758
|
+
author?: string;
|
|
105759
|
+
/**
|
|
105760
|
+
* Specifies the date of the tracked change.
|
|
105761
|
+
*
|
|
105762
|
+
* @remarks
|
|
105763
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
105764
|
+
* @beta
|
|
105765
|
+
*/
|
|
105766
|
+
date?: Date;
|
|
105767
|
+
/**
|
|
105768
|
+
* Specifies the text of the tracked change.
|
|
105769
|
+
*
|
|
105770
|
+
* @remarks
|
|
105771
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
105772
|
+
* @beta
|
|
105773
|
+
*/
|
|
105774
|
+
text?: string;
|
|
105775
|
+
/**
|
|
105776
|
+
* Specifies the type of the tracked change.
|
|
105777
|
+
*
|
|
105778
|
+
* @remarks
|
|
105779
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
105780
|
+
* @beta
|
|
105781
|
+
*/
|
|
105782
|
+
type?: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted";
|
|
105783
|
+
}
|
|
105784
|
+
/** An interface describing the data returned by calling `trackedChangeCollection.toJSON()`. */
|
|
105785
|
+
interface TrackedChangeCollectionData {
|
|
105786
|
+
items?: Word.Interfaces.TrackedChangeData[];
|
|
105787
|
+
}
|
|
105788
|
+
/**
|
|
105789
|
+
* Represents an annotation wrapper around critique displayed in the document.
|
|
105790
|
+
*
|
|
105791
|
+
* @remarks
|
|
105792
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
105793
|
+
* @beta
|
|
105794
|
+
*/
|
|
105795
|
+
interface CritiqueAnnotationLoadOptions {
|
|
105796
|
+
/**
|
|
105797
|
+
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`).
|
|
105798
|
+
*/
|
|
105799
|
+
$all?: boolean;
|
|
105800
|
+
/**
|
|
105801
|
+
* Gets the range of text that is annotated.
|
|
105802
|
+
*
|
|
105803
|
+
* @remarks
|
|
105804
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
105805
|
+
* @beta
|
|
105806
|
+
*/
|
|
105807
|
+
range?: Word.Interfaces.RangeLoadOptions;
|
|
105808
|
+
/**
|
|
105809
|
+
* Gets the critique that was passed when the annotation was inserted.
|
|
105810
|
+
*
|
|
105811
|
+
* @remarks
|
|
105812
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
105813
|
+
* @beta
|
|
105814
|
+
*/
|
|
105815
|
+
critique?: boolean;
|
|
105816
|
+
}
|
|
105817
|
+
/**
|
|
105818
|
+
* Represents an annotation attached to a paragraph.
|
|
105819
|
+
*
|
|
105820
|
+
* @remarks
|
|
105821
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
105822
|
+
* @beta
|
|
105823
|
+
*/
|
|
105824
|
+
interface AnnotationLoadOptions {
|
|
105825
|
+
/**
|
|
105826
|
+
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`).
|
|
105827
|
+
*/
|
|
105828
|
+
$all?: boolean;
|
|
105829
|
+
/**
|
|
105830
|
+
* Gets the critique annotation object.
|
|
105831
|
+
*
|
|
105832
|
+
* @remarks
|
|
105833
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
105834
|
+
* @beta
|
|
105835
|
+
*/
|
|
105836
|
+
critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions;
|
|
105837
|
+
/**
|
|
105838
|
+
* Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects.
|
|
105839
|
+
*
|
|
105840
|
+
* @remarks
|
|
105841
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
105842
|
+
* @beta
|
|
105843
|
+
*/
|
|
105844
|
+
id?: boolean;
|
|
105845
|
+
/**
|
|
105846
|
+
* Gets the state of the annotation.
|
|
105847
|
+
*
|
|
105848
|
+
* @remarks
|
|
105849
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
105850
|
+
* @beta
|
|
105851
|
+
*/
|
|
105852
|
+
state?: boolean;
|
|
105853
|
+
}
|
|
105854
|
+
/**
|
|
105855
|
+
* Contains a collection of {@link Word.Annotation} objects.
|
|
105856
|
+
*
|
|
105857
|
+
* @remarks
|
|
105858
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
105859
|
+
* @beta
|
|
105860
|
+
*/
|
|
105861
|
+
interface AnnotationCollectionLoadOptions {
|
|
105862
|
+
/**
|
|
105863
|
+
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`).
|
|
105864
|
+
*/
|
|
105865
|
+
$all?: boolean;
|
|
105866
|
+
/**
|
|
105867
|
+
* For EACH ITEM in the collection: Gets the critique annotation object.
|
|
105868
|
+
*
|
|
105869
|
+
* @remarks
|
|
105870
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
105871
|
+
* @beta
|
|
105872
|
+
*/
|
|
105873
|
+
critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions;
|
|
105874
|
+
/**
|
|
105875
|
+
* For EACH ITEM in the collection: Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects.
|
|
105876
|
+
*
|
|
105877
|
+
* @remarks
|
|
105878
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
105879
|
+
* @beta
|
|
105880
|
+
*/
|
|
105881
|
+
id?: boolean;
|
|
105882
|
+
/**
|
|
105883
|
+
* For EACH ITEM in the collection: Gets the state of the annotation.
|
|
105884
|
+
*
|
|
105885
|
+
* @remarks
|
|
105886
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
105887
|
+
* @beta
|
|
105888
|
+
*/
|
|
105889
|
+
state?: boolean;
|
|
105890
|
+
}
|
|
104535
105891
|
/**
|
|
104536
105892
|
* Represents the body of a document or a section.
|
|
104537
105893
|
*
|
|
@@ -104558,7 +105914,7 @@ declare namespace Word {
|
|
|
104558
105914
|
*/
|
|
104559
105915
|
parentBody?: Word.Interfaces.BodyLoadOptions;
|
|
104560
105916
|
/**
|
|
104561
|
-
* Gets the parent body of the body. For example, a table cell body's parent body could be a header. If there isn't a parent body, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
105917
|
+
* Gets the parent body of the body. For example, a table cell body's parent body could be a header. If there isn't a parent body, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
104562
105918
|
*
|
|
104563
105919
|
* @remarks
|
|
104564
105920
|
* [Api set: WordApi 1.3]
|
|
@@ -104572,7 +105928,7 @@ declare namespace Word {
|
|
|
104572
105928
|
*/
|
|
104573
105929
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
104574
105930
|
/**
|
|
104575
|
-
* Gets the content control that contains the body. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
105931
|
+
* Gets the content control that contains the body. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
104576
105932
|
*
|
|
104577
105933
|
* @remarks
|
|
104578
105934
|
* [Api set: WordApi 1.3]
|
|
@@ -104586,7 +105942,7 @@ declare namespace Word {
|
|
|
104586
105942
|
*/
|
|
104587
105943
|
parentSection?: Word.Interfaces.SectionLoadOptions;
|
|
104588
105944
|
/**
|
|
104589
|
-
* Gets the parent section of the body. If there isn't a parent section, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
105945
|
+
* Gets the parent section of the body. If there isn't a parent section, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
104590
105946
|
*
|
|
104591
105947
|
* @remarks
|
|
104592
105948
|
* [Api set: WordApi 1.3]
|
|
@@ -104674,6 +106030,59 @@ declare namespace Word {
|
|
|
104674
106030
|
*/
|
|
104675
106031
|
visible?: boolean;
|
|
104676
106032
|
}
|
|
106033
|
+
/**
|
|
106034
|
+
* Represents the collection of border styles.
|
|
106035
|
+
*
|
|
106036
|
+
* @remarks
|
|
106037
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
106038
|
+
* @beta
|
|
106039
|
+
*/
|
|
106040
|
+
interface BorderCollectionLoadOptions {
|
|
106041
|
+
/**
|
|
106042
|
+
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`).
|
|
106043
|
+
*/
|
|
106044
|
+
$all?: boolean;
|
|
106045
|
+
/**
|
|
106046
|
+
* For EACH ITEM in the collection: Specifies the line color for the border.
|
|
106047
|
+
*
|
|
106048
|
+
* @remarks
|
|
106049
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
106050
|
+
* @beta
|
|
106051
|
+
*/
|
|
106052
|
+
lineColor?: boolean;
|
|
106053
|
+
/**
|
|
106054
|
+
* For EACH ITEM in the collection: Specifies the line style for the border.
|
|
106055
|
+
*
|
|
106056
|
+
* @remarks
|
|
106057
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
106058
|
+
* @beta
|
|
106059
|
+
*/
|
|
106060
|
+
lineStyle?: boolean;
|
|
106061
|
+
/**
|
|
106062
|
+
* For EACH ITEM in the collection: Specifies the line width for the border.
|
|
106063
|
+
*
|
|
106064
|
+
* @remarks
|
|
106065
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
106066
|
+
* @beta
|
|
106067
|
+
*/
|
|
106068
|
+
lineWidth?: boolean;
|
|
106069
|
+
/**
|
|
106070
|
+
* For EACH ITEM in the collection: Gets the position type of the border.
|
|
106071
|
+
*
|
|
106072
|
+
* @remarks
|
|
106073
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
106074
|
+
* @beta
|
|
106075
|
+
*/
|
|
106076
|
+
positionType?: boolean;
|
|
106077
|
+
/**
|
|
106078
|
+
* For EACH ITEM in the collection: Specifies whether the border is visible.
|
|
106079
|
+
*
|
|
106080
|
+
* @remarks
|
|
106081
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
106082
|
+
* @beta
|
|
106083
|
+
*/
|
|
106084
|
+
visible?: boolean;
|
|
106085
|
+
}
|
|
104677
106086
|
/**
|
|
104678
106087
|
* Represents a comment in the document.
|
|
104679
106088
|
*
|
|
@@ -105010,7 +106419,7 @@ declare namespace Word {
|
|
|
105010
106419
|
*/
|
|
105011
106420
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
105012
106421
|
/**
|
|
105013
|
-
* Gets the content control that contains the content control. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
106422
|
+
* Gets the content control that contains the content control. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
105014
106423
|
*
|
|
105015
106424
|
* @remarks
|
|
105016
106425
|
* [Api set: WordApi 1.3]
|
|
@@ -105031,14 +106440,14 @@ declare namespace Word {
|
|
|
105031
106440
|
*/
|
|
105032
106441
|
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
|
|
105033
106442
|
/**
|
|
105034
|
-
* Gets the table cell that contains the content control. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
106443
|
+
* Gets the table cell that contains the content control. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
105035
106444
|
*
|
|
105036
106445
|
* @remarks
|
|
105037
106446
|
* [Api set: WordApi 1.3]
|
|
105038
106447
|
*/
|
|
105039
106448
|
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
|
|
105040
106449
|
/**
|
|
105041
|
-
* Gets the table that contains the content control. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
106450
|
+
* Gets the table that contains the content control. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
105042
106451
|
*
|
|
105043
106452
|
* @remarks
|
|
105044
106453
|
* [Api set: WordApi 1.3]
|
|
@@ -105176,7 +106585,7 @@ declare namespace Word {
|
|
|
105176
106585
|
*/
|
|
105177
106586
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
105178
106587
|
/**
|
|
105179
|
-
* For EACH ITEM in the collection: Gets the content control that contains the content control. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
106588
|
+
* For EACH ITEM in the collection: Gets the content control that contains the content control. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
105180
106589
|
*
|
|
105181
106590
|
* @remarks
|
|
105182
106591
|
* [Api set: WordApi 1.3]
|
|
@@ -105197,14 +106606,14 @@ declare namespace Word {
|
|
|
105197
106606
|
*/
|
|
105198
106607
|
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
|
|
105199
106608
|
/**
|
|
105200
|
-
* For EACH ITEM in the collection: Gets the table cell that contains the content control. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
106609
|
+
* For EACH ITEM in the collection: Gets the table cell that contains the content control. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
105201
106610
|
*
|
|
105202
106611
|
* @remarks
|
|
105203
106612
|
* [Api set: WordApi 1.3]
|
|
105204
106613
|
*/
|
|
105205
106614
|
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
|
|
105206
106615
|
/**
|
|
105207
|
-
* For EACH ITEM in the collection: Gets the table that contains the content control. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
106616
|
+
* For EACH ITEM in the collection: Gets the table that contains the content control. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
105208
106617
|
*
|
|
105209
106618
|
* @remarks
|
|
105210
106619
|
* [Api set: WordApi 1.3]
|
|
@@ -105683,7 +107092,7 @@ declare namespace Word {
|
|
|
105683
107092
|
*/
|
|
105684
107093
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
105685
107094
|
/**
|
|
105686
|
-
* Gets the content control that contains the field. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
107095
|
+
* Gets the content control that contains the field. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
105687
107096
|
*
|
|
105688
107097
|
* @remarks
|
|
105689
107098
|
* [Api set: WordApi 1.4]
|
|
@@ -105704,14 +107113,14 @@ declare namespace Word {
|
|
|
105704
107113
|
*/
|
|
105705
107114
|
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
|
|
105706
107115
|
/**
|
|
105707
|
-
* Gets the table cell that contains the field. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
107116
|
+
* Gets the table cell that contains the field. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
105708
107117
|
*
|
|
105709
107118
|
* @remarks
|
|
105710
107119
|
* [Api set: WordApi 1.4]
|
|
105711
107120
|
*/
|
|
105712
107121
|
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
|
|
105713
107122
|
/**
|
|
105714
|
-
* Gets the table that contains the field. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
107123
|
+
* Gets the table that contains the field. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
105715
107124
|
*
|
|
105716
107125
|
* @remarks
|
|
105717
107126
|
* [Api set: WordApi 1.4]
|
|
@@ -105796,7 +107205,7 @@ declare namespace Word {
|
|
|
105796
107205
|
*/
|
|
105797
107206
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
105798
107207
|
/**
|
|
105799
|
-
* For EACH ITEM in the collection: Gets the content control that contains the field. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
107208
|
+
* For EACH ITEM in the collection: Gets the content control that contains the field. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
105800
107209
|
*
|
|
105801
107210
|
* @remarks
|
|
105802
107211
|
* [Api set: WordApi 1.4]
|
|
@@ -105817,14 +107226,14 @@ declare namespace Word {
|
|
|
105817
107226
|
*/
|
|
105818
107227
|
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
|
|
105819
107228
|
/**
|
|
105820
|
-
* For EACH ITEM in the collection: Gets the table cell that contains the field. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
107229
|
+
* For EACH ITEM in the collection: Gets the table cell that contains the field. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
105821
107230
|
*
|
|
105822
107231
|
* @remarks
|
|
105823
107232
|
* [Api set: WordApi 1.4]
|
|
105824
107233
|
*/
|
|
105825
107234
|
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
|
|
105826
107235
|
/**
|
|
105827
|
-
* For EACH ITEM in the collection: Gets the table that contains the field. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
107236
|
+
* For EACH ITEM in the collection: Gets the table that contains the field. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
105828
107237
|
*
|
|
105829
107238
|
* @remarks
|
|
105830
107239
|
* [Api set: WordApi 1.4]
|
|
@@ -105915,6 +107324,14 @@ declare namespace Word {
|
|
|
105915
107324
|
* [Api set: WordApi 1.1]
|
|
105916
107325
|
*/
|
|
105917
107326
|
doubleStrikeThrough?: boolean;
|
|
107327
|
+
/**
|
|
107328
|
+
* Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false.
|
|
107329
|
+
*
|
|
107330
|
+
* @remarks
|
|
107331
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
107332
|
+
* @beta
|
|
107333
|
+
*/
|
|
107334
|
+
hidden?: boolean;
|
|
105918
107335
|
/**
|
|
105919
107336
|
* Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or null for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font.
|
|
105920
107337
|
*
|
|
@@ -105998,7 +107415,7 @@ declare namespace Word {
|
|
|
105998
107415
|
*/
|
|
105999
107416
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
106000
107417
|
/**
|
|
106001
|
-
* Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
107418
|
+
* Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
106002
107419
|
*
|
|
106003
107420
|
* @remarks
|
|
106004
107421
|
* [Api set: WordApi 1.3]
|
|
@@ -106019,14 +107436,14 @@ declare namespace Word {
|
|
|
106019
107436
|
*/
|
|
106020
107437
|
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
|
|
106021
107438
|
/**
|
|
106022
|
-
* Gets the table cell that contains the inline image. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
107439
|
+
* Gets the table cell that contains the inline image. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
106023
107440
|
*
|
|
106024
107441
|
* @remarks
|
|
106025
107442
|
* [Api set: WordApi 1.3]
|
|
106026
107443
|
*/
|
|
106027
107444
|
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
|
|
106028
107445
|
/**
|
|
106029
|
-
* Gets the table that contains the inline image. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
107446
|
+
* Gets the table that contains the inline image. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
106030
107447
|
*
|
|
106031
107448
|
* @remarks
|
|
106032
107449
|
* [Api set: WordApi 1.3]
|
|
@@ -106109,7 +107526,7 @@ declare namespace Word {
|
|
|
106109
107526
|
*/
|
|
106110
107527
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
106111
107528
|
/**
|
|
106112
|
-
* For EACH ITEM in the collection: Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
107529
|
+
* For EACH ITEM in the collection: Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
106113
107530
|
*
|
|
106114
107531
|
* @remarks
|
|
106115
107532
|
* [Api set: WordApi 1.3]
|
|
@@ -106130,14 +107547,14 @@ declare namespace Word {
|
|
|
106130
107547
|
*/
|
|
106131
107548
|
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
|
|
106132
107549
|
/**
|
|
106133
|
-
* For EACH ITEM in the collection: Gets the table cell that contains the inline image. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
107550
|
+
* For EACH ITEM in the collection: Gets the table cell that contains the inline image. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
106134
107551
|
*
|
|
106135
107552
|
* @remarks
|
|
106136
107553
|
* [Api set: WordApi 1.3]
|
|
106137
107554
|
*/
|
|
106138
107555
|
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
|
|
106139
107556
|
/**
|
|
106140
|
-
* For EACH ITEM in the collection: Gets the table that contains the inline image. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
107557
|
+
* For EACH ITEM in the collection: Gets the table that contains the inline image. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
106141
107558
|
*
|
|
106142
107559
|
* @remarks
|
|
106143
107560
|
* [Api set: WordApi 1.3]
|
|
@@ -106615,14 +108032,14 @@ declare namespace Word {
|
|
|
106615
108032
|
*/
|
|
106616
108033
|
listItem?: Word.Interfaces.ListItemLoadOptions;
|
|
106617
108034
|
/**
|
|
106618
|
-
* Gets the ListItem for the paragraph. If the paragraph is not part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
108035
|
+
* Gets the ListItem for the paragraph. If the paragraph is not part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
106619
108036
|
*
|
|
106620
108037
|
* @remarks
|
|
106621
108038
|
* [Api set: WordApi 1.3]
|
|
106622
108039
|
*/
|
|
106623
108040
|
listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions;
|
|
106624
108041
|
/**
|
|
106625
|
-
* Gets the List to which this paragraph belongs. If the paragraph is not in a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
108042
|
+
* Gets the List to which this paragraph belongs. If the paragraph is not in a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
106626
108043
|
*
|
|
106627
108044
|
* @remarks
|
|
106628
108045
|
* [Api set: WordApi 1.3]
|
|
@@ -106643,7 +108060,7 @@ declare namespace Word {
|
|
|
106643
108060
|
*/
|
|
106644
108061
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
106645
108062
|
/**
|
|
106646
|
-
* Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
108063
|
+
* Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
106647
108064
|
*
|
|
106648
108065
|
* @remarks
|
|
106649
108066
|
* [Api set: WordApi 1.3]
|
|
@@ -106664,14 +108081,14 @@ declare namespace Word {
|
|
|
106664
108081
|
*/
|
|
106665
108082
|
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
|
|
106666
108083
|
/**
|
|
106667
|
-
* Gets the table cell that contains the paragraph. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
108084
|
+
* Gets the table cell that contains the paragraph. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
106668
108085
|
*
|
|
106669
108086
|
* @remarks
|
|
106670
108087
|
* [Api set: WordApi 1.3]
|
|
106671
108088
|
*/
|
|
106672
108089
|
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
|
|
106673
108090
|
/**
|
|
106674
|
-
* Gets the table that contains the paragraph. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
108091
|
+
* Gets the table that contains the paragraph. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
106675
108092
|
*
|
|
106676
108093
|
* @remarks
|
|
106677
108094
|
* [Api set: WordApi 1.3]
|
|
@@ -106790,7 +108207,7 @@ declare namespace Word {
|
|
|
106790
108207
|
*/
|
|
106791
108208
|
text?: boolean;
|
|
106792
108209
|
/**
|
|
106793
|
-
* Gets a string that represents the paragraph identifier in the current session.
|
|
108210
|
+
* Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors.
|
|
106794
108211
|
*
|
|
106795
108212
|
* @remarks
|
|
106796
108213
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -106831,14 +108248,14 @@ declare namespace Word {
|
|
|
106831
108248
|
*/
|
|
106832
108249
|
listItem?: Word.Interfaces.ListItemLoadOptions;
|
|
106833
108250
|
/**
|
|
106834
|
-
* For EACH ITEM in the collection: Gets the ListItem for the paragraph. If the paragraph is not part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
108251
|
+
* For EACH ITEM in the collection: Gets the ListItem for the paragraph. If the paragraph is not part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
106835
108252
|
*
|
|
106836
108253
|
* @remarks
|
|
106837
108254
|
* [Api set: WordApi 1.3]
|
|
106838
108255
|
*/
|
|
106839
108256
|
listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions;
|
|
106840
108257
|
/**
|
|
106841
|
-
* For EACH ITEM in the collection: Gets the List to which this paragraph belongs. If the paragraph is not in a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
108258
|
+
* For EACH ITEM in the collection: Gets the List to which this paragraph belongs. If the paragraph is not in a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
106842
108259
|
*
|
|
106843
108260
|
* @remarks
|
|
106844
108261
|
* [Api set: WordApi 1.3]
|
|
@@ -106859,7 +108276,7 @@ declare namespace Word {
|
|
|
106859
108276
|
*/
|
|
106860
108277
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
106861
108278
|
/**
|
|
106862
|
-
* For EACH ITEM in the collection: Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
108279
|
+
* For EACH ITEM in the collection: Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
106863
108280
|
*
|
|
106864
108281
|
* @remarks
|
|
106865
108282
|
* [Api set: WordApi 1.3]
|
|
@@ -106880,14 +108297,14 @@ declare namespace Word {
|
|
|
106880
108297
|
*/
|
|
106881
108298
|
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
|
|
106882
108299
|
/**
|
|
106883
|
-
* For EACH ITEM in the collection: Gets the table cell that contains the paragraph. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
108300
|
+
* For EACH ITEM in the collection: Gets the table cell that contains the paragraph. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
106884
108301
|
*
|
|
106885
108302
|
* @remarks
|
|
106886
108303
|
* [Api set: WordApi 1.3]
|
|
106887
108304
|
*/
|
|
106888
108305
|
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
|
|
106889
108306
|
/**
|
|
106890
|
-
* For EACH ITEM in the collection: Gets the table that contains the paragraph. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
108307
|
+
* For EACH ITEM in the collection: Gets the table that contains the paragraph. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
106891
108308
|
*
|
|
106892
108309
|
* @remarks
|
|
106893
108310
|
* [Api set: WordApi 1.3]
|
|
@@ -107006,7 +108423,7 @@ declare namespace Word {
|
|
|
107006
108423
|
*/
|
|
107007
108424
|
text?: boolean;
|
|
107008
108425
|
/**
|
|
107009
|
-
* For EACH ITEM in the collection: Gets a string that represents the paragraph identifier in the current session.
|
|
108426
|
+
* For EACH ITEM in the collection: Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors.
|
|
107010
108427
|
*
|
|
107011
108428
|
* @remarks
|
|
107012
108429
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -107157,7 +108574,7 @@ declare namespace Word {
|
|
|
107157
108574
|
*/
|
|
107158
108575
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
107159
108576
|
/**
|
|
107160
|
-
* Gets the content control that contains the range. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
108577
|
+
* Gets the content control that contains the range. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
107161
108578
|
*
|
|
107162
108579
|
* @remarks
|
|
107163
108580
|
* [Api set: WordApi 1.3]
|
|
@@ -107178,14 +108595,14 @@ declare namespace Word {
|
|
|
107178
108595
|
*/
|
|
107179
108596
|
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
|
|
107180
108597
|
/**
|
|
107181
|
-
* Gets the table cell that contains the range. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
108598
|
+
* Gets the table cell that contains the range. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
107182
108599
|
*
|
|
107183
108600
|
* @remarks
|
|
107184
108601
|
* [Api set: WordApi 1.3]
|
|
107185
108602
|
*/
|
|
107186
108603
|
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
|
|
107187
108604
|
/**
|
|
107188
|
-
* Gets the table that contains the range. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
108605
|
+
* Gets the table that contains the range. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
107189
108606
|
*
|
|
107190
108607
|
* @remarks
|
|
107191
108608
|
* [Api set: WordApi 1.3]
|
|
@@ -107260,7 +108677,7 @@ declare namespace Word {
|
|
|
107260
108677
|
*/
|
|
107261
108678
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
107262
108679
|
/**
|
|
107263
|
-
* For EACH ITEM in the collection: Gets the content control that contains the range. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
108680
|
+
* For EACH ITEM in the collection: Gets the content control that contains the range. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
107264
108681
|
*
|
|
107265
108682
|
* @remarks
|
|
107266
108683
|
* [Api set: WordApi 1.3]
|
|
@@ -107281,14 +108698,14 @@ declare namespace Word {
|
|
|
107281
108698
|
*/
|
|
107282
108699
|
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
|
|
107283
108700
|
/**
|
|
107284
|
-
* For EACH ITEM in the collection: Gets the table cell that contains the range. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
108701
|
+
* For EACH ITEM in the collection: Gets the table cell that contains the range. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
107285
108702
|
*
|
|
107286
108703
|
* @remarks
|
|
107287
108704
|
* [Api set: WordApi 1.3]
|
|
107288
108705
|
*/
|
|
107289
108706
|
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
|
|
107290
108707
|
/**
|
|
107291
|
-
* For EACH ITEM in the collection: Gets the table that contains the range. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
108708
|
+
* For EACH ITEM in the collection: Gets the table that contains the range. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
107292
108709
|
*
|
|
107293
108710
|
* @remarks
|
|
107294
108711
|
* [Api set: WordApi 1.3]
|
|
@@ -107332,7 +108749,7 @@ declare namespace Word {
|
|
|
107332
108749
|
}
|
|
107333
108750
|
/**
|
|
107334
108751
|
* Specifies the options to be included in a search operation.
|
|
107335
|
-
To learn more about how to use search options in the Word JavaScript APIs, read {@link https://
|
|
108752
|
+
To learn more about how to use search options in the Word JavaScript APIs, read {@link https://learn.microsoft.com/office/dev/add-ins/word/search-option-guidance | Use search options to find text in your Word add-in}.
|
|
107336
108753
|
*
|
|
107337
108754
|
* @remarks
|
|
107338
108755
|
* [Api set: WordApi 1.1]
|
|
@@ -107493,6 +108910,14 @@ declare namespace Word {
|
|
|
107493
108910
|
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`).
|
|
107494
108911
|
*/
|
|
107495
108912
|
$all?: boolean;
|
|
108913
|
+
/**
|
|
108914
|
+
* For EACH ITEM in the collection: Specifies a BorderCollection object that represents all the borders for the specified style.
|
|
108915
|
+
*
|
|
108916
|
+
* @remarks
|
|
108917
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
108918
|
+
* @beta
|
|
108919
|
+
*/
|
|
108920
|
+
borders?: Word.Interfaces.BorderCollectionLoadOptions;
|
|
107496
108921
|
/**
|
|
107497
108922
|
* For EACH ITEM in the collection: Gets a font object that represents the character formatting of the specified style.
|
|
107498
108923
|
*
|
|
@@ -107628,6 +109053,14 @@ declare namespace Word {
|
|
|
107628
109053
|
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`).
|
|
107629
109054
|
*/
|
|
107630
109055
|
$all?: boolean;
|
|
109056
|
+
/**
|
|
109057
|
+
* Specifies a BorderCollection object that represents all the borders for the specified style.
|
|
109058
|
+
*
|
|
109059
|
+
* @remarks
|
|
109060
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
109061
|
+
* @beta
|
|
109062
|
+
*/
|
|
109063
|
+
borders?: Word.Interfaces.BorderCollectionLoadOptions;
|
|
107631
109064
|
/**
|
|
107632
109065
|
* Gets a font object that represents the character formatting of the specified style.
|
|
107633
109066
|
*
|
|
@@ -107822,7 +109255,7 @@ declare namespace Word {
|
|
|
107822
109255
|
*/
|
|
107823
109256
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
107824
109257
|
/**
|
|
107825
|
-
* Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
109258
|
+
* Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
107826
109259
|
*
|
|
107827
109260
|
* @remarks
|
|
107828
109261
|
* [Api set: WordApi 1.3]
|
|
@@ -107843,14 +109276,14 @@ declare namespace Word {
|
|
|
107843
109276
|
*/
|
|
107844
109277
|
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
|
|
107845
109278
|
/**
|
|
107846
|
-
* Gets the table cell that contains this table. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
109279
|
+
* Gets the table cell that contains this table. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
107847
109280
|
*
|
|
107848
109281
|
* @remarks
|
|
107849
109282
|
* [Api set: WordApi 1.3]
|
|
107850
109283
|
*/
|
|
107851
109284
|
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
|
|
107852
109285
|
/**
|
|
107853
|
-
* Gets the table that contains this table. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
109286
|
+
* Gets the table that contains this table. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
107854
109287
|
*
|
|
107855
109288
|
* @remarks
|
|
107856
109289
|
* [Api set: WordApi 1.3]
|
|
@@ -108078,7 +109511,7 @@ declare namespace Word {
|
|
|
108078
109511
|
*/
|
|
108079
109512
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
108080
109513
|
/**
|
|
108081
|
-
* For EACH ITEM in the collection: Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
109514
|
+
* For EACH ITEM in the collection: Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
108082
109515
|
*
|
|
108083
109516
|
* @remarks
|
|
108084
109517
|
* [Api set: WordApi 1.3]
|
|
@@ -108099,14 +109532,14 @@ declare namespace Word {
|
|
|
108099
109532
|
*/
|
|
108100
109533
|
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
|
|
108101
109534
|
/**
|
|
108102
|
-
* For EACH ITEM in the collection: Gets the table cell that contains this table. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
109535
|
+
* For EACH ITEM in the collection: Gets the table cell that contains this table. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
108103
109536
|
*
|
|
108104
109537
|
* @remarks
|
|
108105
109538
|
* [Api set: WordApi 1.3]
|
|
108106
109539
|
*/
|
|
108107
109540
|
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
|
|
108108
109541
|
/**
|
|
108109
|
-
* For EACH ITEM in the collection: Gets the table that contains this table. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
109542
|
+
* For EACH ITEM in the collection: Gets the table that contains this table. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
108110
109543
|
*
|
|
108111
109544
|
* @remarks
|
|
108112
109545
|
* [Api set: WordApi 1.3]
|
|
@@ -108607,6 +110040,96 @@ declare namespace Word {
|
|
|
108607
110040
|
*/
|
|
108608
110041
|
width?: boolean;
|
|
108609
110042
|
}
|
|
110043
|
+
/**
|
|
110044
|
+
* Represents a tracked change in a Word document.
|
|
110045
|
+
*
|
|
110046
|
+
* @remarks
|
|
110047
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
110048
|
+
* @beta
|
|
110049
|
+
*/
|
|
110050
|
+
interface TrackedChangeLoadOptions {
|
|
110051
|
+
/**
|
|
110052
|
+
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`).
|
|
110053
|
+
*/
|
|
110054
|
+
$all?: boolean;
|
|
110055
|
+
/**
|
|
110056
|
+
* Specifies the author of the tracked change.
|
|
110057
|
+
*
|
|
110058
|
+
* @remarks
|
|
110059
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
110060
|
+
* @beta
|
|
110061
|
+
*/
|
|
110062
|
+
author?: boolean;
|
|
110063
|
+
/**
|
|
110064
|
+
* Specifies the date of the tracked change.
|
|
110065
|
+
*
|
|
110066
|
+
* @remarks
|
|
110067
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
110068
|
+
* @beta
|
|
110069
|
+
*/
|
|
110070
|
+
date?: boolean;
|
|
110071
|
+
/**
|
|
110072
|
+
* Specifies the text of the tracked change.
|
|
110073
|
+
*
|
|
110074
|
+
* @remarks
|
|
110075
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
110076
|
+
* @beta
|
|
110077
|
+
*/
|
|
110078
|
+
text?: boolean;
|
|
110079
|
+
/**
|
|
110080
|
+
* Specifies the type of the tracked change.
|
|
110081
|
+
*
|
|
110082
|
+
* @remarks
|
|
110083
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
110084
|
+
* @beta
|
|
110085
|
+
*/
|
|
110086
|
+
type?: boolean;
|
|
110087
|
+
}
|
|
110088
|
+
/**
|
|
110089
|
+
* Contains a collection of {@link Word.TrackedChange} objects.
|
|
110090
|
+
*
|
|
110091
|
+
* @remarks
|
|
110092
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
110093
|
+
* @beta
|
|
110094
|
+
*/
|
|
110095
|
+
interface TrackedChangeCollectionLoadOptions {
|
|
110096
|
+
/**
|
|
110097
|
+
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`).
|
|
110098
|
+
*/
|
|
110099
|
+
$all?: boolean;
|
|
110100
|
+
/**
|
|
110101
|
+
* For EACH ITEM in the collection: Specifies the author of the tracked change.
|
|
110102
|
+
*
|
|
110103
|
+
* @remarks
|
|
110104
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
110105
|
+
* @beta
|
|
110106
|
+
*/
|
|
110107
|
+
author?: boolean;
|
|
110108
|
+
/**
|
|
110109
|
+
* For EACH ITEM in the collection: Specifies the date of the tracked change.
|
|
110110
|
+
*
|
|
110111
|
+
* @remarks
|
|
110112
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
110113
|
+
* @beta
|
|
110114
|
+
*/
|
|
110115
|
+
date?: boolean;
|
|
110116
|
+
/**
|
|
110117
|
+
* For EACH ITEM in the collection: Specifies the text of the tracked change.
|
|
110118
|
+
*
|
|
110119
|
+
* @remarks
|
|
110120
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
110121
|
+
* @beta
|
|
110122
|
+
*/
|
|
110123
|
+
text?: boolean;
|
|
110124
|
+
/**
|
|
110125
|
+
* For EACH ITEM in the collection: Specifies the type of the tracked change.
|
|
110126
|
+
*
|
|
110127
|
+
* @remarks
|
|
110128
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
110129
|
+
* @beta
|
|
110130
|
+
*/
|
|
110131
|
+
type?: boolean;
|
|
110132
|
+
}
|
|
108610
110133
|
}
|
|
108611
110134
|
}
|
|
108612
110135
|
declare namespace Word {
|