Word.Range class

Référence

Paquet:: word

Représente une zone contiguë dans un document.

Extends: OfficeExtension.ClientObject

Remarques

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml

// Gets the range of the first comment in the selected content.
await Word.run(async (context) => {
  const comment: Word.Comment = context.document.getSelection().getComments().getFirstOrNullObject();
  comment.load("contentRange");
  const range: Word.Range = comment.getRange();
  range.load("text");
  await context.sync();

  if (comment.isNullObject) {
    console.warn("No comments in the selection, so no range to get.");
    return;
  }

  console.log(`Comment location: ${range.text}`);
  const contentRange: Word.CommentContentRange = comment.contentRange;
  console.log("Comment content range:", contentRange);
});

Propriétés

contentControls	Obtient la collection d’objets de contrôle de contenu dans la plage.
context	Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
font	Obtient le format de texte de la plage. Utilisez cette propriété pour obtenir et définir le nom de la police, la taille, la couleur et d’autres propriétés.
hyperlink	Obtient le premier lien hypertexte de la plage ou définit un lien hypertexte sur la plage. Tous les liens hypertexte de la plage sont supprimés lorsque vous définissez un nouveau lien hypertexte sur celle-ci. Utilisez un « # » pour séparer la partie d’adresse de la partie d’emplacement facultative.
inlinePictures	Obtient la collection d’objets image insérée de la plage.
isEmpty	Vérifie si la longueur de la plage est zéro.
lists	Obtient la collection d’objets de liste figurant dans la plage.
paragraphs	Obtient la collection d’objets de paragraphe dans la plage.
parentBody	Obtient le corps parent de la plage.
parentContentControl	Obtient le contrôle de contenu actuellement pris en charge qui contient la plage. Génère une `ItemNotFound` erreur s’il n’existe pas de contrôle de contenu parent.
parentContentControlOrNullObject	Obtient le contrôle de contenu actuellement pris en charge qui contient la plage. S’il n’existe pas de contrôle de contenu parent, cette méthode retourne un objet avec sa `isNullObject` propriété définie sur `true`. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
parentTable	Obtient le tableau qui contient la plage. Génère une `ItemNotFound` erreur si elle n’est pas contenue dans une table.
parentTableCell	Obtient la cellule de tableau qui contient la plage. Génère une `ItemNotFound` erreur si elle n’est pas contenue dans une cellule de tableau.
parentTableCellOrNullObject	Obtient la cellule de tableau qui contient la plage. Si elle n’est pas contenue dans une cellule de tableau, cette méthode renvoie un objet avec sa `isNullObject` propriété définie sur `true`. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
parentTableOrNullObject	Obtient le tableau qui contient la plage. Si elle n’est pas contenue dans une table, cette méthode retourne un objet avec sa `isNullObject` propriété définie sur `true`. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
style	Spécifie le nom de style de la plage. Utilisez cette propriété pour les noms des styles personnalisés et localisés. Pour utiliser les styles prédéfinis qui sont portables entre différents paramètres régionaux, voir la propriété « styleBuiltIn ».
styleBuiltIn	Spécifie le nom de style intégré pour la plage. Utilisez cette propriété pour les styles intégrés qui sont portables entre les paramètres régionaux. Pour utiliser des styles personnalisés ou des noms de style localisés, consultez la propriété « style ».
tables	Obtient la collection d’objets de table dans la plage.
text	Obtient le texte de la plage.

Méthodes

clear()	Efface le contenu de l’objet de plage. L’utilisateur peut effectuer l’opération d’annulation sur le contenu effacé.
compareLocationWith(range)	Compare l’emplacement de la plage à celui d’une autre plage.
delete()	Supprime la plage et son contenu du document.
expandTo(range)	Renvoie une nouvelle plage qui s’étend dans les deux directions à partir de cette plage pour couvrir une autre plage. Cette plage n’est pas modifiée. Génère une `ItemNotFound` erreur si les deux plages n’ont pas d’union.
expandToOrNullObject(range)	Renvoie une nouvelle plage qui s’étend dans les deux directions à partir de cette plage pour couvrir une autre plage. Cette plage n’est pas modifiée. Si les deux plages n’ont pas d’union, cette méthode retourne un objet avec sa `isNullObject` propriété définie sur `true`. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
getHtml()	Obtient une représentation HTML de l’objet de plage. En cas de rendu dans une page web ou une visionneuse HTML, la mise en forme correspond à une correspondance proche, mais pas exacte, pour la mise en forme du document. Cette méthode ne retourne pas exactement le même code HTML pour le même document sur différentes plateformes (Windows, Mac, Word sur le web, etc.). Si vous avez besoin d’une fidélité exacte ou d’une cohérence entre les plateformes, utilisez `Range.getOoxml()` et convertissez le code XML retourné au format HTML.
getHyperlinkRanges()	Obtient les plages enfants d’un lien hypertexte au sein de la plage.
getNextTextRange(endingMarks, trimSpacing)	Obtient la plage de texte suivante à l’aide de signes de ponctuation et/ou d’autres marques de fin. Génère une `ItemNotFound` erreur si cette plage de texte est la dernière.
getNextTextRangeOrNullObject(endingMarks, trimSpacing)	Obtient la plage de texte suivante à l’aide de signes de ponctuation et/ou d’autres marques de fin. Si cette plage de texte est la dernière, cette méthode renvoie un objet avec sa `isNullObject` propriété définie sur `true`. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
getOoxml()	Obtient la représentation OOXML de l’objet de plage.
getRange(rangeLocation)	Clone la plage ou obtient le point de début ou de fin de la plage sous la forme d’une nouvelle plage.
getTextRanges(endingMarks, trimSpacing)	Obtient les plages enfants de texte dans la plage à l’aide de signes de ponctuation et/ou d’autres marques de fin.
insertBreak(breakType, insertLocation)	Insère un saut à l’emplacement spécifié du document principal.
insertContentControl(contentControlType)	Encapsule l’objet Range avec un contrôle de contenu.
insertFileFromBase64(base64File, insertLocation)	Insère un document à l’emplacement spécifié.
insertHtml(html, insertLocation)	Insère du code HTML à l’emplacement spécifié.
insertInlinePictureFromBase64(base64EncodedImage, insertLocation)	Insère une image à l’emplacement spécifié.
insertOoxml(ooxml, insertLocation)	Insère du code OOXML à l’emplacement spécifié.
insertParagraph(paragraphText, insertLocation)	Insère un paragraphe à l’emplacement spécifié.
insertTable(rowCount, columnCount, insertLocation, values)	Insère un tableau avec le nombre spécifié de lignes et de colonnes.
insertText(text, insertLocation)	Insère du texte à l’emplacement spécifié.
intersectWith(range)	Retourne une nouvelle plage en tant qu’intersection de cette plage avec une autre. Cette plage n’est pas modifiée. Génère une `ItemNotFound` erreur si les deux plages ne sont pas superposées ou adjacentes.
intersectWithOrNullObject(range)	Retourne une nouvelle plage en tant qu’intersection de cette plage avec une autre. Cette plage n’est pas modifiée. Si les deux plages ne sont pas superposées ou adjacentes, cette méthode retourne un objet avec sa `isNullObject` propriété définie sur `true`. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
load(options)	Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter `context.sync()` avant de lire les propriétés.
load(propertyNames)	Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter `context.sync()` avant de lire les propriétés.
load(propertyNamesAndPaths)	Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter `context.sync()` avant de lire les propriétés.
search(searchText, searchOptions)	Effectue une recherche avec les SearchOptions spécifiés sur l’étendue de l’objet de plage. Les résultats de la recherche sont un ensemble d’objets de plage.
select(selectionMode)	Sélectionne la plage et y accède via l’interface utilisateur de Word.
select(selectionModeString)	Sélectionne la plage et y accède via l’interface utilisateur de Word.
set(properties, options)	Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.
set(properties)	Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
split(delimiters, multiParagraphs, trimDelimiters, trimSpacing)	Divise la plage en plages enfants à l’aide de délimiteurs.
toJSON()	Remplace la méthode JavaScript `toJSON()` afin de fournir une sortie plus utile lorsqu’un objet API est passé à `JSON.stringify()`. (`JSON.stringify`, à son tour, appelle la `toJSON` méthode de l’objet qui lui est passé.) Alors que l’objet d’origine `Word.Range` est un objet API, la `toJSON` méthode renvoie un objet JavaScript brut (typé en tant `Word.Interfaces.RangeData`que ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
track()	Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet sur des `.sync` appels et en dehors de l’exécution séquentielle d’un lot « .run », et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivie lors de la première création de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.
untrack()	Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler `context.sync()` avant que la mise en production de la mémoire ne prenne effet.

Détails de la propriété

contentControls

Obtient la collection d’objets de contrôle de contenu dans la plage.

readonly contentControls: Word.ContentControlCollection;

Valeur de propriété

Word.ContentControlCollection

Remarques

[ Ensemble d’API : WordApi 1.1 ]

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Word.RequestContext

font

Obtient le format de texte de la plage. Utilisez cette propriété pour obtenir et définir le nom de la police, la taille, la couleur et d’autres propriétés.

readonly font: Word.Font;

Valeur de propriété

Word.Font

Remarques

[ Ensemble d’API : WordApi 1.1 ]

hyperlink

Obtient le premier lien hypertexte de la plage ou définit un lien hypertexte sur la plage. Tous les liens hypertexte de la plage sont supprimés lorsque vous définissez un nouveau lien hypertexte sur celle-ci. Utilisez un « # » pour séparer la partie d’adresse de la partie d’emplacement facultative.

hyperlink: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.3 ]

inlinePictures

Obtient la collection d’objets image insérée de la plage.

readonly inlinePictures: Word.InlinePictureCollection;

Valeur de propriété

Word.InlinePictureCollection

Remarques

[ Ensemble d’API : WordApi 1.2 ]

isEmpty

Vérifie si la longueur de la plage est zéro.

readonly isEmpty: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi 1.3 ]

lists

Obtient la collection d’objets de liste figurant dans la plage.

readonly lists: Word.ListCollection;

Valeur de propriété

Word.ListCollection

Remarques

[ Ensemble d’API : WordApi 1.3 ]

paragraphs

Obtient la collection d’objets de paragraphe dans la plage.

readonly paragraphs: Word.ParagraphCollection;

Valeur de propriété

Word.ParagraphCollection

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Important : Pour les ensembles de conditions requises 1.1 et 1.2, les paragraphes des tableaux entièrement contenus dans cette plage ne sont pas retournés. À partir de l’ensemble de conditions requises 1.3, les paragraphes de ces tableaux sont également retournés.

parentBody

Obtient le corps parent de la plage.

readonly parentBody: Word.Body;

Valeur de propriété

Word.Body

Remarques

[ Ensemble d’API : WordApi 1.3 ]

parentContentControl

Obtient le contrôle de contenu actuellement pris en charge qui contient la plage. Génère une ItemNotFound erreur s’il n’existe pas de contrôle de contenu parent.

readonly parentContentControl: Word.ContentControl;

Valeur de propriété

Word.ContentControl

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-checkbox-content-control.yaml

// Toggles the isChecked property of the first checkbox content control found in the selection.
await Word.run(async (context) => {
  const selectedRange: Word.Range = context.document.getSelection();
  let selectedContentControl = selectedRange
    .getContentControls({
      types: [Word.ContentControlType.checkBox]
    })
    .getFirstOrNullObject();
  selectedContentControl.load("id,checkboxContentControl/isChecked");

  await context.sync();

  if (selectedContentControl.isNullObject) {
    const parentContentControl: Word.ContentControl = selectedRange.parentContentControl;
    parentContentControl.load("id,type,checkboxContentControl/isChecked");
    await context.sync();

    if (parentContentControl.isNullObject || parentContentControl.type !== Word.ContentControlType.checkBox) {
      console.warn("No checkbox content control is currently selected.");
      return;
    } else {
      selectedContentControl = parentContentControl;
    }
  }

  const isCheckedBefore = selectedContentControl.checkboxContentControl.isChecked;
  console.log("isChecked state before:", `id: ${selectedContentControl.id} ... isChecked: ${isCheckedBefore}`);
  selectedContentControl.checkboxContentControl.isChecked = !isCheckedBefore;
  selectedContentControl.load("id,checkboxContentControl/isChecked");
  await context.sync();

  console.log(
    "isChecked state after:",
    `id: ${selectedContentControl.id} ... isChecked: ${selectedContentControl.checkboxContentControl.isChecked}`
  );
});

parentContentControlOrNullObject

Obtient le contrôle de contenu actuellement pris en charge qui contient la plage. S’il n’existe pas de contrôle de contenu parent, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

readonly parentContentControlOrNullObject: Word.ContentControl;

Valeur de propriété

Word.ContentControl

Remarques

[ Ensemble d’API : WordApi 1.3 ]

parentTable

Obtient le tableau qui contient la plage. Génère une ItemNotFound erreur si elle n’est pas contenue dans une table.

readonly parentTable: Word.Table;

Valeur de propriété

Word.Table

Remarques

[ Ensemble d’API : WordApi 1.3 ]

parentTableCell

Obtient la cellule de tableau qui contient la plage. Génère une ItemNotFound erreur si elle n’est pas contenue dans une cellule de tableau.

readonly parentTableCell: Word.TableCell;

Valeur de propriété

Word.TableCell

Remarques

[ Ensemble d’API : WordApi 1.3 ]

parentTableCellOrNullObject

Obtient la cellule de tableau qui contient la plage. Si elle n’est pas contenue dans une cellule de tableau, cette méthode renvoie un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

readonly parentTableCellOrNullObject: Word.TableCell;

Valeur de propriété

Word.TableCell

Remarques

[ Ensemble d’API : WordApi 1.3 ]

parentTableOrNullObject

Obtient le tableau qui contient la plage. Si elle n’est pas contenue dans une table, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

readonly parentTableOrNullObject: Word.Table;

Valeur de propriété

Word.Table

Remarques

[ Ensemble d’API : WordApi 1.3 ]

style

Spécifie le nom de style de la plage. Utilisez cette propriété pour les noms des styles personnalisés et localisés. Pour utiliser les styles prédéfinis qui sont portables entre différents paramètres régionaux, voir la propriété « styleBuiltIn ».

style: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.1 ]

styleBuiltIn

Spécifie le nom de style intégré pour la plage. Utilisez cette propriété pour les styles intégrés qui sont portables entre les paramètres régionaux. Pour utiliser des styles personnalisés ou des noms de style localisés, consultez la propriété « style ».

styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/90-scenarios/doc-assembly.yaml

await Word.run(async (context) => {
    const header: Word.Range = context.document.body.insertText("This is a sample Heading 1 Title!!\n",
        "Start" /*this means at the beginning of the body */);
    header.styleBuiltIn = Word.BuiltInStyleName.heading1;

    await context.sync();
});

tables

Obtient la collection d’objets de table dans la plage.

readonly tables: Word.TableCollection;

Valeur de propriété

Word.TableCollection

Remarques

[ Ensemble d’API : WordApi 1.3 ]

text

Obtient le texte de la plage.

readonly text: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Détails de la méthode

clear()

Efface le contenu de l’objet de plage. L’utilisateur peut effectuer l’opération d’annulation sur le contenu effacé.

clear(): void;

Retours

void

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Exemples

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to clear the contents of the proxy range object.
    range.clear();

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Cleared the selection (range object)');
});

compareLocationWith(range)

Compare l’emplacement de la plage à celui d’une autre plage.

compareLocationWith(range: Word.Range): OfficeExtension.ClientResult<Word.LocationRelation>;

Paramètres

range: Word.Range

Obligatoire. Plage à comparer à cette plage.

Retours

OfficeExtension.ClientResult<Word.LocationRelation>

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/compare-location.yaml

// Compares the location of one paragraph in relation to another paragraph.
await Word.run(async (context) => {
  const paragraphs: Word.ParagraphCollection = context.document.body.paragraphs;
  paragraphs.load("items");

  await context.sync();

  const firstParagraphAsRange: Word.Range = paragraphs.items[0].getRange();
  const secondParagraphAsRange: Word.Range = paragraphs.items[1].getRange();

  const comparedLocation = firstParagraphAsRange.compareLocationWith(secondParagraphAsRange);

  await context.sync();

  const locationValue: Word.LocationRelation = comparedLocation.value;
  console.log(`Location of the first paragraph in relation to the second paragraph: ${locationValue}`);
});

delete()

Supprime la plage et son contenu du document.

delete(): void;

Retours

void

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Exemples

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to delete the range object.
    range.delete();

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Deleted the selection (range object)');
});

expandTo(range)

Renvoie une nouvelle plage qui s’étend dans les deux directions à partir de cette plage pour couvrir une autre plage. Cette plage n’est pas modifiée. Génère une ItemNotFound erreur si les deux plages n’ont pas d’union.

expandTo(range: Word.Range): Word.Range;

Paramètres

range: Word.Range

Obligatoire. Une autre plage.

Retours

Word.Range

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/get-paragraph-on-insertion-point.yaml

await Word.run(async (context) => {
  // Get the complete sentence (as range) associated with the insertion point.
  const sentences: Word.RangeCollection = context.document
    .getSelection()
    .getTextRanges(["."] /* Using the "." as delimiter */, false /*means without trimming spaces*/);
  sentences.load("$none");
  await context.sync();

  // Expand the range to the end of the paragraph to get all the complete sentences.
  const sentencesToTheEndOfParagraph: Word.RangeCollection = sentences.items[0]
    .getRange()
    .expandTo(
      context.document
        .getSelection()
        .paragraphs.getFirst()
        .getRange(Word.RangeLocation.end)
    )
    .getTextRanges(["."], false /* Don't trim spaces*/);
  sentencesToTheEndOfParagraph.load("text");
  await context.sync();

  for (let i = 0; i < sentencesToTheEndOfParagraph.items.length; i++) {
    console.log(sentencesToTheEndOfParagraph.items[i].text);
  }
});

expandToOrNullObject(range)

Renvoie une nouvelle plage qui s’étend dans les deux directions à partir de cette plage pour couvrir une autre plage. Cette plage n’est pas modifiée. Si les deux plages n’ont pas d’union, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

expandToOrNullObject(range: Word.Range): Word.Range;

Paramètres

range: Word.Range

Obligatoire. Une autre plage.

Retours

Word.Range

Remarques

[ Ensemble d’API : WordApi 1.3 ]

getHtml()

Obtient une représentation HTML de l’objet de plage. En cas de rendu dans une page web ou une visionneuse HTML, la mise en forme correspond à une correspondance proche, mais pas exacte, pour la mise en forme du document. Cette méthode ne retourne pas exactement le même code HTML pour le même document sur différentes plateformes (Windows, Mac, Word sur le web, etc.). Si vous avez besoin d’une fidélité exacte ou d’une cohérence entre les plateformes, utilisez Range.getOoxml() et convertissez le code XML retourné au format HTML.

getHtml(): OfficeExtension.ClientResult<string>;

Retours

OfficeExtension.ClientResult<string>

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Exemples

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to get the HTML of the current selection.
    const html = range.getHtml();

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The HTML read from the document was: ' + html.value);
});

getHyperlinkRanges()

Obtient les plages enfants d’un lien hypertexte au sein de la plage.

getHyperlinkRanges(): Word.RangeCollection;

Retours

Word.RangeCollection

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Exemples

await Word.run(async (context) => {
    // Get the entire document body.
    const bodyRange = context.document.body.getRange(Word.RangeLocation.whole);

    // Get all the ranges that only consist of hyperlinks.
    const hyperLinks = bodyRange.getHyperlinkRanges();
    hyperLinks.load("hyperlink");
    await context.sync();

    // Log each hyperlink.
    hyperLinks.items.forEach((linkRange) => {
        console.log(linkRange.hyperlink);
    });
});

getNextTextRange(endingMarks, trimSpacing)

Obtient la plage de texte suivante à l’aide de signes de ponctuation et/ou d’autres marques de fin. Génère une ItemNotFound erreur si cette plage de texte est la dernière.

getNextTextRange(endingMarks: string[], trimSpacing?: boolean): Word.Range;

Paramètres

endingMarks: string[]

Obligatoire. Signes de ponctuation et/ou autres marques de fin sous forme de tableau de chaînes.

trimSpacing: boolean

Optional. Indique s’il faut réduire l’espacement des caractères (espaces, tabulations, sauts de colonne et marques de fin de paragraphe) à partir du début et de la fin de la plage retournée. La valeur par défaut est false, ce qui indique que les caractères d’espacement au début et à la fin de la plage sont inclus.

Retours

Word.Range

Remarques

[ Ensemble d’API : WordApi 1.3 ]

getNextTextRangeOrNullObject(endingMarks, trimSpacing)

Obtient la plage de texte suivante à l’aide de signes de ponctuation et/ou d’autres marques de fin. Si cette plage de texte est la dernière, cette méthode renvoie un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getNextTextRangeOrNullObject(endingMarks: string[], trimSpacing?: boolean): Word.Range;

Paramètres

endingMarks: string[]

Obligatoire. Signes de ponctuation et/ou autres marques de fin sous forme de tableau de chaînes.

trimSpacing: boolean

Retours

Word.Range

Remarques

[ Ensemble d’API : WordApi 1.3 ]

getOoxml()

Obtient la représentation OOXML de l’objet de plage.

getOoxml(): OfficeExtension.ClientResult<string>;

Retours

OfficeExtension.ClientResult<string>

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Exemples

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to get the OOXML of the current selection.
    const ooxml = range.getOoxml();

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The OOXML read from the document was:  ' + ooxml.value);
});

getRange(rangeLocation)

Clone la plage ou obtient le point de début ou de fin de la plage sous la forme d’une nouvelle plage.

getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | Word.RangeLocation.content | "Whole" | "Start" | "End" | "After" | "Content"): Word.Range;

Paramètres

rangeLocation: whole | start | end | after | content | "Whole" | "Start" | "End" | "After" | "Content"

Optional. L’emplacement de la plage doit être « Entier », « Début », « Fin », « Après » ou « Contenu ».

Retours

Word.Range

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-dropdown-list-content-control.yaml

// Places a dropdown list content control at the end of the selection.
await Word.run(async (context) => {
  let selection = context.document.getSelection();
  selection.getRange(Word.RangeLocation.end).insertContentControl(Word.ContentControlType.dropDownList);
  await context.sync();

  console.log("Dropdown list content control inserted at the end of the selection.");
});

getTextRanges(endingMarks, trimSpacing)

Obtient les plages enfants de texte dans la plage à l’aide de signes de ponctuation et/ou d’autres marques de fin.

getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection;

Paramètres

endingMarks: string[]

Obligatoire. Signes de ponctuation et/ou autres marques de fin sous forme de tableau de chaînes.

trimSpacing: boolean

Optional. Indique s’il faut réduire l’espacement des caractères (espaces, tabulations, sauts de colonne et marques de fin de paragraphe) à partir du début et de la fin des plages retournées dans la collection de plages. La valeur par défaut est false, ce qui indique que les caractères d’espacement au début et à la fin des plages sont inclus dans la collection de plages.

Retours

Word.RangeCollection

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/get-paragraph-on-insertion-point.yaml

await Word.run(async (context) => {
  // Get the complete sentence (as range) associated with the insertion point.
  const sentences: Word.RangeCollection = context.document
    .getSelection()
    .getTextRanges(["."] /* Using the "." as delimiter */, false /*means without trimming spaces*/);
  sentences.load("$none");
  await context.sync();

  // Expand the range to the end of the paragraph to get all the complete sentences.
  const sentencesToTheEndOfParagraph: Word.RangeCollection = sentences.items[0]
    .getRange()
    .expandTo(
      context.document
        .getSelection()
        .paragraphs.getFirst()
        .getRange(Word.RangeLocation.end)
    )
    .getTextRanges(["."], false /* Don't trim spaces*/);
  sentencesToTheEndOfParagraph.load("text");
  await context.sync();

  for (let i = 0; i < sentencesToTheEndOfParagraph.items.length; i++) {
    console.log(sentencesToTheEndOfParagraph.items[i].text);
  }
});

insertBreak(breakType, insertLocation)

Insère un saut à l’emplacement spécifié du document principal.

insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void;

Paramètres

breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line"

Obligatoire. Type d’arrêt à ajouter.

insertLocation: before | after | "Before" | "After"

Obligatoire. La valeur doit être « Before » ou « After ».

Retours

void

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Exemples

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert a page break after the selected text.
    range.insertBreak(Word.BreakType.page, Word.InsertLocation.after);

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Inserted a page break after the selected text.');
});

insertContentControl(contentControlType)

Encapsule l’objet Range avec un contrôle de contenu.

insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox"): Word.ContentControl;

Paramètres

contentControlType: richText | plainText | checkBox | dropDownList | comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox"

Optional. Type de contrôle de contenu à insérer. Doit être « RichText », « PlainText », « CheckBox », « DropDownList » ou « ComboBox ». La valeur par défaut est « RichText ».

Retours

Word.ContentControl

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Remarque : Le contentControlType paramètre a été introduit dans WordApi 1.5. PlainText la prise en charge a été ajoutée dans WordApi 1.5. CheckBox la prise en charge a été ajoutée dans WordApi 1.7. DropDownList et ComboBox la prise en charge a été ajoutée dans WordApi 1.9.

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/90-scenarios/doc-assembly.yaml

// Simulates creation of a template. First searches the document for instances of the string "Contractor",
// then changes the format  of each search result,
// then wraps each search result within a content control,
// finally sets a tag and title property on each content control.
await Word.run(async (context) => {
    const results: Word.RangeCollection = context.document.body.search("Contractor");
    results.load("font/bold");

    // Check to make sure these content controls haven't been added yet.
    const customerContentControls: Word.ContentControlCollection = context.document.contentControls.getByTag("customer");
    customerContentControls.load("text");
    await context.sync();

  if (customerContentControls.items.length === 0) {
    for (let i = 0; i < results.items.length; i++) { 
        results.items[i].font.bold = true;
        let cc: Word.ContentControl = results.items[i].insertContentControl();
        cc.tag = "customer";  // This value is used in the next step of this sample.
        cc.title = "Customer Name " + i;
    }
  }
    await context.sync();
});

insertFileFromBase64(base64File, insertLocation)

Insère un document à l’emplacement spécifié.

insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;

Paramètres

base64File: string

Obligatoire. Contenu encodé en Base64 d’un fichier .docx.

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

Obligatoire. La valeur doit être « Replace », « Start », « End », « Before » ou « After ».

Retours

Word.Range

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Remarque : l’insertion n’est pas prise en charge si le document inséré contient un contrôle ActiveX (probablement dans un champ de formulaire). Envisagez de remplacer un tel champ de formulaire par un contrôle de contenu ou une autre option appropriée pour votre scénario.

Exemples

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert base64 encoded .docx at the beginning of the range.
    // You'll need to implement getBase64() to make this work.
    range.insertFileFromBase64(getBase64(), Word.InsertLocation.start);

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Added base64 encoded text to the beginning of the range.');
});

insertHtml(html, insertLocation)

Insère du code HTML à l’emplacement spécifié.

insertHtml(html: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;

Paramètres

html: string

Obligatoire. Code HTML à insérer.

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

Obligatoire. La valeur doit être « Replace », « Start », « End », « Before » ou « After ».

Retours

Word.Range

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Exemples

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert HTML in to the beginning of the range.
    range.insertHtml('<strong>This is text inserted with range.insertHtml()</strong>', Word.InsertLocation.start);

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('HTML added to the beginning of the range.');
});

insertInlinePictureFromBase64(base64EncodedImage, insertLocation)

Insère une image à l’emplacement spécifié.

insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.InlinePicture;

Paramètres

base64EncodedImage: string

Obligatoire. Image encodée en Base64 à insérer.

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

Obligatoire. La valeur doit être « Replace », « Start », « End », « Before » ou « After ».

Retours

Word.InlinePicture

Remarques

[ Ensemble d’API : WordApi 1.2 ]

insertOoxml(ooxml, insertLocation)

Insère du code OOXML à l’emplacement spécifié.

insertOoxml(ooxml: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;

Paramètres

ooxml: string

Obligatoire. Code OOXML à insérer.

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

Obligatoire. La valeur doit être « Replace », « Start », « End », « Before » ou « After ».

Retours

Word.Range

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Exemples

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert OOXML in to the beginning of the range.
    range.insertOoxml("<pkg:package xmlns:pkg='http://schemas.microsoft.com/office/2006/xmlPackage'><pkg:part pkg:name='/_rels/.rels' pkg:contentType='application/vnd.openxmlformats-package.relationships+xml' pkg:padding='512'><pkg:xmlData><Relationships xmlns='http://schemas.openxmlformats.org/package/2006/relationships'><Relationship Id='rId1' Type='http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument' Target='word/document.xml'/></Relationships></pkg:xmlData></pkg:part><pkg:part pkg:name='/word/document.xml' pkg:contentType='application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml'><pkg:xmlData><w:document xmlns:w='http://schemas.openxmlformats.org/wordprocessingml/2006/main' ><w:body><w:p><w:pPr><w:spacing w:before='360' w:after='0' w:line='480' w:lineRule='auto'/><w:rPr><w:color w:val='70AD47' w:themeColor='accent6'/><w:sz w:val='28'/></w:rPr></w:pPr><w:r><w:rPr><w:color w:val='70AD47' w:themeColor='accent6'/><w:sz w:val='28'/></w:rPr><w:t>This text has formatting directly applied to achieve its font size, color, line spacing, and paragraph spacing.</w:t></w:r></w:p></w:body></w:document></pkg:xmlData></pkg:part></pkg:package>", Word.InsertLocation.start);

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('OOXML added to the beginning of the range.');
});

// Read "Create better add-ins for Word with Office Open XML" for guidance on working with OOXML.
// https://learn.microsoft.com/office/dev/add-ins/word/create-better-add-ins-for-word-with-office-open-xml

insertParagraph(paragraphText, insertLocation)

Insère un paragraphe à l’emplacement spécifié.

insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;

Paramètres

paragraphText: string

Obligatoire. Texte de paragraphe à insérer.

insertLocation: before | after | "Before" | "After"

Obligatoire. La valeur doit être « Before » ou « After ».

Retours

Word.Paragraph

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Exemples

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert the paragraph after the range.
    range.insertParagraph('Content of a new paragraph', Word.InsertLocation.after);

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Paragraph added to the end of the range.');
});

insertTable(rowCount, columnCount, insertLocation, values)

Insère un tableau avec le nombre spécifié de lignes et de colonnes.

insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table;

Paramètres

rowCount: number

Obligatoire. Nombre de lignes dans le tableau.

columnCount: number

Obligatoire. Nombre de colonnes dans le tableau.

insertLocation: before | after | "Before" | "After"

Obligatoire. La valeur doit être « Before » ou « After ».

values: string[][]

Tableau 2D facultatif. Les cellules sont remplies si les chaînes correspondantes sont spécifiées dans le tableau.

Retours

Word.Table

Remarques

[ Ensemble d’API : WordApi 1.3 ]

insertText(text, insertLocation)

Insère du texte à l’emplacement spécifié.

insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;

Paramètres

text: string

Obligatoire. Texte à insérer.

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

Obligatoire. La valeur doit être « Replace », « Start », « End », « Before » ou « After ».

Retours

Word.Range

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Exemples

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert the paragraph at the end of the range.
    range.insertText('New text inserted into the range.', Word.InsertLocation.end);

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Text added to the end of the range.');
});

intersectWith(range)

Retourne une nouvelle plage en tant qu’intersection de cette plage avec une autre. Cette plage n’est pas modifiée. Génère une ItemNotFound erreur si les deux plages ne sont pas superposées ou adjacentes.

intersectWith(range: Word.Range): Word.Range;

Paramètres

range: Word.Range

Obligatoire. Une autre plage.

Retours

Word.Range

Remarques

[ Ensemble d’API : WordApi 1.3 ]

intersectWithOrNullObject(range)

Retourne une nouvelle plage en tant qu’intersection de cette plage avec une autre. Cette plage n’est pas modifiée. Si les deux plages ne sont pas superposées ou adjacentes, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

intersectWithOrNullObject(range: Word.Range): Word.Range;

Paramètres

range: Word.Range

Obligatoire. Une autre plage.

Retours

Word.Range

Remarques

[ Ensemble d’API : WordApi 1.3 ]

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Word.Interfaces.RangeLoadOptions): Word.Range;

Paramètres

options: Word.Interfaces.RangeLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Word.Range

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Word.Range;

Paramètres

propertyNames: string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.

Retours

Word.Range

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.Range;

Paramètres

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

Word.Range

search(searchText, searchOptions)

Effectue une recherche avec les SearchOptions spécifiés sur l’étendue de l’objet de plage. Les résultats de la recherche sont un ensemble d’objets de plage.

search(searchText: string, searchOptions?: Word.SearchOptions | {
            ignorePunct?: boolean;
            ignoreSpace?: boolean;
            matchCase?: boolean;
            matchPrefix?: boolean;
            matchSuffix?: boolean;
            matchWholeWord?: boolean;
            matchWildcards?: boolean;
        }): Word.RangeCollection;

Paramètres

searchText: string

Obligatoire. Texte de recherche.

searchOptions: Word.SearchOptions | { ignorePunct?: boolean; ignoreSpace?: boolean; matchCase?: boolean; matchPrefix?: boolean; matchSuffix?: boolean; matchWholeWord?: boolean; matchWildcards?: boolean; }

Optional. Options de la recherche.

Retours

Word.RangeCollection

Remarques

[ Ensemble d’API : WordApi 1.1 ]

select(selectionMode)

Sélectionne la plage et y accède via l’interface utilisateur de Word.

select(selectionMode?: Word.SelectionMode): void;

Paramètres

selectionMode: Word.SelectionMode

Optional. Le mode de sélection doit être « Select », « Start » ou « End ». « Select » (sélectionner) est la valeur par défaut.

Retours

void

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Exemples

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert HTML in to the beginning of the range.
    range.insertHtml('<strong>This is text inserted with range.insertHtml()</strong>', Word.InsertLocation.start);

    // Queue a command to select the HTML that was inserted.
    range.select();

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Selected the range.');
});

select(selectionModeString)

Sélectionne la plage et y accède via l’interface utilisateur de Word.

select(selectionModeString?: "Select" | "Start" | "End"): void;

Paramètres

selectionModeString: "Select" | "Start" | "End"

Optional. Le mode de sélection doit être « Select », « Start » ou « End ». « Select » (sélectionner) est la valeur par défaut.

Retours

void

Remarques

[ Ensemble d’API : WordApi 1.1 ]

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

set(properties: Interfaces.RangeUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties: Word.Interfaces.RangeUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des propriétés de l’objet sur lequel la méthode est appelée.

options: OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet properties tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Word.Range): void;

Paramètres

properties: Word.Range

Retours

void

split(delimiters, multiParagraphs, trimDelimiters, trimSpacing)

Divise la plage en plages enfants à l’aide de délimiteurs.

split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean): Word.RangeCollection;

Paramètres

delimiters: string[]

Obligatoire. Délimiteurs en tant que tableau de chaînes.

multiParagraphs: boolean

Optional. Indique si une plage enfant retournée peut couvrir plusieurs paragraphes. La valeur par défaut est false, ce qui indique que les limites de paragraphe sont également utilisées comme délimiteurs.

trimDelimiters: boolean

Optional. Indique s’il faut découper les délimiteurs des plages de la collection de plages. La valeur par défaut est false, ce qui indique que les délimiteurs sont inclus dans les plages retournées dans la collection de plages.

trimSpacing: boolean

Retours

Word.RangeCollection

Remarques

[ Ensemble d’API : WordApi 1.3 ]

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Word.Range est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.RangeDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Word.Interfaces.RangeData;

Retours

Word.Interfaces.RangeData

track()

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet sur des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run », et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivie lors de la première création de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

track(): Word.Range;

Retours

Word.Range

untrack()

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la mise en production de la mémoire ne prenne effet.

untrack(): Word.Range;

Retours

Word.Range

Partager via

Word.Range class

Remarques

Exemples

Propriétés

Méthodes

Détails de la propriété

contentControls

Valeur de propriété

Remarques

context

Valeur de propriété

font

Valeur de propriété

Remarques

hyperlink

Valeur de propriété

Remarques

inlinePictures

Valeur de propriété

Remarques

isEmpty

Valeur de propriété

Remarques

lists

Valeur de propriété

Remarques

paragraphs

Valeur de propriété

Remarques

parentBody

Valeur de propriété

Remarques

parentContentControl

Valeur de propriété

Remarques

Exemples

parentContentControlOrNullObject

Valeur de propriété

Remarques

parentTable

Valeur de propriété

Remarques

parentTableCell

Valeur de propriété

Remarques

parentTableCellOrNullObject

Valeur de propriété

Remarques

parentTableOrNullObject

Valeur de propriété

Remarques

style

Valeur de propriété

Remarques

styleBuiltIn

Valeur de propriété

Remarques

Exemples

tables

Valeur de propriété

Remarques

text

Valeur de propriété

Remarques

Détails de la méthode

clear()

Retours

Remarques

Exemples

compareLocationWith(range)

Paramètres

Retours

Remarques

Exemples

delete()

Retours

Remarques

Exemples

expandTo(range)