Microsoft Méthodes du connecteur Word

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 12 minutes de lecture

    • Les Microsoft méthodes de connecteur Word vous permettent d’effectuer diverses tâches quotidiennes avec des documents Microsoft Word et de les automatiser. Par exemple, ajoutez un pied de page.

    Ouvert

    Ouvre un Microsoft fichier Word enregistré sur le disque local.
    Remarque :
    Vous devez exécuter cette méthode avant d’exécuter toute autre méthode sur le connecteur Microsoft Word.
    Tableau 1. Paramètres de méthode ouverte
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire?
    Chemin d’accès au fichier Spécifie le chemin d’accès au Microsoft fichier Word sur le disque local. Données dans Chaîne Aucune valeur par défaut Oui
    Délai Spécifie le délai après lequel l’opération expire. Données dans Entier Aucune valeur par défaut Non
    Mot de passe Utilisez un mot de passe si le document est protégé par un mot de passe. Données dans Chaîne Aucun Non
    Retour Renvoie la valeur booléenne en fonction du résultat de l’opération. Si la valeur est Vrai, le fichier est ouvert. Sinon, si la valeur est Faux, le fichier n’a pas pu s’ouvrir. Sortie de données Booléen Non applicable Non applicable

    Pour plus de détails sur les problèmes liés à la méthode Open, consultez l’article KB1123558 de la base de connaissances et l’article de la base de connaissances KB1123548.

    Ajouter un pied de page

    Ajoute un pied de page au Microsoft document Word dans la taille de police spécifiée.

    Pour utiliser cette méthode, indiquez le texte à ajouter au paramètre Texte et la taille de police dans laquelle le texte de pied de page doit être affiché dans le paramètre FontSize. La valeur par défaut du paramètre FontSize est 12.

    Remarque :
    Vous devez exécuter la méthode Open avant d’exécuter cette méthode.
    Tableau 2. Paramètres de méthode AddFooter
    Paramètre Description Type de port de données Type de données
    Texte Spécifie le texte dans le pied de page. Données dans Chaîne
    Taille de police Spécifie la taille de la police du texte dans le pied de page. La valeur par défaut est 12. Données dans Entier

    Pour fournir des entrées, consultez Configurer les propriétés des ports

    AddHeader (en-tête)

    Ajoute un en-tête à un document Word dans la Microsoft taille de police spécifiée.

    Pour utiliser cette méthode, indiquez le texte à ajouter au paramètre Texte et la taille de police dans laquelle le texte d’en-tête doit être affiché dans le paramètre FontSize. La valeur par défaut du paramètre FontSize est 12.

    Remarque :
    Vous devez exécuter la méthode Open avant d’exécuter cette méthode.
    Tableau 3. Paramètres de méthode AddHeader
    Paramètre Description Type de port de données Type de données
    Texte Spécifie le texte dans l’en-tête. Données dans Chaîne
    Taille de police Spécifie la taille de la police du texte dans l’en-tête. La valeur par défaut est 12. Données dans Entier

    Copie cellule

    Copie le contenu d’une cellule de tableau identifié à l’aide de l’index de ligne et de l’index de colonne du tableau d’un Microsoft Mot document.

    Pour utiliser cette méthode, fournissez l’index de ligne au paramètre RowIndex et l’index de colonne au paramètre ColumnIndex. La valeur par défaut pour RowIndex et ColumnIndex est -1 chacun.

    Remarque :
    Vous devez exécuter la méthode SetTable avant d’exécuter cette méthode.
    Tableau 4. Paramètres de la méthode CellCopy
    Paramètre Description Type de port de données Type de données
    Index de ligne Index de la ligne de la cellule à copier. La valeur de l’index de ligne doit être égale ou supérieure à zéro. La valeur par défaut est -1, ce qui signifie qu’aucune cellule n’est disponible. Données dans Entier
    Index de colonne Index de la colonne de la cellule à copier. L’index de colonne doit être égal ou supérieur à zéro. La valeur par défaut est -1, ce qui signifie qu’aucune cellule n’est disponible. Données dans Entier

    Collage de cellule

    Colle le contenu de la cellule de tableau copiée dans une cellule de tableau identifiée à l’aide de l’index de ligne et de l’index de colonne du tableau d’un Microsoft Mot document.

    Pour utiliser cette méthode, fournissez l’index de ligne au paramètre RowIndex et l’index de colonne au paramètre ColumnIndex. La valeur par défaut pour RowIndex et ColumnIndex est -1 chacun.

    Remarque :
    Vous devez exécuter la méthode CellCopy avant d’exécuter cette méthode.
    Tableau 5. Paramètres de la méthode CellPaste
    Paramètre Description Type de port de données Type de données
    Index de ligne Index de la ligne de la cellule dans laquelle les données doivent être collées. La valeur de l’index de ligne doit être égale ou supérieure à zéro. La valeur par défaut est -1, ce qui signifie qu’il n’y a pas de ligne disponible pour coller les données. Données dans Entier
    Index de colonne Index de la colonne de la cellule dans laquelle les données doivent être collées. L’index de colonne doit être égal ou supérieur à zéro. La valeur par défaut est -1, ce qui signifie qu’il n’y a pas de colonne disponible pour coller les données. Données dans Entier

    Fermer

    Ferme le dernier document ouvert Microsoft Mot . Lors de la fermeture du document, il est facultatif d’enregistrer les modifications.

    Si la modification apportée au document Word doit être enregistrée, définissez le paramètre booléen saveChanges sur True, sinon définissez-le sur False. Par défaut, le paramètre booléen saveChanges est défini sur True.

    Remarque :
    Vous devez exécuter la méthode Open avant d’exécuter cette méthode.
    Tableau 6. Paramètres de la méthode de fermeture
    Paramètre Description Type de port de données Type de données
    saveChanges Spécifie si les modifications apportées au document Word doivent être enregistrées avant sa fermeture. Par défaut, elle est définie sur Vrai, ce qui signifie que les changements seront enregistrés avant la fermeture. S’il n’est pas nécessaire d’enregistrer les changements avant la fermeture, affectez-les à Faux. Données dans Booléen

    Colonne de suppression

    Supprime une colonne d’une table en fonction d’une valeur d’index spécifiée de la colonne d’un Microsoft Mot document.

    Pour utiliser cette méthode, indiquez l’index de la colonne à supprimer dans le paramètre ColumnIndex. La valeur par défaut est -1.

    Remarque :
    Vous devez exécuter la méthode SetTable avant d’exécuter cette méthode.
    Tableau 7. Paramètres de la méthode DeleteColumn
    Paramètre Description Type de port de données Type de données
    Index de colonne Index de la colonne à supprimer. L’index de colonne doit être égal ou supérieur à zéro. La valeur par défaut est -1, ce qui signifie qu’il n’y a aucune colonne disponible à supprimer. Données dans Entier

    DeletePage (en anglais seulement)

    Supprime une page en fonction d’une valeur d’index spécifiée d’un Microsoft Mot document.

    Pour utiliser cette méthode, indiquez la valeur d’index de la page qui doit être supprimée dans le paramètre PageIndex.

    Remarque :
    Vous devez exécuter la méthode Open avant d’exécuter cette méthode.
    Tableau 8. Paramètres de méthode DeletePage
    Paramètre Description Type de port de données Type de données
    Index de page Spécifie le numéro d’index de la page qui doit être retirée ou supprimée.

    Si vous ne fournissez pas de numéro d’index, la méthode supprime la première page par défaut.

    		 Données dans Entier

    Ligne de suppression

    Supprime une ligne en fonction de la valeur d’index spécifiée d’une table dans un Microsoft Mot document.

    Pour utiliser cette méthode, indiquez l’index de la ligne à supprimer dans le paramètre RowIndex. La valeur par défaut est -1.

    Remarque :
    Vous devez exécuter la méthode SetTable avant d’exécuter cette méthode.
    Tableau 9. Paramètres de la méthode DeleteRow
    Paramètre Description Type de port de données Type de données
    Index de ligne Index de la ligne à supprimer. La valeur de l’index de ligne doit être égale ou supérieure à zéro. La valeur par défaut est -1, ce qui signifie qu’il n’y a aucune ligne disponible à supprimer. Données dans Entier

    Table de suppression

    Supprime une table d’un Microsoft Mot document.

    Si le document comporte plusieurs tables, la méthode supprime la première table du document.

    Remarque :
    Vous devez exécuter la méthode SetTable avant d’exécuter cette méthode.

    ExportToPDF

    Exporte un Microsoft Mot document vers un document PDF.
    Remarque :
    Vous devez exécuter la méthode Open avant d’exécuter cette méthode.
    Tableau 10. Paramètres de méthode ExportToPDF
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire?
    Chemin d’accès au fichier Spécifie le chemin d’accès à l’emplacement où le document Word est exporté au format PDF. Données dans Chaîne Aucune valeur par défaut Oui

    Rechercher

    Recherche le texte que vous spécifiez dans un Microsoft Mot document et renvoie une réponse booléenne.
    Entrée
    Texte
    Sortie
    Retour (booléen)

    GetCellValueByIndex

    Renvoie la valeur d’une cellule d’un tableau d’un Microsoft Mot document.
    Entrée
    Index de cellule

    Texte de pied de page

    Renvoie le contenu du pied de page d’un Microsoft Mot document.

    Remarque :
    Vous devez exécuter la méthode Open avant d’exécuter cette méthode.
    Sortie
    Retour (chaîne)

    Obtenir un texte en tête

    Renvoie le contenu de l’en-tête dans un Microsoft Mot document.

    Remarque :
    Vous devez exécuter la méthode Open avant d’exécuter cette méthode.
    Sortie
    Retour (chaîne)

    Obtenir PageCount

    Renvoie le nombre de pages d’un Microsoft Mot document.

    Sortie
    Retour (entier)

    GetRowIndexByValue

    Renvoie la valeur d’index de ligne d’une ligne en fonction de la valeur de la ligne.
    Remarque :
    Vous devez exécuter les méthodes GetTable et SetTable avant d’exécuter cette méthode.
    Entrée
    Table, valeur

    Obtenir une table

    Renvoie les données d’une table d’un Microsoft document Word sous forme d’objet de table et de table de données. Si le document contient plusieurs tables, vous pouvez spécifier l’index de table pour identifier la table pour la méthode. Vous pouvez également spécifier le type de table, si nécessaire.

    En fonction de la structure de table, vous pouvez éventuellement configurer le type de table pour la méthode. Pour configurer la table, procédez comme suit.
    1. Cliquez sur l’icône des paramètres de méthode (icône des paramètres de méthode).
    2. Sélectionnez le type de table.
    3. Cliquez sur OK.
    Entrée
    TableIndex, firstRowIsHeader
    Sortie
    Table (objet)
    Données (table de données)

    GetTableCellValues

    Renvoie les valeurs d’une ou de plusieurs cellules du tableau.

    Pour spécifier le nombre de cellules, vous devez configurer les valeurs d’index des cellules. Pour configurer, procédez comme suit.
    1. Cliquez sur l’icône des paramètres de méthode (icône des paramètres de méthode).
    2. Cliquez sur ( Cliquez pour ajouter l’icône d’index de cellule.).
    3. Entrez les valeurs d’index des cellules.
    4. Répétez les étapes pour ajouter d’autres valeurs d’index.
    5. Cliquez sur OK.
    Sortie
    Index de cellule (objet)

    Obtenir le nombre de tables

    Renvoie le nombre de tables dans un Microsoft Mot document. Vous pouvez éventuellement spécifier le type de table pour la méthode à identifier.

    Pour configurer le type de table, procédez comme suit.
    1. Cliquez sur l’icône des paramètres de méthode (icône des paramètres de méthode).
    2. Sélectionnez le type de table.
    3. Cliquez sur OK.
    Sortie
    Retour (entier)

    GetTableRowData (en anglais seulement)

    Renvoie les valeurs d’une ou plusieurs cellules d’une ligne d’un Microsoft document Word. Vous pouvez spécifier les valeurs d’index des cellules de la ligne.

    Vous pouvez configurer les valeurs d’index des cellules d’une ligne. Pour le configurer, procédez comme suit.
    1. Cliquez sur l’icône des paramètres de méthode (icône des paramètres de méthode).
    2. Cliquez sur l’icône Ajouter une valeur d’index (icône Ajouter une valeur d’index).
    3. Saisissez la valeur d’index de la cellule.
    4. Répétez les étapes pour ajouter d’autres valeurs d’index.
    5. Cliquez sur OK.
    Sortie
    Index de ligne (objet)

    Obtenir du texte

    Renvoie tout le contenu textuel d’un Microsoft document Word.

    Tableau 11. Paramètres de méthode GetText
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire?
    Retour Renvoie le texte du document Word. Sortie de données Chaîne Aucune valeur par défaut Non applicable

    InsérerNouvelle colonne

    Insère une nouvelle colonne dans la première table du document en fonction de la valeur d’index de la colonne que vous spécifiez.
    Entrée
    Index de colonne

    Insérer une nouvelle ligne

    Insère une nouvelle ligne en fonction de la valeur de l’index.
    Entrée
    Index de ligne

    Insérer une image

    Insère une image.
    Entrée
    Chemin d’accès au fichier d’image
    Signet

    Table à insérer

    Insère un tableau dans un Microsoft Mot document. Insère un tableau dans un Microsoft document. Vous pouvez éventuellement personnaliser le document en le configurant avant de l’insérer.

    Remarque :
    Avant d’exécuter cette méthode, vous devez exécuter les méthodes GetTable et SetTable.
    Pour personnaliser la table avant l’insertion, procédez comme suit.
    1. Cliquez sur l’icône des paramètres de méthode (icône des paramètres de méthode).
    2. Sélectionnez Inclure les en-têtes.
    3. Sélectionnez le style de bordure et le comportement d’ajustement automatique.
    4. Sélectionnez Inclure les lignes vides.
    5. Pour ignorer des colonnes spécifiques, cliquez sur l’icône Ajouter une valeur d’index (Ajouter une valeur d’index).
    6. Saisissez la valeur d’index de la colonne.
    7. Cliquez sur OK.
    Entrée
    Signet
    Données

    Insérer du texte

    Insère le texte au début du document Word.

    Tableau 12. Paramètres de la méthode InsertText
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire?
    Texte Prend le texte. Données dans Chaîne Aucune valeur par défaut Oui

    IsOpen

    Vérifie si un Microsoft Mot document est ouvert.

    Sortie
    Retour (booléen)

    MergeByCellIndices

    Fusionne la plage de cellules spécifiée sous la forme d’une plage de valeurs d’index.
    Entrée
    StartCellIndex EndCellIndex

    MergeByRowCol

    Fusionne une plage de cellules d’un tableau dans un Microsoft Mot document.
    Entrée
    StartRowIndex, StartColIndex, EndRowIndex, EndColIndex

    Remplacer le signet

    Remplace un signet dans un Microsoft Mot document par le texte spécifié.
    Entrée
    Signet ReplaceText

    Remplacer les signets

    Recherche et remplace plusieurs signets dans un Microsoft Mot document par le texte spécifié.
    Entrée
    Texte
    Fournissez plus de détails sur le texte du signet à remplacer, comme suit :
    1. Double-cliquez sur le composant.
    2. Dans la boîte de dialogue FOURNIR DES ÉTIQUETTES/SIGNETS, cliquez sur l’icône Cliquer pour ajouter une étiquette (icône Cliquez pour ajouter une étiquette.)et entrez le signet pour le remplacer.

      Répétez cette étape pour ajouter d’autres signets.

    3. Cliquez sur OK.

    Texte de pied de page

    Recherche et remplace le texte de pied de page d’un Microsoft Mot document par le texte spécifié.
    Entrée
    Texte de recherche
    Remplacer le texte

    Texte ReplaceHeaderText

    Recherche et remplace le texte d’en-tête d’un Microsoft Mot document par le texte spécifié.
    Entrée
    Texte de recherche
    Remplacer le texte

    Remplacer texte statique

    Recherche et remplace le texte d’un Microsoft Mot document par le texte spécifié. Remplace les signets, les en-têtes ou tout texte en fonction de la configuration.

    Vous devez configurer la méthode avant de l’exécuter. Pour configurer, procédez comme suit.
    1. Cliquez sur l’icône des paramètres de méthode (icône des paramètres de méthode).
    2. Cliquez sur l’icône Ajouter un texte ( Icône Ajouter un texte.)
    3. Saisissez l’en-tête, le signet ou le texte que vous souhaitez remplacer.
    4. Répétez les étapes pour entrer plus de texte.
    5. Cliquez sur OK.
    Entrée
    Objet

    Remplacer le texte

    Recherche et remplace le texte d’un Microsoft Mot document par le texte spécifié.
    Entrée
    Texte de recherche
    Remplacer le texte

    Redimensionner

    Redimensionne la fenêtre d’un Microsoft Mot document.
    Entrée
    Gauche
    Haut
    Largeur
    Hauteur

    Enregistrer

    Enregistre le document ouvert Microsoft Mot .

    Enregistrer sous

    Enregistre le document ouvert Microsoft Mot avec le nom de fichier spécifié.
    Entrée
    Chemin d’accès au fichier

    Réglable

    Définit une table dans un Microsoft Mot document.
    Entrée
    Table

    SetTableCellValues

    Définit le contenu d’une cellule de tableau dans un Microsoft Mot document.

    Fournissez un ou plusieurs index de cellule et types de valeur comme suit :
    1. Double-cliquez sur le composant.
    2. Dans la boîte de dialogue FOURNIR DES INDEX DE CELLULE, cliquez sur l’icône Cliquer pour ajouter un index de cellule (icône Cliquer pour ajouter un index de cellule.) et entrez un index de cellule et sélectionnez un type de valeur.

      Répétez cette étape pour ajouter d’autres index de cellule et types de valeur.

    3. Cliquez sur OK.

    SetTableRowData (en anglais seulement)

    Définit le contenu d’une ligne de tableau dans la feuille de calcul d’un Microsoft Mot document.
    Entrée
    Index de ligne
    Fournissez l’index de colonne comme suit :
    1. Double-cliquez sur le composant.
    2. Dans la boîte de dialogue FOURNIR DES INDEX DE COLONNE, cliquez sur l’icône Cliquer pour ajouter un index de cellule (icône Cliquez pour ajouter un index de cellule.) et entrez un index de colonne.
    3. Cliquez sur OK.