Word.Paragraph class

Spécifie l’alignement d’un paragraphe. La valeur peut être left, centered, rightou justified.

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

Valeur de propriété

Remarques

Jeu 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();
});

Renvoie un BorderUniversalCollection objet qui représente toutes les bordures du paragraphe.

readonly borders: Word.BorderUniversalCollection;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Obtient la collection d’objets ContentControl dans le paragraphe.

readonly contentControls: Word.ContentControlCollection;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.1

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Obtient la collection des notes de fin dans le paragraphe.

readonly endnotes: Word.NoteItemCollection;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.5

Obtient l’ensemble des champs du paragraphe.

readonly fields: Word.FieldCollection;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.4

Spécifie la valeur, en points, d’une première ligne ou d’un retrait suspendu. 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é

Remarques

Jeu d’API : WordApi 1.1

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é

Remarques

Jeu d’API : WordApi 1.1

Obtient la collection de notes de bas de page dans le paragraphe.

readonly footnotes: Word.NoteItemCollection;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.5

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é

Remarques

Jeu d’API : WordApi 1.1

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

readonly isLastParagraph: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.3

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

readonly isListItem: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.3

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

leftIndent: number;

Valeur de propriété

Remarques

Jeu 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();
});

Spécifie l’interligne, 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é

Remarques

Jeu 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();
});

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

lineUnitAfter: number;

Valeur de propriété

Remarques

Jeu 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();
});

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

lineUnitBefore: number;

Valeur de propriété

Remarques

Jeu 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();
});

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é

Remarques

Jeu d’API : WordApi 1.3

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é

Remarques

Jeu d’API : WordApi 1.3

Obtient l’élément de liste du paragraphe. Si le paragraphe ne fait pas partie d’une liste, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

readonly listItemOrNullObject: Word.ListItem;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.3

Obtient la liste à laquelle ce paragraphe appartient. Si le paragraphe ne figure pas dans une liste, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

readonly listOrNullObject: Word.List;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.3

Spécifie le niveau hiérarchique du paragraphe.

outlineLevel: number;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.1

Obtient le corps parent du paragraphe.

readonly parentBody: Word.Body;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.3

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é

Remarques

Jeu d’API : WordApi 1.1

Obtient le contrôle de contenu qui contient le paragraphe. S’il n’existe pas de contrôle de contenu parent, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

readonly parentContentControlOrNullObject: Word.ContentControl;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.3

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é

Remarques

Jeu d’API : WordApi 1.3

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é

Remarques

Jeu d’API : WordApi 1.3

Obtient la cellule de tableau qui contient le paragraphe. S’il n’est pas contenu 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 d’OrNullObject.

readonly parentTableCellOrNullObject: Word.TableCell;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.3

Obtient le tableau qui contient le paragraphe. S’il n’est pas contenu dans une table, 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 d’OrNullObject.

readonly parentTableOrNullObject: Word.Table;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.3

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

rightIndent: number;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.1

Renvoie un ShadingUniversal objet qui fait référence à la mise en forme d’ombrage pour le paragraphe.

readonly shading: Word.ShadingUniversal;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Obtient la collection d’objets Shape ancrés dans le paragraphe, y compris les formes incorporées et flottantes. Actuellement, seules les formes suivantes sont prises en charge : zones de texte, formes géométriques, groupes, images et canevas.

readonly shapes: Word.ShapeCollection;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Important : sachez qu’avec le temps, d’autres types de formes peuvent être pris en charge. Par conséquent, votre complément doit demander et gérer des types de formes spécifiques.

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

spaceAfter: number;

Valeur de propriété

Remarques

Jeu 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();
});

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

spaceBefore: number;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.1

Spécifie le nom du style du 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é

Remarques

Jeu 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 = (document.getElementById("style-name-to-use") as HTMLInputElement).value;
  if (styleName == "") {
    console.warn("Enter a style name to apply.");
    return;
  }

  const style: Word.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: Word.Body = context.document.body;
    body.clear();
    body.insertParagraph(
      "Do you want to create a solution that extends the functionality of Word? You can use the Office Add-ins platform to extend Word clients running on the web, on a Windows desktop, or on a Mac.",
      "Start"
    );
    const paragraph: Word.Paragraph = body.paragraphs.getFirst();
    paragraph.style = style.nameLocal;
    console.log(`'${styleName}' style applied to first paragraph.`);
  }
});

Spécifie le nom du 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

Jeu 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: Word.Paragraph = context.document.body.insertParagraph("Timeline", "End");
    paragraph.styleBuiltIn = "Heading2";
    const paragraph2: Word.Paragraph = 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: Word.Paragraph = 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: Word.Paragraph = context.document.body.insertParagraph("<Add Project Costs Here>", "End");
    paragraph4.styleBuiltIn = "Normal";
    paragraph4.font.highlightColor = "#FFFF00";
    const contentControl: Word.ContentControl = paragraph4.insertContentControl();
    contentControl.title = "ProjectCosts";
    const paragraph5: Word.Paragraph = context.document.body.insertParagraph("Project Team", "End");
    paragraph5.styleBuiltIn = "Heading2";
    paragraph5.font.highlightColor = "#FFFFFF";
    const paragraph6: Word.Paragraph = context.document.body.insertParagraph("Terms of Work", "End");
    paragraph6.styleBuiltIn = "Heading1";
    const paragraph7: Word.Paragraph = context.document.body.insertParagraph("Contractor shall provide the Services and Deliverable(s) as follows:", "End");
    paragraph7.styleBuiltIn = "Normal";
    const paragraph8: Word.Paragraph = context.document.body.insertParagraph("Out-of-Pocket Expenses / Invoice Procedures", "End");
    paragraph8.styleBuiltIn = "Heading2";
    const paragraph9 : Word.Paragraph= 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();
});

Obtient le niveau de tableau du paragraphe. La valeur renvoie 0 si le paragraphe ne figure pas dans un tableau.

readonly tableNestingLevel: number;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.3

Obtient le texte du paragraphe.

readonly text: string;

Valeur de propriété

Remarques

Jeu 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: Word.Paragraph = context.document.getSelection().paragraphs.getFirst();
  paragraph.load("text");

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

Obtient une chaîne qui représente l’identificateur de paragraphe dans la session active. ID est au format GUID 8-4-4-4-12 standard sans accolades et diffère selon les sessions et les co-auteurs.

readonly uniqueLocalId: string;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.6

Exemples

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

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function paragraphChanged(args: Word.ParagraphChangedEventArgs) {
  await Word.run(async (context) => {
    const results = [];
    for (let id of args.uniqueLocalIds) {
      let para = context.document.getParagraphByUniqueLocalId(id);
      para.load("uniqueLocalId");

      results.push({ para: para, text: para.getText() });
    }

    await context.sync();

    for (let result of results) {
      console.log(`${args.type}: ID ${result.para.uniqueLocalId}:-`, result.text.value);
    }
  });
}

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

Retours

Remarques

Jeu d’API : WordApi 1.3

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

clear(): void;

Retours

Remarques

Jeu 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.');
});

Supprime tout espace avant le paragraphe.

closeUp(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Supprime le paragraphe et son contenu du document.

delete(): void;

Retours

Remarques

Jeu 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.');
});

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

detachFromList(): void;

Retours

Remarques

Jeu d’API : WordApi 1.3

Récupère les annotations définies sur cet Paragraph objet.

getAnnotations(): Word.AnnotationCollection;

Retours

Remarques

Jeu d’API : WordApi 1.7

Important : cette API nécessite un abonnement Microsoft 365 pour fonctionner correctement en raison de l’exigence d’un service sous-jacent. Pour plus d’informations à ce sujet, consultez le problème GitHub 4953.

Obtient les commentaires associés au paragraphe.

getComments(): Word.CommentCollection;

Retours

Remarques

Jeu d’API : WordApi 1.4

Obtient les contrôles de contenu actuellement pris en charge dans le paragraphe.

getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;

Paramètres

Retours

Remarques

Jeu d’API : WordApi 1.5

Important : Si des types spécifiques sont fournis dans le paramètre options, seuls les contrôles de contenu des types pris en charge sont renvoyés. Notez qu’une exception sera levée lors de l’utilisation des méthodes d’un Word générique. ContentControl qui ne sont pas pertinents pour le type spécifique. Avec le temps, d’autres types de contrôles de contenu peuvent être pris en charge. Par conséquent, votre complément doit demander et gérer des types spécifiques de contrôles de contenu.

Obtient une représentation HTML de l’objet Paragraph . Dans une page web ou une visionneuse HTML, la mise en forme correspondra étroitement, mais pas exactement, à la mise en forme du document. Cette méthode ne renvoie 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 XML renvoyé en HTML.

getHtml(): OfficeExtension.ClientResult<string>;

Retours

Remarques

Jeu 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);
});

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

getNext(): Word.Paragraph;

Retours

Remarques

Jeu d’API : WordApi 1.3

Obtient le paragraphe suivant. Si le paragraphe est le dernier, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

getNextOrNullObject(): Word.Paragraph;

Retours

Remarques

Jeu d’API : WordApi 1.3

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

getOoxml(): OfficeExtension.ClientResult<string>;

Retours

Remarques

Jeu 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);
});

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

getPrevious(): Word.Paragraph;

Retours

Remarques

Jeu d’API : WordApi 1.3

Obtient le paragraphe précédent. Si le paragraphe est le premier, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

getPreviousOrNullObject(): Word.Paragraph;

Retours

Remarques

Jeu 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);
    }
});

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

Retours

Remarques

Jeu 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);
  }
});

Obtient le texte révisé en fonction de la ChangeTrackingVersion sélection.

getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;

Paramètres

Retours

Remarques

Jeu d’API : WordApi 1.4

Obtient le texte révisé en fonction de la ChangeTrackingVersion sélection.

getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;

Paramètres

Retours

Remarques

Jeu d’API : WordApi 1.4

Renvoie le texte du paragraphe. Cela exclut les équations, les graphiques (par exemple, les images, les vidéos, les dessins) et les caractères spéciaux qui marquent différents contenus (par exemple, pour les contrôles de contenu, les champs, les commentaires, les notes de bas de page, les notes de fin). Par défaut, le texte masqué et le texte marqué comme supprimé sont exclus.

getText(options?: Word.GetTextOptions | {
            IncludeHiddenText?: boolean;
            IncludeTextMarkedAsDeleted?: boolean;
        }): OfficeExtension.ClientResult<string>;

Paramètres

Retours

Remarques

Jeu d’API : WordApi 1.7

Obtient les plages de texte dans le paragraphe à l’aide de signes de ponctuation et d’autres signes de fin.

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

Paramètres

Retours

Remarques

Jeu d’API : WordApi 1.3

Obtient la collection des TrackedChange objets dans le paragraphe.

getTrackedChanges(): Word.TrackedChangeCollection;

Retours

Remarques

Jeu d’API : WordApi 1.6

Met en retrait le paragraphe d’un niveau.

indent(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Mettre en retrait le paragraphe d’un nombre de caractères spécifié.

indentCharacterWidth(count: number): void;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Met en retrait la première ligne du paragraphe en fonction du nombre de caractères spécifié.

indentFirstLineCharacterWidth(count: number): void;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Insère des annotations sur cet Paragraph objet.

insertAnnotations(annotations: Word.AnnotationSet): OfficeExtension.ClientResult<string[]>;

Paramètres

Retours

Tableau des identificateurs d’annotations insérés.

Remarques

Jeu d’API : WordApi 1.7

Important : cette API nécessite un abonnement Microsoft 365 pour fonctionner correctement en raison de l’exigence d’un service sous-jacent. Pour plus d’informations à ce sujet, consultez le problème GitHub 4953.

Exemples

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

// Adds annotations to the selected paragraph.
await Word.run(async (context) => {
  const paragraph: Word.Paragraph = context.document.getSelection().paragraphs.getFirst();
  const options: Word.CritiquePopupOptions = {
    brandingTextResourceId: "PG.TabLabel",
    subtitleResourceId: "PG.HelpCommand.TipTitle",
    titleResourceId: "PG.HelpCommand.Label",
    suggestions: ["suggestion 1", "suggestion 2", "suggestion 3"]
  };
  const critique1: Word.Critique = {
    colorScheme: Word.CritiqueColorScheme.red,
    start: 1,
    length: 3,
    popupOptions: options
  };
  const critique2: Word.Critique = {
    colorScheme: Word.CritiqueColorScheme.green,
    start: 6,
    length: 1,
    popupOptions: options
  };
  const critique3: Word.Critique = {
    colorScheme: Word.CritiqueColorScheme.blue,
    start: 10,
    length: 3,
    popupOptions: options
  };
  const critique4: Word.Critique = {
    colorScheme: Word.CritiqueColorScheme.lavender,
    start: 14,
    length: 3,
    popupOptions: options
  };
  const critique5: Word.Critique = {
    colorScheme: Word.CritiqueColorScheme.berry,
    start: 18,
    length: 10,
    popupOptions: options
  };
  const annotationSet: Word.AnnotationSet = {
    critiques: [critique1, critique2, critique3, critique4, critique5]
  };

  const annotationIds = paragraph.insertAnnotations(annotationSet);

  await context.sync();

  console.log("Annotations inserted:", annotationIds.value);
});

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

Retours

Remarques

Jeu d’API : WordApi 1.1

Exemples

// 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");
});

Insère une zone de dessin flottante devant le texte avec son ancrage au début du paragraphe.

insertCanvas(insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.2

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

insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | Word.ContentControlType.buildingBlockGallery | Word.ContentControlType.datePicker | Word.ContentControlType.repeatingSection | Word.ContentControlType.picture | Word.ContentControlType.group | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox" | "BuildingBlockGallery" | "DatePicker" | "RepeatingSection" | "Picture" | "Group"): Word.ContentControl;

Paramètres

Retours

Remarques

Jeu 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. Prise en charge de buildingBlockGallery,datePicker , picturegroup, et repeatingSection a été ajouté dans WordApiDesktop 1.3.

Exemples

// 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();
});

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

Retours

Remarques

Jeu d’API : WordApi 1.1

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 adaptée à votre scénario.

Insère une forme géométrique devant le texte avec son ancrage au début du paragraphe.

insertGeometricShape(geometricShapeType: Word.GeometricShapeType, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.2

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/45-shapes/group-ungroup.yaml

await Word.run(async (context) => {
  const body: Word.Body = context.document.body;
  body.clear();
  const lastParagraph: Word.Paragraph = body.paragraphs.getLast();

  // Inserts a text box.
  const textBoxOptions: Word.InsertShapeOptions = {
    top: 0,
    left: 0,
    height: 100,
    width: 100,
  };
  lastParagraph.insertTextBox("placeholder text", textBoxOptions);

  // Inserts a geometric shape.
  const geometricShapeOptions: Word.InsertShapeOptions = {
    height: 120,
    width: 120,
    left: 120,
  };
  lastParagraph.insertGeometricShape(Word.GeometricShapeType.star24, geometricShapeOptions);

  // Inserts a picture.
  const pictureOptions: Word.InsertShapeOptions = {
    top: 120,
    left: 60,
    height: 150,
    width: 150,
  };
  lastParagraph.insertPictureFromBase64(getPictureBase64(), pictureOptions);

  await context.sync();
});

Insère une forme géométrique devant le texte avec son ancrage au début du paragraphe.

insertGeometricShape(geometricShapeType: "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus", insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.2

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

Retours

Remarques

Jeu 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.');
});

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

Retours

Remarques

Jeu 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.');
});

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

Retours

Remarques

Jeu d’API : WordApi 1.1

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

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

Paramètres

Retours

Remarques

Jeu d’API : WordApi 1.1

Insère une image flottante devant le texte avec son ancrage au début du paragraphe.

insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.2

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

Retours

Remarques

Jeu d’API : WordApi 1.3

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

Retours

Remarques

Jeu 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: Word.Range = context.document.body.paragraphs.getLast().insertText("Just replaced the last paragraph!", "Replace");
  range.font.highlightColor = "black";
  range.font.color = "white";

  await context.sync();
});

Insère une zone de texte flottante devant le texte avec son ancrage au début du paragraphe.

insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.2

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/45-shapes/manage-shapes-text-boxes.yaml

await Word.run(async (context) => {
  // Inserts a text box at the beginning of the first paragraph in the header.
  const headerFooterBody: Word.Body = context.document.sections.getFirst().getHeader(Word.HeaderFooterType.primary);
  headerFooterBody.load("paragraphs");
  const firstParagraph: Word.Paragraph = headerFooterBody.paragraphs.getFirst();
  const insertShapeOptions: Word.InsertShapeOptions = {
    top: 0,
    left: 0,
    height: 100,
    width: 100
  };
  const newTextBox: Word.Shape = firstParagraph.insertTextBox("placeholder text", insertShapeOptions);
  newTextBox.select();
  await context.sync();

  console.log("Inserted a text box at the beginning of the first paragraph in the header.");
});

Joint un paragraphe de liste avec la liste la plus proche au-dessus ou en dessous de ce paragraphe.

joinList(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

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

Retours

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

Retours

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

Retours

Renvoie un Paragraph objet représentant le paragraphe suivant.

next(count: number): Word.Paragraph;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Active/désactive l’espacement avant le paragraphe.

openOrCloseUp(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Définit l’espacement avant le paragraphe sur 12 points.

openUp(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Supprime un niveau de retrait pour le paragraphe.

outdent(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Applique le style de niveau de titre suivant (Titre 1 à Titre 8) au paragraphe.

outlineDemote(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Rétrograde le paragraphe au corps du texte en appliquant le style Normal.

outlineDemoteToBody(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Applique le style de niveau de titre précédent (Titre 1 à Titre 8) au paragraphe.

outlinePromote(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Renvoie le paragraphe précédent sous la forme d’un Paragraph objet.

previous(count: number): Word.Paragraph;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Supprime la mise en forme manuelle des paragraphes (à savoir la mise en forme qui n'est pas appliquée à l'aide d'un style).

reset(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Réinitialise le paragraphe qui utilise des niveaux de liste personnalisés aux paramètres de niveau d’origine.

resetAdvanceTo(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Effectue une recherche avec les options de recherche spécifiées sur l’étendue de l’objet Paragraph . Les résultats de la recherche sont une collection d’objets Range .

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

Paramètres

Retours

Remarques

Jeu d’API : WordApi 1.1

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

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

Paramètres

Retours

Remarques

Jeu 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();
});

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

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

Paramètres

Retours

Remarques

Jeu d’API : WordApi 1.1

Sélectionne le numéro ou la puce d'une liste.

selectNumber(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Divise une liste en deux listes séparées. Pour les listes numérotées, la nouvelle liste redémarre la numérotation au numéro de départ, généralement 1.

separateList(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

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

Paramètres

Retours

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: Word.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: Word.Paragraph = context.document.body.paragraphs.getFirst();
  const secondParagraph: Word.Paragraph = firstParagraph.getNext();
  firstParagraph.load("text, font/color, font/bold, leftIndent");

  await context.sync();

  secondParagraph.set(firstParagraph);

  await context.sync();
});

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

Retours

Définit le paragraphe sur un interligne simple.

space1(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Définit l’espacement du paragraphe sur 1,5 ligne.

space1Pt5(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Double espacement du paragraphe.

space2(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

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

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

Paramètres

Retours

Remarques

Jeu 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: Word.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);
  }
});

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

startNewList(): Word.List;

Retours

Remarques

Jeu 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: Word.ParagraphCollection = context.document.body.paragraphs;
  paragraphs.load("$none");

  await context.sync();

  // Start new list using the second paragraph.
  const list: Word.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: Word.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();
});

Définit un retrait négatif égal à un nombre de tabulations spécifié.

tabHangingIndent(count: number): void;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Définit le retrait à gauche du paragraphe sur un nombre spécifié d’arrêts de tabulation.

tabIndent(count: number): void;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

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.Paragraph est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Word.Interfaces.ParagraphDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Word.Interfaces.ParagraphData;

Retours

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 entre 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 suivis lors de la création initiale de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

track(): Word.Paragraph;

Retours

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est l’abréviation de 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 libération de mémoire prenne effet.

untrack(): Word.Paragraph;

Retours

Se produit lorsque de nouveaux commentaires sont ajoutés.

readonly onCommentAdded: OfficeExtension.EventHandlers<Word.CommentEventArgs>;

Type d’événement

Remarques

Jeu d’API : WordApi BÊTA (PRÉVERSION UNIQUEMENT)

Se produit lorsqu’un commentaire ou sa réponse est modifié.

readonly onCommentChanged: OfficeExtension.EventHandlers<Word.CommentEventArgs>;

Type d’événement

Remarques

Jeu d’API : WordApi BÊTA (PRÉVERSION UNIQUEMENT)

Se produit lorsque des commentaires sont supprimés.

readonly onCommentDeleted: OfficeExtension.EventHandlers<Word.CommentEventArgs>;

Type d’événement

Remarques

Jeu d’API : WordApi BÊTA (PRÉVERSION UNIQUEMENT)

Se produit lorsqu’un commentaire est désélectionné.

readonly onCommentDeselected: OfficeExtension.EventHandlers<Word.CommentEventArgs>;

Type d’événement

Remarques

Jeu d’API : WordApi BÊTA (PRÉVERSION UNIQUEMENT)

Se produit lorsqu’un commentaire est sélectionné.

readonly onCommentSelected: OfficeExtension.EventHandlers<Word.CommentEventArgs>;

Type d’événement

Remarques

Jeu d’API : WordApi BÊTA (PRÉVERSION UNIQUEMENT)