Word.Paragraph class

Référence

Paquet:: word

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

Extends: OfficeExtension.ClientObject

Remarques

Propriétés

alignment	Spécifie l’alignement d’un paragraphe. La valeur peut être « left » (gauche), « centered » (centré), « right » (droite) ou « justified » (justifié).
contentControls	Obtient la collection d’objets de contrôle de contenu dans le paragraphe.
context	Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
firstLineIndent	Spécifie la valeur, en points, d’une première ligne ou d’un retrait négatif. Utilisez une valeur positive pour définir un retrait de première ligne et utilisez une valeur négative pour définir un retrait négatif.
font	Obtient le format de texte du paragraphe. Utilisez cette propriété pour obtenir et définir le nom de la police, la taille, la couleur et d’autres propriétés.
inlinePictures	Obtient la collection d’objets InlinePicture dans le paragraphe. La collection n’inclut pas d’images flottantes.
isLastParagraph	Indique que le paragraphe est le dernier au sein de son corps parent.
isListItem	Vérifie si le paragraphe est un élément de liste.
leftIndent	Spécifie la valeur de retrait gauche, en points, pour le paragraphe.
lineSpacing	Spécifie l’espacement des lignes, en points, pour le paragraphe spécifié. Dans l’interface utilisateur de Word, cette valeur est divisée par 12.
lineUnitAfter	Spécifie la quantité d’espacement, en lignes de grille, après le paragraphe.
lineUnitBefore	Spécifie la quantité d’espacement, dans les lignes de grille, avant le paragraphe.
list	Obtient la liste à laquelle ce paragraphe appartient. Génère une `ItemNotFound` erreur si le paragraphe ne figure pas dans une liste.
listItem	Obtient l’élément de liste du paragraphe. Génère une `ItemNotFound` erreur si le paragraphe ne fait pas partie d’une liste.
listItemOrNullObject	Obtient l’élément de liste du paragraphe. Si le paragraphe ne fait pas partie d’une liste, 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.
listOrNullObject	Obtient la liste à laquelle ce paragraphe appartient. Si le paragraphe ne figure pas dans une liste, 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.
outlineLevel	Spécifie le niveau hiérarchique du paragraphe.
parentBody	Obtient le corps parent du paragraphe.
parentContentControl	Obtient le contrôle de contenu qui contient le paragraphe. Génère une `ItemNotFound` erreur s’il n’existe pas de contrôle de contenu parent.
parentContentControlOrNullObject	Obtient le contrôle de contenu qui contient le paragraphe. 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 le paragraphe. Génère une `ItemNotFound` erreur si elle n’est pas contenue dans une table.
parentTableCell	Obtient la cellule de tableau qui contient le paragraphe. 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 le paragraphe. 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 le paragraphe. 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.
rightIndent	Spécifie la valeur de retrait à droite, en points, pour le paragraphe.
spaceAfter	Spécifie l’espacement, en points, après le paragraphe.
spaceBefore	Spécifie l’espacement, en points, avant le paragraphe.
style	Spécifie le nom du style pour le paragraphe. 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 le paragraphe. 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 ».
tableNestingLevel	Obtient le niveau de tableau du paragraphe. Elle retourne 0 si le paragraphe n’est pas dans un tableau.
text	Obtient le texte du paragraphe.

Méthodes

attachToList(listId, level)	Permet au paragraphe de rejoindre une liste existante au niveau spécifié. Échoue si le paragraphe ne peut pas rejoindre la liste ou s’il est déjà un élément de liste.
clear()	Efface le contenu de l’objet de paragraphe. L’utilisateur peut effectuer l’opération d’annulation sur le contenu effacé.
delete()	Supprime le paragraphe et son contenu du document.
detachFromList()	Déplace ce paragraphe en dehors de la liste, si le paragraphe est un élément de liste.
getHtml()	Obtient une représentation HTML de l’objet paragraphe. 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 `Paragraph.getOoxml()` et convertissez le code XML retourné au format HTML.
getNext()	Obtient le paragraphe suivant. Génère une `ItemNotFound` erreur si le paragraphe est le dernier.
getNextOrNullObject()	Obtient le paragraphe suivant. Si le paragraphe est le dernier, 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.
getOoxml()	Obtient la représentation Office Open XML (OOXML) de l’objet de paragraphe.
getPrevious()	Obtient le paragraphe précédent. Génère une `ItemNotFound` erreur si le paragraphe est le premier.
getPreviousOrNullObject()	Obtient le paragraphe précédent. Si le paragraphe est le premier, 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.
getRange(rangeLocation)	Obtient le paragraphe entier, ou le point de début ou de fin du paragraphe, sous la forme d’une plage.
getTextRanges(endingMarks, trimSpacing)	Obtient les plages de texte dans le paragraphe à 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 Paragraph avec un contrôle de contenu.
insertFileFromBase64(base64File, insertLocation)	Insère un document dans le paragraphe à l’emplacement spécifié.
insertHtml(html, insertLocation)	Insère du code HTML dans le paragraphe à l’emplacement spécifié.
insertInlinePictureFromBase64(base64EncodedImage, insertLocation)	Insère une image dans le paragraphe à l’emplacement spécifié.
insertOoxml(ooxml, insertLocation)	Insère OOXML dans le paragraphe à 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 dans le paragraphe à l’emplacement spécifié.
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 l’objet SearchOptions spécifié dans l’étendue de l’objet paragraphe. Les résultats de la recherche sont un ensemble d’objets de plage.
select(selectionMode)	Sélectionne le paragraphe et y accède via l’interface utilisateur de Word.
select(selectionModeString)	Sélectionne le paragraphe 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, trimDelimiters, trimSpacing)	Divise le paragraphe en plages enfants à l’aide de délimiteurs.
startNewList()	Démarre une nouvelle liste avec ce paragraphe. Échoue si le paragraphe est déjà un élément de liste.
toJSON()	Remplace la méthode JavaScript `toJSON()` afin de fournir une sortie plus utile lorsqu’un objet API est passé à `JSON.stringify()`. (`JSON.stringify`appelle à son tour la `toJSON` méthode de l’objet qui lui est passé.) Alors que le Word d’origine. L’objet Paragraph est un objet API. La `toJSON` méthode retourne un objet JavaScript brut (typé en tant `Word.Interfaces.ParagraphData`que ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir 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é

alignment

Spécifie l’alignement d’un paragraphe. La valeur peut être « left » (gauche), « centered » (centré), « right » (droite) ou « justified » (justifié).

alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Exemples

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

await Word.run(async (context) => {
  // Center last paragraph alignment.
  context.document.body.paragraphs.getLast().alignment = "Centered";

  await context.sync();
});

contentControls

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

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

firstLineIndent

Spécifie la valeur, en points, d’une première ligne ou d’un retrait négatif. Utilisez une valeur positive pour définir un retrait de première ligne et utilisez une valeur négative pour définir un retrait négatif.

firstLineIndent: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.1 ]

font

Obtient le format de texte du paragraphe. 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 ]

inlinePictures

Obtient la collection d’objets InlinePicture dans le paragraphe. La collection n’inclut pas d’images flottantes.

readonly inlinePictures: Word.InlinePictureCollection;

Valeur de propriété

Word.InlinePictureCollection

Remarques

[ Ensemble d’API : WordApi 1.1 ]

isLastParagraph

Indique que le paragraphe est le dernier au sein de son corps parent.

readonly isLastParagraph: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi 1.3 ]

isListItem

Vérifie si le paragraphe est un élément de liste.

readonly isListItem: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi 1.3 ]

leftIndent

Spécifie la valeur de retrait gauche, en points, pour le paragraphe.

leftIndent: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Exemples

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

await Word.run(async (context) => {
  // Indent the first paragraph.
  context.document.body.paragraphs.getFirst().leftIndent = 75; //units = points

  return context.sync();
});

lineSpacing

Spécifie l’espacement des lignes, en points, pour le paragraphe spécifié. Dans l’interface utilisateur de Word, cette valeur est divisée par 12.

lineSpacing: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Exemples

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

await Word.run(async (context) => {
  // Adjust line spacing.
  context.document.body.paragraphs.getFirst().lineSpacing = 20;

  await context.sync();
});

lineUnitAfter

Spécifie la quantité d’espacement, en lignes de grille, après le paragraphe.

lineUnitAfter: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Exemples

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

await Word.run(async (context) => {
  // Set the space (in line units) after the first paragraph.
  context.document.body.paragraphs.getFirst().lineUnitAfter = 1;

  await context.sync();
});

lineUnitBefore

Spécifie la quantité d’espacement, dans les lignes de grille, avant le paragraphe.

lineUnitBefore: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Exemples

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

await Word.run(async (context) => {
  // Set the space (in line units) before the first paragraph.
  context.document.body.paragraphs.getFirst().lineUnitBefore = 1;

  await context.sync();
});

list

Obtient la liste à laquelle ce paragraphe appartient. Génère une ItemNotFound erreur si le paragraphe ne figure pas dans une liste.

readonly list: Word.List;

Valeur de propriété

Word.List

Remarques

[ Ensemble d’API : WordApi 1.3 ]

listItem

Obtient l’élément de liste du paragraphe. Génère une ItemNotFound erreur si le paragraphe ne fait pas partie d’une liste.

readonly listItem: Word.ListItem;

Valeur de propriété

Word.ListItem

Remarques

[ Ensemble d’API : WordApi 1.3 ]

listItemOrNullObject

Obtient l’élément de liste du paragraphe. Si le paragraphe ne fait pas partie d’une liste, 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 listItemOrNullObject: Word.ListItem;

Valeur de propriété

Word.ListItem

Remarques

[ Ensemble d’API : WordApi 1.3 ]

listOrNullObject

Obtient la liste à laquelle ce paragraphe appartient. Si le paragraphe ne figure pas dans une liste, 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 listOrNullObject: Word.List;

Valeur de propriété

Word.List

Remarques

[ Ensemble d’API : WordApi 1.3 ]

outlineLevel

Spécifie le niveau hiérarchique du paragraphe.

outlineLevel: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.1 ]

parentBody

Obtient le corps parent du paragraphe.

readonly parentBody: Word.Body;

Valeur de propriété

Word.Body

Remarques

[ Ensemble d’API : WordApi 1.3 ]

parentContentControl

Obtient le contrôle de contenu qui contient le paragraphe. 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 ]

parentContentControlOrNullObject

Obtient le contrôle de contenu qui contient le paragraphe. 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 le paragraphe. 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 le paragraphe. 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 le paragraphe. 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 le paragraphe. 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 ]

rightIndent

Spécifie la valeur de retrait à droite, en points, pour le paragraphe.

rightIndent: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.1 ]

spaceAfter

Spécifie l’espacement, en points, après le paragraphe.

spaceAfter: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Exemples

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

await Word.run(async (context) => {
  // Set the space (in points) after the first paragraph.
  context.document.body.paragraphs.getFirst().spaceAfter = 20;

  await context.sync();
});

spaceBefore

Spécifie l’espacement, en points, avant le paragraphe.

spaceBefore: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.1 ]

style

Spécifie le nom du style pour le paragraphe. 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 ]

Exemples

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

// Applies the specified style to a paragraph.
await Word.run(async (context) => {
  const styleName = $("#style-name-to-use").val() as string;
  if (styleName == "") {
    console.warn("Enter a style name to apply.");
    return;
  }

  const style = context.document.getStyles().getByNameOrNullObject(styleName);
  style.load();
  await context.sync();

  if (style.isNullObject) {
    console.warn(`There's no existing style with the name '${styleName}'.`);
  } else if (style.type != Word.StyleType.paragraph) {
    console.log(`The '${styleName}' style isn't a paragraph style.`);
  } else {
    const body = context.document.body;
    body.clear();
    body.insertParagraph(
      "Video provides a powerful way to help you prove your point. When you click Online Video, you can paste in the embed code for the video you want to add. You can also type a keyword to search online for the video that best fits your document.",
      "Start"
    );
    const paragraph = body.paragraphs.getFirst();
    paragraph.style = style.nameLocal;
    console.log(`'${styleName}' style applied to first paragraph.`);
  }
});

styleBuiltIn

Spécifie le nom de style intégré pour le paragraphe. 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 paragraph = context.document.body.insertParagraph("Timeline", "End");
    paragraph.styleBuiltIn = "Heading2";
    const paragraph2 = context.document.body.insertParagraph("The Services shall commence on July 31, 2015, and shall continue through July 29, 2015.", "End");
    paragraph2.styleBuiltIn = "Normal";
    const paragraph3 = context.document.body.insertParagraph("Project Costs by Phase", "End");
    paragraph3.styleBuiltIn = "Heading2";
    // Note a content control with the title of "ProjectCosts" is added. Content will be replaced later.
    const paragraph4 = context.document.body.insertParagraph("<Add Project Costs Here>", "End");
    paragraph4.styleBuiltIn = "Normal";
    paragraph4.font.highlightColor = "#FFFF00";
    const contentControl = paragraph4.insertContentControl();
    contentControl.title = "ProjectCosts";
    const paragraph5 = context.document.body.insertParagraph("Project Team", "End");
    paragraph5.styleBuiltIn = "Heading2";
    paragraph5.font.highlightColor = "#FFFFFF";
    const paragraph6 = context.document.body.insertParagraph("Terms of Work", "End");
    paragraph6.styleBuiltIn = "Heading1";
    const paragraph7 = context.document.body.insertParagraph("Contractor shall provide the Services and Deliverable(s) as follows:", "End");
    paragraph7.styleBuiltIn = "Normal";
    const paragraph8 = context.document.body.insertParagraph("Out-of-Pocket Expenses / Invoice Procedures", "End");
    paragraph8.styleBuiltIn = "Heading2";
    const paragraph9 = context.document.body.insertParagraph("Client will be invoiced monthly for the consulting services and T&L expenses. Standard Contractor invoicing is assumed to be acceptable. Invoices are due upon receipt. client will be invoiced all costs associated with out-of-pocket expenses (including, without limitation, costs and expenses associated with meals, lodging, local transportation and any other applicable business expenses) listed on the invoice as a separate line item. Reimbursement for out-of-pocket expenses in connection with performance of this SOW, when authorized and up to the limits set forth in this SOW, shall be in accordance with Client's then-current published policies governing travel and associated business expenses, which information shall be provided by the Client Project Manager.", "End");
    paragraph9.styleBuiltIn = "Normal";
    // Insert a page break at the end of the document.
    context.document.body.insertBreak("Page", "End");

    await context.sync();
});

tableNestingLevel

Obtient le niveau de tableau du paragraphe. Elle retourne 0 si le paragraphe n’est pas dans un tableau.

readonly tableNestingLevel: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.3 ]

text

Obtient le texte du paragraphe.

readonly text: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.1 ]

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) => {
  // The collection of paragraphs of the current selection returns the full paragraphs contained in it.
  const paragraph = context.document.getSelection().paragraphs.getFirst();
  paragraph.load("text");

  await context.sync();
  console.log(paragraph.text);
});

Détails de la méthode

attachToList(listId, level)

Permet au paragraphe de rejoindre une liste existante au niveau spécifié. Échoue si le paragraphe ne peut pas rejoindre la liste ou s’il est déjà un élément de liste.

attachToList(listId: number, level: number): Word.List;

Paramètres

listId: number

Obligatoire. ID d’une liste existante.

level: number

Obligatoire. Niveau de la liste.

Retours

Word.List

Remarques

[ Ensemble d’API : WordApi 1.3 ]

clear()

Efface le contenu de l’objet de paragraphe. 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) => {

    // Create a proxy object for the paragraphs collection.
    const paragraphs = context.document.body.paragraphs;

    // Queue a command to load the style property for all of the paragraphs.
    paragraphs.load('style');

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

    // Queue a command to clear the contents of the first paragraph.
    paragraphs.items[0].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 contents of the first paragraph.');
});

delete()

Supprime le paragraphe 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) => {

    // Create a proxy object for the paragraphs collection.
    const paragraphs = context.document.body.paragraphs;

    // Queue a command to load the text property for all of the paragraphs.
    paragraphs.load('text');

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

    // Queue a command to delete the first paragraph.
    paragraphs.items[0].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 first paragraph.');
});

detachFromList()

Déplace ce paragraphe en dehors de la liste, si le paragraphe est un élément de liste.

detachFromList(): void;

Retours

void

Remarques

[ Ensemble d’API : WordApi 1.3 ]

getHtml()

Obtient une représentation HTML de l’objet paragraphe. 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 Paragraph.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) => {

    // Create a proxy object for the paragraphs collection.
    const paragraphs = context.document.body.paragraphs;

    // Queue a command to load the style property for all of the paragraphs.
    paragraphs.load('style');

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

    // Queue a set of commands to get the HTML of the first paragraph.
    const html = paragraphs.items[0].getHtml();

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

getNext()

Obtient le paragraphe suivant. Génère une ItemNotFound erreur si le paragraphe est le dernier.

getNext(): Word.Paragraph;

Retours

Word.Paragraph

Remarques

[ Ensemble d’API : WordApi 1.3 ]

getNextOrNullObject()

Obtient le paragraphe suivant. Si le paragraphe est le dernier, 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.

getNextOrNullObject(): Word.Paragraph;

Retours

Word.Paragraph

Remarques

[ Ensemble d’API : WordApi 1.3 ]

getOoxml()

Obtient la représentation Office Open XML (OOXML) de l’objet de paragraphe.

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) => {

    // Create a proxy object for the paragraphs collection.
    const paragraphs = context.document.body.paragraphs;

    // Queue a command to load the style property for the top 2 paragraphs.
    paragraphs.load({select: 'style', top: 2} );

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

    // Queue a set of commands to get the OOXML of the first paragraph.
    const ooxml = paragraphs.items[0].getOoxml();

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

getPrevious()

Obtient le paragraphe précédent. Génère une ItemNotFound erreur si le paragraphe est le premier.

getPrevious(): Word.Paragraph;

Retours

Word.Paragraph

Remarques

[ Ensemble d’API : WordApi 1.3 ]

getPreviousOrNullObject()

Obtient le paragraphe précédent. Si le paragraphe est le premier, 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.

getPreviousOrNullObject(): Word.Paragraph;

Retours

Word.Paragraph

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Exemples

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

    // Create a proxy object for the paragraphs collection.
    const paragraphs = context.document.body.paragraphs;

    // Queue a command to load the text property for all of the paragraphs.
    paragraphs.load('text');

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

    // Queue commands to create a proxy object for the next-to-last paragraph.
    const indexOfLastParagraph = paragraphs.items.length - 1;
    const precedingParagraph = paragraphs.items[indexOfLastParagraph].getPreviousOrNullObject();

    // Queue a command to load the text of the preceding paragraph.
    precedingParagraph.load('text');

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    if (precedingParagraph.isNullObject) {
        console.log('There are no paragraphs before the current one.');
    } else {
        console.log('The preceding paragraph is: ' + precedingParagraph.text);
    }
});

getRange(rangeLocation)

Obtient le paragraphe entier, ou le point de début ou de fin du paragraphe, sous la forme d’une 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"

Facultatif. 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/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 = 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 = 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);
  }
});

getTextRanges(endingMarks, trimSpacing)

Obtient les plages de texte dans le paragraphe à 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

Facultatif. 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 ]

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 de saut à ajouter au document.

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) => {

    // Create a proxy object for the paragraphs collection.
    const paragraphs = context.document.body.paragraphs;

    // Queue a command to load the style property for the top 2 paragraphs.
    // We never perform an empty load. We always must request a property.
    paragraphs.load({select: 'style', top: 2} );

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

    // Queue a command to get the first paragraph.
    const paragraph = paragraphs.items[0];

    // Queue a command to insert a page break after the first paragraph.
    paragraph.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 paragraph.');
});

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/insert-line-and-page-breaks.yaml

Word.run(async (context) => {
  context.document.body.paragraphs.getFirst().insertBreak(Word.BreakType.line, "After");

  await context.sync();
  console.log("success");
});

insertContentControl(contentControlType)

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

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

Paramètres

contentControlType: richText | plainText | checkBox | "RichText" | "PlainText" | "CheckBox"

Facultatif. Type de contrôle de contenu à insérer. Doit être « RichText », « PlainText » ou « CheckBox ». 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.

Exemples

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

    // Create a proxy object for the paragraphs collection.
    const paragraphs = context.document.body.paragraphs;

    // Queue a command to load the style property for the top 2 paragraphs.
    // We never perform an empty load. We always must request a property.
    paragraphs.load({select: 'style', top: 2} );

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

    // Queue a command to get the first paragraph.
    const paragraph = paragraphs.items[0];

    // Queue a command to wrap the first paragraph in a rich text content control.
    paragraph.insertContentControl();

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Wrapped the first paragraph in a content control.');
});

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

// Traverses each paragraph of the document and wraps a content control on each with either a even or odd tags.
await Word.run(async (context) => {
  let paragraphs = context.document.body.paragraphs;
  paragraphs.load("$none"); // Don't need any properties; just wrap each paragraph with a content control.

  await context.sync();

  for (let i = 0; i < paragraphs.items.length; i++) {
    let contentControl = paragraphs.items[i].insertContentControl();
    // For even, tag "even".
    if (i % 2 === 0) {
      contentControl.tag = "even";
    } else {
      contentControl.tag = "odd";
    }
  }
  console.log("Content controls inserted: " + paragraphs.items.length);

  await context.sync();
});

insertFileFromBase64(base64File, insertLocation)

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

insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;

Paramètres

base64File: string

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

insertLocation: replace | start | end | "Replace" | "Start" | "End"

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

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.

insertHtml(html, insertLocation)

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

insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;

Paramètres

html: string

Obligatoire. Code HTML à insérer dans le paragraphe.

insertLocation: replace | start | end | "Replace" | "Start" | "End"

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

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) => {

    // Create a proxy object for the paragraphs collection.
    const paragraphs = context.document.body.paragraphs;

    // Queue a command to load the style property for the top 2 paragraphs.
    // We never perform an empty load. We always must request a property.
    paragraphs.load({select: 'style', top: 2} );

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

    // Queue a command to get the first paragraph.
    const paragraph = paragraphs.items[0];

    // Queue a command to insert HTML content at the end of the first paragraph.
    paragraph.insertHtml('<strong>Inserted HTML.</strong>', 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('Inserted HTML content at the end of the first paragraph.');
});

insertInlinePictureFromBase64(base64EncodedImage, insertLocation)

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

insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.InlinePicture;

Paramètres

base64EncodedImage: string

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

insertLocation: replace | start | end | "Replace" | "Start" | "End"

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

Retours

Word.InlinePicture

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Exemples

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

    // Create a proxy object for the paragraphs collection.
    const paragraphs = context.document.body.paragraphs;

    // Queue a command to load the style property for all of the paragraphs.
    paragraphs.load('style');

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

    // Queue a command to get the first paragraph.
    const paragraph = paragraphs.items[0];

    const b64encodedImg = "iVBORw0KGgoAAAANSUhEUgAAAB4AAAANCAIAAAAxEEnAAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAACFSURBVDhPtY1BEoQwDMP6/0+XgIMTBAeYoTqso9Rkx1zG+tNj1H94jgGzeNSjteO5vtQQuG2seO0av8LzGbe3anzRoJ4ybm/VeKEerAEbAUpW4aWQCmrGFWykRzGBCnYy2ha3oAIq2MloW9yCCqhgJ6NtcQsqoIKdjLbFLaiACnYyf2fODbrjZcXfr2F4AAAAAElFTkSuQmCC";

    // Queue a command to insert a base64 encoded image at the beginning of the first paragraph.
    paragraph.insertInlinePictureFromBase64(b64encodedImg, 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 an image to the first paragraph.');
});

insertOoxml(ooxml, insertLocation)

Insère OOXML dans le paragraphe à l’emplacement spécifié.

insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;

Paramètres

ooxml: string

Obligatoire. OOXML à insérer dans le paragraphe.

insertLocation: replace | start | end | "Replace" | "Start" | "End"

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

Retours

Word.Range

Remarques

[ Ensemble d’API : WordApi 1.1 ]

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 ]

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 dans le paragraphe à l’emplacement spécifié.

insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;

Paramètres

text: string

Obligatoire. Texte à insérer.

insertLocation: replace | start | end | "Replace" | "Start" | "End"

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

Retours

Word.Range

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/insert-in-different-locations.yaml

await Word.run(async (context) => {
  // Replace the last paragraph.
  const range = context.document.body.paragraphs.getLast().insertText("Just replaced the last paragraph!", "Replace");
  range.font.highlightColor = "black";
  range.font.color = "white";

  await context.sync();
});

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.ParagraphLoadOptions): Word.Paragraph;

Paramètres

options: Word.Interfaces.ParagraphLoadOptions

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

Retours

Word.Paragraph

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.Paragraph;

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.Paragraph

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.Paragraph;

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.Paragraph

search(searchText, searchOptions)

Effectue une recherche avec l’objet SearchOptions spécifié dans l’étendue de l’objet paragraphe. 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; }

Facultatif. Options de la recherche.

Retours

Word.RangeCollection

Remarques

[ Ensemble d’API : WordApi 1.1 ]

select(selectionMode)

Sélectionne le paragraphe et y accède via l’interface utilisateur de Word.

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

Paramètres

selectionMode: Word.SelectionMode

Facultatif. 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

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

await Word.run(async (context) => {
  // If select is called with no parameters, it selects the object.
  context.document.body.paragraphs.getLast().select();

  await context.sync();
});

...

await Word.run(async (context) => {
  // Select can be at the start or end of a range; this by definition moves the insertion point without selecting the range.
  context.document.body.paragraphs.getLast().select(Word.SelectionMode.end);

  await context.sync();
});

select(selectionModeString)

Sélectionne le paragraphe et y accède via l’interface utilisateur de Word.

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

Paramètres

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

Facultatif. 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.ParagraphUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties: Word.Interfaces.ParagraphUpdateData

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

Exemples

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

await Word.run(async (context) => {
  const paragraph = context.document.body.paragraphs.getFirst();
  paragraph.set({
    leftIndent: 30,
    font: {
      bold: true,
      color: "red"
    }
  });

  await context.sync();
});

...

await Word.run(async (context) => {
  const firstParagraph = context.document.body.paragraphs.getFirst();
  const secondParagraph = firstParagraph.getNext();
  firstParagraph.load("text, font/color, font/bold, leftIndent");

  await context.sync();

  secondParagraph.set(firstParagraph);

  await context.sync();
});

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.Paragraph): void;

Paramètres

properties: Word.Paragraph

Retours

void

split(delimiters, trimDelimiters, trimSpacing)

Divise le paragraphe en plages enfants à l’aide de délimiteurs.

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

Paramètres

delimiters: string[]

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

trimDelimiters: boolean

Facultatif. 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 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/split-words-of-first-paragraph.yaml

await Word.run(async (context) => {
  const paragraph = context.document.body.paragraphs.getFirst();
  const words = paragraph.split([" "], true /* trimDelimiters*/, true /* trimSpaces */);
  words.load("text");

  await context.sync();

  for (let i = 0; i < words.items.length; i++) {
    if (i >= 1) {
      words.items[i - 1].font.highlightColor = "#FFFFFF";
    }
    words.items[i].font.highlightColor = "#FFFF00";

    await context.sync();
    await pause(200);
  }
});

startNewList()

Démarre une nouvelle liste avec ce paragraphe. Échoue si le paragraphe est déjà un élément de liste.

startNewList(): Word.List;

Retours

Word.List

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/insert-list.yaml

// This example starts a new list with the second paragraph.
await Word.run(async (context) => {
  const paragraphs = context.document.body.paragraphs;
  paragraphs.load("$none");

  await context.sync();

  // Start new list using the second paragraph.
  const list = paragraphs.items[1].startNewList();
  list.load("$none");

  await context.sync();

  // To add new items to the list, use Start or End on the insertLocation parameter.
  list.insertParagraph("New list item at the start of the list", "Start");
  const paragraph = list.insertParagraph("New list item at the end of the list (set to list level 5)", "End");

  // Set up list level for the list item.
  paragraph.listItem.level = 4;

  // To add paragraphs outside the list, use Before or After.
  list.insertParagraph("New paragraph goes after (not part of the list)", "After");

  await context.sync();
});

toJSON()

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

toJSON(): Word.Interfaces.ParagraphData;

Retours

Word.Interfaces.ParagraphData

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.Paragraph;

Retours

Word.Paragraph

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.Paragraph;

Retours

Word.Paragraph

Share via

Word.Paragraph class

Remarques

Propriétés

Méthodes

Détails de la propriété

alignment

Valeur de propriété

Remarques

Exemples

contentControls

Valeur de propriété

Remarques

context

Valeur de propriété

firstLineIndent

Valeur de propriété

Remarques

font

Valeur de propriété

Remarques

inlinePictures

Valeur de propriété

Remarques

isLastParagraph

Valeur de propriété

Remarques

isListItem

Valeur de propriété

Remarques

leftIndent

Valeur de propriété

Remarques

Exemples

lineSpacing

Valeur de propriété

Remarques

Exemples

lineUnitAfter

Valeur de propriété

Remarques

Exemples

lineUnitBefore

Valeur de propriété

Remarques

Exemples

list

Valeur de propriété

Remarques

listItem

Valeur de propriété

Remarques

listItemOrNullObject

Valeur de propriété

Remarques

listOrNullObject

Valeur de propriété

Remarques

outlineLevel

Valeur de propriété

Remarques

parentBody

Valeur de propriété

Remarques

parentContentControl

Valeur de propriété

Remarques

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