Word.ParagraphCollection class

Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

readonly items: Word.Paragraph[];

Eigenschaftswert

Beispiele

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

Gibt ein Paragraph Objekt zurück, das einen neuen, leeren Absatz darstellt, der dem Dokument hinzugefügt wurde.

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Entfernt die Leerzeichen vor den angegebenen Absätzen.

closeUp(): void;

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Verringert den Abstand vor und nach Absätzen in Schritten von jeweils 6 Punkt.

decreaseSpacing(): void;

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Ruft den ersten Absatz in dieser Sammlung ab. Gibt einen ItemNotFound Fehler aus, wenn die Sammlung leer ist.

getFirst(): Word.Paragraph;

Gibt zurück

Hinweise

API-Satz: WordApi 1.3

Beispiele

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

Ruft den ersten Absatz in dieser Sammlung ab. Wenn die Auflistung leer ist, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getFirstOrNullObject(): Word.Paragraph;

Gibt zurück

Hinweise

API-Satz: WordApi 1.3

Ruft den letzten Absatz in dieser Sammlung ab. Gibt einen ItemNotFound Fehler aus, wenn die Sammlung leer ist.

getLast(): Word.Paragraph;

Gibt zurück

Hinweise

API-Satz: WordApi 1.3

Beispiele

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

Ruft den letzten Absatz in dieser Sammlung ab. Wenn die Auflistung leer ist, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getLastOrNullObject(): Word.Paragraph;

Gibt zurück

Hinweise

API-Satz: WordApi 1.3

Erhöht den Abstand vor und nach Absätzen in Schritten von jeweils 6 Punkt.

increaseSpacing(): void;

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Einrücken der Absätze um eine Ebene.

indent(): void;

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Rückt die Absätze in der Sammlung um die angegebene Anzahl von Zeichen ein.

indentCharacterWidth(count: number): void;

Parameter

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Einrückt die erste Zeile der Absätze in der Sammlung um die angegebene Anzahl von Zeichen.

indentFirstLineCharacterWidth(count: number): void;

Parameter

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(options?: Word.Interfaces.ParagraphCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ParagraphCollection;

Parameter

Gibt zurück

Beispiele

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

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

Gibt zurück

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ParagraphCollection;

Parameter

Gibt zurück

Schaltet den Abstand vor Absätzen um.

openOrCloseUp(): void;

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Legt den Leerraum vor den angegebenen Absätzen auf 12 Punkt fest.

openUp(): void;

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Entfernt eine Einzugsebene für die Absätze.

outdent(): void;

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Weist den angegebenen Absätzen die Überschriftformatvorlage der nächsten Ebene (Überschrift 1 bis Überschrift 8) zu.

outlineDemote(): void;

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Stuft die angegebenen Absätze in Textkörper herab, indem die Formatvorlage "Standard" angewendet wird.

outlineDemoteToBody(): void;

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Wendet die Formatvorlage der vorherigen Überschriftenebene (Überschrift 1 bis Überschrift 8) auf die Absätze in der Sammlung an.

outlinePromote(): void;

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Legt die angegebenen Absätze auf einen einfachen Abstand fest.

space1(): void;

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Legt die angegebenen Absätze auf einen Abstand von 1,5 Zeilen fest.

space1Pt5(): void;

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Legt die angegebenen Absätze auf doppelten Abstand fest.

space2(): void;

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Legt einen hängenden Einzug auf die angegebene Anzahl von Tabstopps fest.

tabHangingIndent(count: number): void;

Parameter

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Legt den linken Einzug für die angegebenen Absätze auf die angegebene Anzahl von Tabstopps fest.

tabIndent(count: number): void;

Parameter

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON Methode des Objekts auf, das an sie übergeben wird.) Während das ursprüngliche Word.ParagraphCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.ParagraphCollectionData) zurück, das ein "items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Sammlung enthält.

toJSON(): Word.Interfaces.ParagraphCollectionData;

Gibt zurück

Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt aufrufübergreifend .sync und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt ein "InvalidObjectPath"-Fehler angezeigt wird, müssen Sie das Objekt der nachverfolgten Objektsammlung hinzufügen, wenn das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Sammlung ist, sollten Sie auch die übergeordnete Sammlung nachverfolgen.

track(): Word.ParagraphCollection;

Gibt zurück

Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen einen Aufruf durchführen context.sync() , bevor die Speicherfreigabe wirksam wird.

untrack(): Word.ParagraphCollection;

Gibt zurück