Partager via


word package

Classes

Word.Application

Représente l’objet d’application.

Word.Body

Représente le corps d’un document ou d’une section.

Word.ContentControl

Représente un contrôle de contenu. Les contrôles de contenu sont des zones d’un document délimitées par des bordures et pouvant porter une étiquette qui servent à contenir certains types de contenu. Les contrôles de contenu individuels peuvent contenir des images, des tableaux ou des paragraphes de texte mis en forme. Actuellement, seuls les contrôles de texte enrichi, de texte brut et de contenu de case à cocher sont pris en charge.

Word.ContentControlCollection

Contient une collection de Word. Objets ContentControl. Les contrôles de contenu sont des régions liées et potentiellement étiquetées d’un document qui servent de conteneur pour des types de contenu spécifiques. Les contrôles de contenu individuels peuvent contenir des images, des tableaux ou des paragraphes de texte mis en forme. Actuellement, seuls les contrôles de texte enrichi et de contenu en texte brut sont pris en charge.

Word.CustomProperty

Représente une propriété personnalisée.

Word.CustomPropertyCollection

Contient la collection de Word. Objets CustomProperty.

Word.Document

L’objet Document est l’objet de niveau supérieur. Un objet Document comporte des sections, des contrôles de contenu et le corps dans lequel se trouve le contenu du document.

Word.DocumentCreated

L’objet DocumentCreated est l’objet de niveau supérieur créé par Application.CreateDocument. Un objet DocumentCreated est un objet Document spécial.

Word.DocumentProperties

Représente les propriétés du document.

Word.Font

Représente une police.

Word.InlinePicture

Représente une image incluse.

Word.InlinePictureCollection

Contient une collection de Word. Objets InlinePicture.

Word.List

Contient une collection de Word. Objets de paragraphe.

Word.ListCollection

Contient une collection de Word. Répertorier les objets.

Word.ListItem

Représente le format d’élément de liste de paragraphes.

Word.Paragraph

Représente un seul paragraphe dans une sélection, une plage, un contrôle de contenu ou le corps d’un document.

Word.ParagraphCollection

Contient une collection de Word. Objets de paragraphe.

Word.Range

Représente une zone contiguë dans un document.

Word.RangeCollection

Contient une collection de Word. Objets de plage.

Word.RequestContext

L’objet RequestContext facilite les requêtes adressées à l’application Word. Étant donné que le complément Office et l’application Word s’exécutent dans deux processus différents, le contexte de demande est nécessaire pour obtenir l’accès au modèle objet Word à partir du complément.

Word.SearchOptions

Spécifie les options à inclure dans une opération de recherche. Pour en savoir plus sur l’utilisation des options de recherche dans les API JavaScript Word, consultez Utiliser les options de recherche pour rechercher du texte dans votre complément Word.

Word.Section

Représente une section d’un document Word.

Word.SectionCollection

Contient la collection des Word du document. Objets de section.

Word.Style

Représente un style dans un document Word.

Word.Table

Représente un tableau dans un document Word.

Word.TableBorder

Spécifie le style de bordure.

Word.TableCell

Représente une cellule de tableau dans un document Word.

Word.TableCellCollection

Contient la collection des objets TableCell du document.

Word.TableCollection

Contient la collection des objets Table du document.

Word.TableRow

Représente une ligne dans un document Word.

Word.TableRowCollection

Contient la collection des objets TableRow du document.

Interfaces

Word.Interfaces.AnnotationCollectionData

Interface décrivant les données retournées en appelant annotationCollection.toJSON().

Word.Interfaces.AnnotationCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet AnnotationCollection , à utiliser dans annotationCollection.set({ ... }).

Word.Interfaces.AnnotationData

Interface décrivant les données retournées en appelant annotation.toJSON().

Word.Interfaces.BodyData

Interface décrivant les données retournées en appelant body.toJSON().

Word.Interfaces.BodyLoadOptions

Représente le corps d’un document ou d’une section.

Word.Interfaces.BodyUpdateData

Interface permettant de mettre à jour les données sur l’objet Body , à utiliser dans body.set({ ... }).

Word.Interfaces.BorderCollectionData

Interface décrivant les données retournées en appelant borderCollection.toJSON().

Word.Interfaces.BorderCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet BorderCollection , à utiliser dans borderCollection.set({ ... }).

Word.Interfaces.BorderData

Interface décrivant les données retournées en appelant border.toJSON().

Word.Interfaces.BorderUpdateData

Interface permettant de mettre à jour les données sur l’objet Border , à utiliser dans border.set({ ... }).

Word.Interfaces.CheckboxContentControlData

Interface décrivant les données retournées en appelant checkboxContentControl.toJSON().

Word.Interfaces.CheckboxContentControlUpdateData

Interface permettant de mettre à jour les données sur l’objet CheckboxContentControl , à utiliser dans checkboxContentControl.set({ ... }).

Word.Interfaces.CollectionLoadOptions

Fournit des moyens de charger les propriétés d’un sous-ensemble de membres d’une collection uniquement.

Word.Interfaces.ComboBoxContentControlData

Interface décrivant les données retournées en appelant comboBoxContentControl.toJSON().

Word.Interfaces.CommentCollectionData

Interface décrivant les données retournées en appelant commentCollection.toJSON().

Word.Interfaces.CommentCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet CommentCollection , à utiliser dans commentCollection.set({ ... }).

Word.Interfaces.CommentContentRangeData

Interface décrivant les données retournées en appelant commentContentRange.toJSON().

Word.Interfaces.CommentContentRangeUpdateData

Interface permettant de mettre à jour les données sur l’objet CommentContentRange , à utiliser dans commentContentRange.set({ ... }).

Word.Interfaces.CommentData

Interface décrivant les données retournées en appelant comment.toJSON().

Word.Interfaces.CommentReplyCollectionData

Interface décrivant les données retournées en appelant commentReplyCollection.toJSON().

Word.Interfaces.CommentReplyCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet CommentReplyCollection , à utiliser dans commentReplyCollection.set({ ... }).

Word.Interfaces.CommentReplyData

Interface décrivant les données retournées en appelant commentReply.toJSON().

Word.Interfaces.CommentReplyUpdateData

Interface permettant de mettre à jour les données sur l’objet CommentReply , à utiliser dans commentReply.set({ ... }).

Word.Interfaces.CommentUpdateData

Interface permettant de mettre à jour les données sur l’objet Comment , à utiliser dans comment.set({ ... }).

Word.Interfaces.ContentControlCollectionData

Interface décrivant les données retournées en appelant contentControlCollection.toJSON().

Word.Interfaces.ContentControlCollectionLoadOptions

Contient une collection de Word. Objets ContentControl. Les contrôles de contenu sont des régions liées et potentiellement étiquetées d’un document qui servent de conteneur pour des types de contenu spécifiques. Les contrôles de contenu individuels peuvent contenir des images, des tableaux ou des paragraphes de texte mis en forme. Actuellement, seuls les contrôles de texte enrichi et de contenu en texte brut sont pris en charge.

Word.Interfaces.ContentControlCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet ContentControlCollection , à utiliser dans contentControlCollection.set({ ... }).

Word.Interfaces.ContentControlData

Interface décrivant les données retournées en appelant contentControl.toJSON().

Word.Interfaces.ContentControlListItemCollectionData

Interface décrivant les données retournées en appelant contentControlListItemCollection.toJSON().

Word.Interfaces.ContentControlListItemCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet ContentControlListItemCollection , à utiliser dans contentControlListItemCollection.set({ ... }).

Word.Interfaces.ContentControlListItemData

Interface décrivant les données retournées en appelant contentControlListItem.toJSON().

Word.Interfaces.ContentControlListItemUpdateData

Interface permettant de mettre à jour les données sur l’objet ContentControlListItem , à utiliser dans contentControlListItem.set({ ... }).

Word.Interfaces.ContentControlLoadOptions

Représente un contrôle de contenu. Les contrôles de contenu sont des zones d’un document délimitées par des bordures et pouvant porter une étiquette qui servent à contenir certains types de contenu. Les contrôles de contenu individuels peuvent contenir des images, des tableaux ou des paragraphes de texte mis en forme. Actuellement, seuls les contrôles de texte enrichi, de texte brut et de contenu de case à cocher sont pris en charge.

Word.Interfaces.ContentControlUpdateData

Interface permettant de mettre à jour les données sur l’objet ContentControl , à utiliser dans contentControl.set({ ... }).

Word.Interfaces.CritiqueAnnotationData

Interface décrivant les données retournées en appelant critiqueAnnotation.toJSON().

Word.Interfaces.CustomPropertyCollectionData

Interface décrivant les données retournées en appelant customPropertyCollection.toJSON().

Word.Interfaces.CustomPropertyCollectionLoadOptions

Contient la collection de Word. Objets CustomProperty.

Word.Interfaces.CustomPropertyCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet CustomPropertyCollection , à utiliser dans customPropertyCollection.set({ ... }).

Word.Interfaces.CustomPropertyData

Interface décrivant les données retournées en appelant customProperty.toJSON().

Word.Interfaces.CustomPropertyLoadOptions

Représente une propriété personnalisée.

Word.Interfaces.CustomPropertyUpdateData

Interface permettant de mettre à jour les données sur l’objet CustomProperty , à utiliser dans customProperty.set({ ... }).

Word.Interfaces.CustomXmlPartCollectionData

Interface décrivant les données retournées en appelant customXmlPartCollection.toJSON().

Word.Interfaces.CustomXmlPartCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet CustomXmlPartCollection , à utiliser dans customXmlPartCollection.set({ ... }).

Word.Interfaces.CustomXmlPartData

Interface décrivant les données retournées en appelant customXmlPart.toJSON().

Word.Interfaces.CustomXmlPartScopedCollectionData

Interface décrivant les données retournées en appelant customXmlPartScopedCollection.toJSON().

Word.Interfaces.CustomXmlPartScopedCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet CustomXmlPartScopedCollection , à utiliser dans customXmlPartScopedCollection.set({ ... }).

Word.Interfaces.DocumentCreatedData

Interface décrivant les données retournées en appelant documentCreated.toJSON().

Word.Interfaces.DocumentCreatedLoadOptions

L’objet DocumentCreated est l’objet de niveau supérieur créé par Application.CreateDocument. Un objet DocumentCreated est un objet Document spécial.

Word.Interfaces.DocumentCreatedUpdateData

Interface permettant de mettre à jour les données sur l’objet DocumentCreated , à utiliser dans documentCreated.set({ ... }).

Word.Interfaces.DocumentData

Interface décrivant les données retournées en appelant document.toJSON().

Word.Interfaces.DocumentLoadOptions

L’objet Document est l’objet de niveau supérieur. Un objet Document comporte des sections, des contrôles de contenu et le corps dans lequel se trouve le contenu du document.

Word.Interfaces.DocumentPropertiesData

Interface décrivant les données retournées en appelant documentProperties.toJSON().

Word.Interfaces.DocumentPropertiesLoadOptions

Représente les propriétés du document.

Word.Interfaces.DocumentPropertiesUpdateData

Interface permettant de mettre à jour les données sur l’objet DocumentProperties , à utiliser dans documentProperties.set({ ... }).

Word.Interfaces.DocumentUpdateData

Interface permettant de mettre à jour les données sur l’objet Document , à utiliser dans document.set({ ... }).

Word.Interfaces.DropDownListContentControlData

Interface décrivant les données retournées en appelant dropDownListContentControl.toJSON().

Word.Interfaces.FieldCollectionData

Interface décrivant les données retournées en appelant fieldCollection.toJSON().

Word.Interfaces.FieldCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet FieldCollection , à utiliser dans fieldCollection.set({ ... }).

Word.Interfaces.FieldData

Interface décrivant les données retournées en appelant field.toJSON().

Word.Interfaces.FieldUpdateData

Interface permettant de mettre à jour les données sur l’objet Field , à utiliser dans field.set({ ... }).

Word.Interfaces.FontData

Interface décrivant les données retournées en appelant font.toJSON().

Word.Interfaces.FontLoadOptions

Représente une police.

Word.Interfaces.FontUpdateData

Interface permettant de mettre à jour les données sur l’objet Font , à utiliser dans font.set({ ... }).

Word.Interfaces.InlinePictureCollectionData

Interface décrivant les données retournées en appelant inlinePictureCollection.toJSON().

Word.Interfaces.InlinePictureCollectionLoadOptions

Contient une collection de Word. Objets InlinePicture.

Word.Interfaces.InlinePictureCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet InlinePictureCollection , à utiliser dans inlinePictureCollection.set({ ... }).

Word.Interfaces.InlinePictureData

Interface décrivant les données retournées en appelant inlinePicture.toJSON().

Word.Interfaces.InlinePictureLoadOptions

Représente une image incluse.

Word.Interfaces.InlinePictureUpdateData

Interface permettant de mettre à jour les données sur l’objet InlinePicture , à utiliser dans inlinePicture.set({ ... }).

Word.Interfaces.ListCollectionData

Interface décrivant les données retournées en appelant listCollection.toJSON().

Word.Interfaces.ListCollectionLoadOptions

Contient une collection de Word. Répertorier les objets.

Word.Interfaces.ListCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet ListCollection , à utiliser dans listCollection.set({ ... }).

Word.Interfaces.ListData

Interface décrivant les données retournées en appelant list.toJSON().

Word.Interfaces.ListItemData

Interface décrivant les données retournées en appelant listItem.toJSON().

Word.Interfaces.ListItemLoadOptions

Représente le format d’élément de liste de paragraphes.

Word.Interfaces.ListItemUpdateData

Interface permettant de mettre à jour les données sur l’objet ListItem , à utiliser dans listItem.set({ ... }).

Word.Interfaces.ListLevelCollectionData

Interface décrivant les données retournées en appelant listLevelCollection.toJSON().

Word.Interfaces.ListLevelCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet ListLevelCollection , à utiliser dans listLevelCollection.set({ ... }).

Word.Interfaces.ListLevelData

Interface décrivant les données retournées en appelant listLevel.toJSON().

Word.Interfaces.ListLevelUpdateData

Interface permettant de mettre à jour les données sur l’objet ListLevel , à utiliser dans listLevel.set({ ... }).

Word.Interfaces.ListLoadOptions

Contient une collection de Word. Objets de paragraphe.

Word.Interfaces.ListTemplateData

Interface décrivant les données retournées en appelant listTemplate.toJSON().

Word.Interfaces.ListTemplateUpdateData

Interface permettant de mettre à jour les données sur l’objet ListTemplate , à utiliser dans listTemplate.set({ ... }).

Word.Interfaces.NoteItemCollectionData

Interface décrivant les données retournées en appelant noteItemCollection.toJSON().

Word.Interfaces.NoteItemCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet NoteItemCollection , à utiliser dans noteItemCollection.set({ ... }).

Word.Interfaces.NoteItemData

Interface décrivant les données retournées en appelant noteItem.toJSON().

Word.Interfaces.NoteItemUpdateData

Interface permettant de mettre à jour les données sur l’objet NoteItem , à utiliser dans noteItem.set({ ... }).

Word.Interfaces.ParagraphCollectionData

Interface décrivant les données retournées en appelant paragraphCollection.toJSON().

Word.Interfaces.ParagraphCollectionLoadOptions

Contient une collection de Word. Objets de paragraphe.

Word.Interfaces.ParagraphCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet ParagraphCollection , à utiliser dans paragraphCollection.set({ ... }).

Word.Interfaces.ParagraphData

Interface décrivant les données retournées en appelant paragraph.toJSON().

Word.Interfaces.ParagraphFormatData

Interface décrivant les données retournées en appelant paragraphFormat.toJSON().

Word.Interfaces.ParagraphFormatUpdateData

Interface permettant de mettre à jour les données sur l’objet ParagraphFormat , à utiliser dans paragraphFormat.set({ ... }).

Word.Interfaces.ParagraphLoadOptions

Représente un seul paragraphe dans une sélection, une plage, un contrôle de contenu ou le corps d’un document.

Word.Interfaces.ParagraphUpdateData

Interface permettant de mettre à jour les données sur l’objet Paragraph , à utiliser dans paragraph.set({ ... }).

Word.Interfaces.RangeCollectionData

Interface décrivant les données retournées en appelant rangeCollection.toJSON().

Word.Interfaces.RangeCollectionLoadOptions

Contient une collection de Word. Objets de plage.

Word.Interfaces.RangeCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet RangeCollection , à utiliser dans rangeCollection.set({ ... }).

Word.Interfaces.RangeData

Interface décrivant les données retournées en appelant range.toJSON().

Word.Interfaces.RangeLoadOptions

Représente une zone contiguë dans un document.

Word.Interfaces.RangeUpdateData

Interface permettant de mettre à jour les données sur l’objet Range , à utiliser dans range.set({ ... }).

Word.Interfaces.SearchOptionsData

Interface décrivant les données retournées en appelant searchOptions.toJSON().

Word.Interfaces.SearchOptionsLoadOptions

Spécifie les options à inclure dans une opération de recherche. Pour en savoir plus sur l’utilisation des options de recherche dans les API JavaScript Word, consultez Utiliser les options de recherche pour rechercher du texte dans votre complément Word.

Word.Interfaces.SearchOptionsUpdateData

Interface permettant de mettre à jour les données sur l’objet SearchOptions , à utiliser dans searchOptions.set({ ... }).

Word.Interfaces.SectionCollectionData

Interface décrivant les données retournées en appelant sectionCollection.toJSON().

Word.Interfaces.SectionCollectionLoadOptions

Contient la collection des Word du document. Objets de section.

Word.Interfaces.SectionCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet SectionCollection , à utiliser dans sectionCollection.set({ ... }).

Word.Interfaces.SectionData

Interface décrivant les données retournées en appelant section.toJSON().

Word.Interfaces.SectionLoadOptions

Représente une section d’un document Word.

Word.Interfaces.SectionUpdateData

Interface permettant de mettre à jour les données sur l’objet Section , à utiliser dans section.set({ ... }).

Word.Interfaces.SettingCollectionData

Interface décrivant les données retournées en appelant settingCollection.toJSON().

Word.Interfaces.SettingCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet SettingCollection , à utiliser dans settingCollection.set({ ... }).

Word.Interfaces.SettingData

Interface décrivant les données retournées en appelant setting.toJSON().

Word.Interfaces.SettingUpdateData

Interface permettant de mettre à jour les données sur l’objet Setting , à utiliser dans setting.set({ ... }).

Word.Interfaces.ShadingData

Interface décrivant les données retournées en appelant shading.toJSON().

Word.Interfaces.ShadingUpdateData

Interface permettant de mettre à jour les données sur l’objet Shading , à utiliser dans shading.set({ ... }).

Word.Interfaces.StyleCollectionData

Interface décrivant les données retournées en appelant styleCollection.toJSON().

Word.Interfaces.StyleCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet StyleCollection , à utiliser dans styleCollection.set({ ... }).

Word.Interfaces.StyleData

Interface décrivant les données retournées en appelant style.toJSON().

Word.Interfaces.StyleLoadOptions

Représente un style dans un document Word.

Word.Interfaces.StyleUpdateData

Interface permettant de mettre à jour les données sur l’objet Style , à utiliser dans style.set({ ... }).

Word.Interfaces.TableBorderData

Interface décrivant les données retournées en appelant tableBorder.toJSON().

Word.Interfaces.TableBorderLoadOptions

Spécifie le style de bordure.

Word.Interfaces.TableBorderUpdateData

Interface permettant de mettre à jour les données sur l’objet TableBorder , à utiliser dans tableBorder.set({ ... }).

Word.Interfaces.TableCellCollectionData

Interface décrivant les données retournées en appelant tableCellCollection.toJSON().

Word.Interfaces.TableCellCollectionLoadOptions

Contient la collection des objets TableCell du document.

Word.Interfaces.TableCellCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet TableCellCollection , à utiliser dans tableCellCollection.set({ ... }).

Word.Interfaces.TableCellData

Interface décrivant les données retournées en appelant tableCell.toJSON().

Word.Interfaces.TableCellLoadOptions

Représente une cellule de tableau dans un document Word.

Word.Interfaces.TableCellUpdateData

Interface permettant de mettre à jour les données sur l’objet TableCell , à utiliser dans tableCell.set({ ... }).

Word.Interfaces.TableCollectionData

Interface décrivant les données retournées en appelant tableCollection.toJSON().

Word.Interfaces.TableCollectionLoadOptions

Contient la collection des objets Table du document.

Word.Interfaces.TableCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet TableCollection , à utiliser dans tableCollection.set({ ... }).

Word.Interfaces.TableData

Interface décrivant les données retournées en appelant table.toJSON().

Word.Interfaces.TableLoadOptions

Représente un tableau dans un document Word.

Word.Interfaces.TableRowCollectionData

Interface décrivant les données retournées en appelant tableRowCollection.toJSON().

Word.Interfaces.TableRowCollectionLoadOptions

Contient la collection des objets TableRow du document.

Word.Interfaces.TableRowCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet TableRowCollection , à utiliser dans tableRowCollection.set({ ... }).

Word.Interfaces.TableRowData

Interface décrivant les données retournées en appelant tableRow.toJSON().

Word.Interfaces.TableRowLoadOptions

Représente une ligne dans un document Word.

Word.Interfaces.TableRowUpdateData

Interface permettant de mettre à jour les données sur l’objet TableRow , à utiliser dans tableRow.set({ ... }).

Word.Interfaces.TableStyleData

Interface décrivant les données retournées en appelant tableStyle.toJSON().

Word.Interfaces.TableStyleUpdateData

Interface permettant de mettre à jour les données sur l’objet TableStyle , à utiliser dans tableStyle.set({ ... }).

Word.Interfaces.TableUpdateData

Interface permettant de mettre à jour les données sur l’objet Table , à utiliser dans table.set({ ... }).

Word.Interfaces.TrackedChangeCollectionData

Interface décrivant les données retournées en appelant trackedChangeCollection.toJSON().

Word.Interfaces.TrackedChangeCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet TrackedChangeCollection , à utiliser dans trackedChangeCollection.set({ ... }).

Word.Interfaces.TrackedChangeData

Interface décrivant les données retournées en appelant trackedChange.toJSON().

Énumérations

Word.Alignment
Word.BodyType
Word.BorderLocation
Word.BorderType
Word.BreakType

Spécifie la forme d’un saut.

Word.BuiltInStyleName

Représente le style intégré dans un document Word.

Word.CellPaddingLocation
Word.ContentControlAppearance

Apparence de ContentControl.

Word.ContentControlType

Spécifie les types et sous-types de contrôle de contenu pris en charge.

Word.DocumentPropertyType
Word.ErrorCodes
Word.HeaderFooterType
Word.InsertLocation

Types d’emplacement d’insertion.

Word.ListBullet
Word.ListLevelType
Word.ListNumbering
Word.LocationRelation
Word.RangeLocation
Word.SaveBehavior

Spécifie le comportement d’enregistrement pour Document.save.

Word.SelectionMode

Cette énumération définit l’emplacement du curseur (point d’insertion) dans le document après une sélection.

Word.UnderlineType

Styles pris en charge pour le format de soulignement.

Word.VerticalAlignment

Functions

Word.run(objects, batch)

Exécute un script de traitement par lots qui effectue des actions sur le modèle objet Word, à l’aide du RequestContext des objets API créés précédemment.

Word.run(object, batch)

Exécute un script de traitement par lots qui effectue des actions sur le modèle objet Word, à l’aide du RequestContext d’un objet API créé précédemment. Une fois la promesse résolue, tous les objets suivis qui ont été alloués automatiquement pendant l’exécution sont libérés.

Word.run(batch)

Exécute un script de traitement par lots qui effectue des actions sur le modèle objet Word, à l’aide d’un nouveau RequestContext. Une fois la promesse résolue, tous les objets suivis qui ont été alloués automatiquement pendant l’exécution sont libérés.

Informations relatives à la fonction

Word.run(objects, batch)

Exécute un script de traitement par lots qui effectue des actions sur le modèle objet Word, à l’aide du RequestContext des objets API créés précédemment.

export function run<T>(objects: OfficeExtension.ClientObject[], batch: (context: Word.RequestContext) => Promise<T>): Promise<T>;

Paramètres

objects

OfficeExtension.ClientObject[]

Tableau d’objets API créés précédemment. Le tableau est validé pour s’assurer que tous les objets partagent le même contexte. Le lot utilise ce RequestContext partagé, ce qui signifie que toutes les modifications appliquées à ces objets seront récupérées par context.sync().

batch

(context: Word.RequestContext) => Promise<T>

Fonction qui accepte un RequestContext et retourne une promesse (en général, juste le résultat de context.sync()). Le paramètre de contexte facilite les requêtes adressées à l’application Word. Étant donné que le complément Office et l’application Word s’exécutent dans deux processus différents, requestContext est requis pour obtenir l’accès au modèle objet Word à partir du complément.

Retours

Promise<T>

Word.run(object, batch)

Exécute un script de traitement par lots qui effectue des actions sur le modèle objet Word, à l’aide du RequestContext d’un objet API créé précédemment. Une fois la promesse résolue, tous les objets suivis qui ont été alloués automatiquement pendant l’exécution sont libérés.

export function run<T>(object: OfficeExtension.ClientObject, batch: (context: Word.RequestContext) => Promise<T>): Promise<T>;

Paramètres

object
OfficeExtension.ClientObject

Objet API créé précédemment. Le lot utilise le même RequestContext que l’objet passé, ce qui signifie que toutes les modifications appliquées à l’objet seront récupérées par context.sync().

batch

(context: Word.RequestContext) => Promise<T>

Fonction qui accepte un RequestContext et retourne une promesse (en général, juste le résultat de context.sync()). Le paramètre de contexte facilite les requêtes adressées à l’application Word. Étant donné que le complément Office et l’application Word s’exécutent dans deux processus différents, requestContext est requis pour obtenir l’accès au modèle objet Word à partir du complément.

Retours

Promise<T>

Word.run(batch)

Exécute un script de traitement par lots qui effectue des actions sur le modèle objet Word, à l’aide d’un nouveau RequestContext. Une fois la promesse résolue, tous les objets suivis qui ont été alloués automatiquement pendant l’exécution sont libérés.

export function run<T>(batch: (context: Word.RequestContext) => Promise<T>): Promise<T>;

Paramètres

batch

(context: Word.RequestContext) => Promise<T>

Fonction qui accepte un RequestContext et retourne une promesse (en général, juste le résultat de context.sync()). Le paramètre de contexte facilite les requêtes adressées à l’application Word. Étant donné que le complément Office et l’application Word s’exécutent dans deux processus différents, requestContext est requis pour obtenir l’accès au modèle objet Word à partir du complément.

Retours

Promise<T>