Word.ParagraphCollection class

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é

Obtient l’élément enfant chargé dans cette collection de sites.

readonly items: Word.Paragraph[];

Valeur de propriété

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

Renvoie un Paragraph objet qui représente un nouveau paragraphe vide ajouté au document.

add(range: Word.Range): Word.Paragraph;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Supprime tout espace situé avant les paragraphes spécifiés.

closeUp(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Diminue l'espacement avant et après les paragraphes par incréments de 6 points.

decreaseSpacing(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient le premier paragraphe de cette collection. Génère une ItemNotFound erreur si la collection est vide.

getFirst(): Word.Paragraph;

Retours

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Exemples

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

// Gets annotations found in the selected paragraph.
await Word.run(async (context) => {
  const paragraph: Word.Paragraph = context.document.getSelection().paragraphs.getFirst();
  const annotations: Word.AnnotationCollection = paragraph.getAnnotations();
  annotations.load("id,state,critiqueAnnotation");

  await context.sync();

  console.log("Annotations found:");

  for (let i = 0; i < annotations.items.length; i++) {
    const annotation: Word.Annotation = annotations.items[i];

    console.log(`ID ${annotation.id} - state '${annotation.state}':`, annotation.critiqueAnnotation.critique);
  }
});

Obtient le premier paragraphe de cette collection. Si la collection est vide, 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.

getFirstOrNullObject(): Word.Paragraph;

Retours

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Obtient le dernier paragraphe dans cette collection. Génère une ItemNotFound erreur si la collection est vide.

getLast(): Word.Paragraph;

Retours

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/15-images/insert-and-get-pictures.yaml

// Inserts an image anchored to the last paragraph.
await Word.run(async (context) => {
  context.document.body.paragraphs
    .getLast()
    .insertParagraph("", "After")
    .insertInlinePictureFromBase64(base64Image, "End");

  await context.sync();
});

Obtient le dernier paragraphe dans cette collection. Si la collection est vide, 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.

getLastOrNullObject(): Word.Paragraph;

Retours

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Augmente l'espacement avant et après les paragraphes par incréments de 6 points.

increaseSpacing(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Met en retrait les paragraphes d’un niveau.

indent(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Met en retrait les paragraphes de la collection en fonction du nombre de caractères spécifié.

indentCharacterWidth(count: number): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

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

indentFirstLineCharacterWidth(count: number): void;

Paramètres

Retours

Remarques

[ Ensemble 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.ParagraphCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ParagraphCollection;

Paramètres

Retours

Exemples

// This example shows how to get the paragraphs in the Word document
// along with their text and font size properties.
// 
// 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 and font properties.
    // It is best practice to always specify the property set. Otherwise, all properties are
    // returned in on the object.
    paragraphs.load('text, font/size');

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

    // Insert code that works with the paragraphs loaded by paragraphs.load().
});

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

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?: OfficeExtension.LoadOption): Word.ParagraphCollection;

Paramètres

Retours

Change l'espacement avant des paragraphes.

openOrCloseUp(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Définit un espacement avant les paragraphes spécifiés équivalent à 12 points.

openUp(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Supprime un niveau de retrait pour les paragraphes.

outdent(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Applique le style de niveau de titre suivant (de Titre 1 à Titre 8) aux paragraphes spécifiés.

outlineDemote(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Rétrograde les paragraphes spécifiés en corps de texte en appliquant le style Normal.

outlineDemoteToBody(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Applique le style de niveau de titre précédent (Titre 1 à Titre 8) aux paragraphes de la collection.

outlinePromote(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Définit les paragraphes spécifiés sur un espacement unique.

space1(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Définit les paragraphes spécifiés sur un espacement de 1,5 ligne.

space1Pt5(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Définit les paragraphes spécifiés sur un espacement double.

space2(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Définit un retrait négatif sur le nombre spécifié de taquets de tabulation.

tabHangingIndent(count: number): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Définit le retrait gauche des paragraphes spécifiés sur le nombre spécifié de taquets de tabulation.

tabIndent(count: number): void;

Paramètres

Retours

Remarques

[ Ensemble 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.ParagraphCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.ParagraphCollectionDataque ) qui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

toJSON(): Word.Interfaces.ParagraphCollectionData;

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

Retours

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

Retours