word package
Classes
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.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.Font |
Représente une police. |
Word.InlinePicture |
Représente une image incluse. |
Word.InlinePictureCollection |
Contient une collection de Word. Objets InlinePicture. |
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. |
Interfaces
Word.Interfaces.AnnotationCollectionData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.AnnotationCollectionUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.AnnotationData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.BodyData |
Interface décrivant les données retournées en appelant |
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 |
Word.Interfaces.BorderCollectionData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.BorderCollectionUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.BorderData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.BorderUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.CheckboxContentControlData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.CheckboxContentControlUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
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 |
Word.Interfaces.CommentCollectionData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.CommentCollectionUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.CommentContentRangeData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.CommentContentRangeUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.CommentData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.CommentReplyCollectionData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.CommentReplyCollectionUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.CommentReplyData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.CommentReplyUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.CommentUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.ContentControlCollectionData |
Interface décrivant les données retournées en appelant |
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 |
Word.Interfaces.ContentControlData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.ContentControlListItemCollectionData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.ContentControlListItemCollectionUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.ContentControlListItemData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.ContentControlListItemUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
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 |
Word.Interfaces.CritiqueAnnotationData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.CustomPropertyCollectionData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.CustomPropertyCollectionUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.CustomPropertyData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.CustomPropertyUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.CustomXmlPartCollectionData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.CustomXmlPartCollectionUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.CustomXmlPartData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.CustomXmlPartScopedCollectionData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.CustomXmlPartScopedCollectionUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.DocumentCreatedData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.DocumentCreatedUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.DocumentData |
Interface décrivant les données retournées en appelant |
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 |
Word.Interfaces.DocumentPropertiesUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.DocumentUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.DropDownListContentControlData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.FieldCollectionData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.FieldCollectionUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.FieldData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.FieldUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.FontData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.FontLoadOptions |
Représente une police. |
Word.Interfaces.FontUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.InlinePictureCollectionData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.InlinePictureCollectionLoadOptions |
Contient une collection de Word. Objets InlinePicture. |
Word.Interfaces.InlinePictureCollectionUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.InlinePictureData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.InlinePictureLoadOptions |
Représente une image incluse. |
Word.Interfaces.InlinePictureUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.ListCollectionData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.ListCollectionUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.ListData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.ListItemData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.ListItemUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.ListLevelCollectionData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.ListLevelCollectionUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.ListLevelData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.ListLevelUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.ListTemplateData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.ListTemplateUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.NoteItemCollectionData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.NoteItemCollectionUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.NoteItemData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.NoteItemUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.ParagraphCollectionData |
Interface décrivant les données retournées en appelant |
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 |
Word.Interfaces.ParagraphData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.ParagraphFormatData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.ParagraphFormatUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
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 |
Word.Interfaces.RangeCollectionData |
Interface décrivant les données retournées en appelant |
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 |
Word.Interfaces.RangeData |
Interface décrivant les données retournées en appelant |
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 |
Word.Interfaces.SearchOptionsData |
Interface décrivant les données retournées en appelant |
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 |
Word.Interfaces.SectionCollectionData |
Interface décrivant les données retournées en appelant |
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 |
Word.Interfaces.SectionData |
Interface décrivant les données retournées en appelant |
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 |
Word.Interfaces.SettingCollectionData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.SettingCollectionUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.SettingData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.SettingUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.ShadingData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.ShadingUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.StyleCollectionData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.StyleCollectionUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.StyleData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.StyleUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.TableBorderData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.TableBorderUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.TableCellCollectionData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.TableCellCollectionUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.TableCellData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.TableCellUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.TableCollectionData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.TableCollectionUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.TableData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.TableRowCollectionData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.TableRowCollectionUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.TableRowData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.TableRowUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.TableStyleData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.TableStyleUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.TableUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.TrackedChangeCollectionData |
Interface décrivant les données retournées en appelant |
Word.Interfaces.TrackedChangeCollectionUpdateData |
Interface permettant de mettre à jour les données sur l’objet |
Word.Interfaces.TrackedChangeData |
Interface décrivant les données retournées en appelant |
Énumérations
Word.Alignment | |
Word.BreakType |
Spécifie la forme d’un saut. |
Word.ContentControlAppearance |
Apparence de ContentControl. |
Word.ContentControlType |
Spécifie les types et sous-types de contrôle de contenu pris en charge. |
Word.ErrorCodes | |
Word.HeaderFooterType | |
Word.InsertLocation |
Types d’emplacement d’insertion. |
Word.SaveBehavior |
Spécifie le comportement d’enregistrement pour |
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. |
Functions
Word. |
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. |
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. |
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
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>