Word.Paragraph class

Legt die Ausrichtung für einen Absatz fest. Der Wert kann ,centered ,right oderjustified sein.left

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

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.1

Beispiele

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

Gibt ein BorderUniversalCollection Objekt zurück, das alle Rahmen eines Absatzes darstellt.

readonly borders: Word.BorderUniversalCollection;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.3

Ruft die Sammlung der ContentControl Objekte im Absatz ab.

readonly contentControls: Word.ContentControlCollection;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.1

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

context: RequestContext;

Eigenschaftswert

Ruft die Sammlung der Endnoten im Absatz ab.

readonly endnotes: Word.NoteItemCollection;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.5

Ruft die Auflistung der Felder im Absatz ab.

readonly fields: Word.FieldCollection;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.4

Gibt den Wert in Punkt für eine erste Zeile oder einen hängenden Einzug an. Verwenden Sie zum Festlegen eines Erstzeileneinzugs einen positiven Wert, und verwenden Sie für einen negativen Wert für einen hängenden Einzug.

firstLineIndent: number;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.1

Ruft das Textformat des Abschnitts ab. Verwenden Sie diese Option zum Abrufen und Festlegen der Schriftart, Größe, Farbe und anderer Eigenschaften.

readonly font: Word.Font;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.1

Ruft die Sammlung der Fußnoten im Absatz ab.

readonly footnotes: Word.NoteItemCollection;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.5

Ruft die Sammlung der InlinePicture Objekte im Absatz ab. Die Sammlung enthält keine schwebenden Bilder.

readonly inlinePictures: Word.InlinePictureCollection;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.1

Gibt an, dass es sich bei dem Absatz um den letzten innerhalb seines übergeordneten Texts handelt.

readonly isLastParagraph: boolean;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.3

Überprüft, ob der Absatz ein Listenelement ist.

readonly isListItem: boolean;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.3

Gibt den linken Einzugswert (in Punkt) für den Absatz an.

leftIndent: number;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.1

Beispiele

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

Gibt den Zeilenabstand für den angegebenen Absatz in Punkt an. Auf der Word-Benutzeroberfläche wird dieser Wert durch 12 dividiert.

lineSpacing: number;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.1

Beispiele

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

Gibt den Abstand in Rasterlinien nach dem Absatz an.

lineUnitAfter: number;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.1

Beispiele

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

Gibt den Abstand in Gitternetzlinien vor dem Absatz an.

lineUnitBefore: number;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.1

Beispiele

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

Ruft die Liste ab, zu der dieser Absatz gehört. Gibt einen ItemNotFound Fehler aus, wenn sich der Absatz nicht in einer Liste befindet.

readonly list: Word.List;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.3

Ruft das ListItem für den Absatz ab. Gibt einen ItemNotFound Fehler aus, wenn der Absatz nicht Teil einer Liste ist.

readonly listItem: Word.ListItem;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.3

Ruft das ListItem für den Absatz ab. Wenn der Absatz nicht Teil einer Liste ist, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

readonly listItemOrNullObject: Word.ListItem;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.3

Ruft die Liste ab, zu der dieser Absatz gehört. Wenn der Absatz nicht in einer Liste enthalten ist, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

readonly listOrNullObject: Word.List;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.3

Gibt die Gliederungsebene für den Absatz an.

outlineLevel: number;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.1

Ruft den übergeordneten Text des Absatzes ab.

readonly parentBody: Word.Body;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.3

Ruft das Inhaltssteuerelement ab, das den Abschnitt enthält. Gibt einen ItemNotFound Fehler aus, wenn kein übergeordnetes Inhaltssteuerelement vorhanden ist.

readonly parentContentControl: Word.ContentControl;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.1

Ruft das Inhaltssteuerelement ab, das den Abschnitt enthält. Wenn kein übergeordnetes Inhaltssteuerelement vorhanden ist, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

readonly parentContentControlOrNullObject: Word.ContentControl;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.3

Ruft die Tabelle ab, die den Absatz enthält. Gibt einen ItemNotFound Fehler aus, wenn er nicht in einer Tabelle enthalten ist.

readonly parentTable: Word.Table;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.3

Ruft die Tabellenzelle ab, die den Absatz enthält. Gibt einen ItemNotFound Fehler aus, wenn er nicht in einer Tabellenzelle enthalten ist.

readonly parentTableCell: Word.TableCell;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.3

Ruft die Tabellenzelle ab, die den Absatz enthält. Wenn sie nicht in einer Tabellenzelle enthalten ist, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

readonly parentTableCellOrNullObject: Word.TableCell;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.3

Ruft die Tabelle ab, die den Absatz enthält. Wenn sie nicht in einer Tabelle enthalten ist, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

readonly parentTableOrNullObject: Word.Table;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.3

Gibt den rechten Einzugswert (in Punkt) für den Absatz an.

rightIndent: number;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.1

Gibt ein ShadingUniversal Objekt zurück, das auf die Schattierungsformatierung für den Absatz verweist.

readonly shading: Word.ShadingUniversal;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.3

Ruft die Sammlung der im Absatz verankerten Shape Objekte ab, einschließlich Inline- und unverankerter Formen. Derzeit werden nur die folgenden Formen unterstützt: Textfelder, geometrische Formen, Gruppen, Bilder und Leinwände.

readonly shapes: Word.ShapeCollection;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.2

Wichtig: Beachten Sie, dass mit der Zeit weitere Arten von Formen unterstützt werden können. Daher sollte Ihr Add-In bestimmte Arten von Formen anfordern und verarbeiten.

Gibt den Abstand in Punkt nach dem Absatz an.

spaceAfter: number;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.1

Beispiele

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

Gibt den Abstand (in Punkt) vor dem Absatz an.

spaceBefore: number;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.1

Gibt den Formatvorlagennamen für den Absatz an. Verwenden Sie diese Eigenschaft für benutzerdefinierte Formatvorlagen und lokalisierte Formatvorlagennamen. Informationen zur Verwendung der integrierten Formatvorlagen, die zwischen Gebietsschemas portabel sind, finden Sie unter der Eigenschaft "styleBuiltIn".

style: string;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.1

Beispiele

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

Gibt den Namen der integrierten Formatvorlage für den Absatz an. Verwenden Sie diese Eigenschaft für integrierte Formatvorlagen, die zwischen Gebietsschemas portabel sind. Informationen zum Verwenden benutzerdefinierter Formatvorlagen oder lokalisierter Namen finden Sie unter der Eigenschaft "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";

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.3

Beispiele

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

Ruft die Ebene der Tabelle des Absatzes ab. Sie gibt 0 zurück, wenn sich der Absatz nicht in einer Tabelle befindet.

readonly tableNestingLevel: number;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.3

Ruft den Text des Absatzes ab.

readonly text: string;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.1

Beispiele

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

Ruft eine Zeichenfolge ab, die den Absatzbezeichner in der aktuellen Sitzung darstellt. Die ID liegt im 8-4-4-4-12-Standardformat für GUIDs ohne geschweifte Klammern vor und unterscheidet sich zwischen Sitzungen und Co-Autoren.

readonly uniqueLocalId: string;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.6

Beispiele

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

Fügt den Absatz zu einer vorhandenen Liste auf der angegebenen Ebene hinzu. Führt zu einem Fehler, wenn der Absatz nicht in die Liste aufgenommen werden kann oder der Absatz bereits ein Listenelement ist.

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApi 1.3

Löscht den Inhalt des Paragraph Objekts. Der Benutzer kann den Rückgängig-Vorgang auf den gelöschten Inhalt durchführen.

clear(): void;

Gibt zurück

Hinweise

API-Satz: WordApi 1.1

Beispiele

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

Entfernt alle Abstände vor dem Absatz.

closeUp(): void;

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Löscht den Absatz und seinen Inhalt aus dem Dokument.

delete(): void;

Gibt zurück

Hinweise

API-Satz: WordApi 1.1

Beispiele

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

Verschiebt diesen Absatz aus der Liste, falls der Absatz ein Listenelement ist.

detachFromList(): void;

Gibt zurück

Hinweise

API-Satz: WordApi 1.3

Ruft Anmerkungen ab, die für dieses Paragraph Objekt festgelegt wurden.

getAnnotations(): Word.AnnotationCollection;

Gibt zurück

Hinweise

API-Satz: WordApi 1.7

Wichtig: Diese API erfordert ein Microsoft 365-Abonnement, um aufgrund der Anforderung eines zugrunde liegenden Dienstes ordnungsgemäß zu funktionieren. Weitere Informationen hierzu finden Sie im GitHub-Problem 4953.

Ruft Kommentare ab, die dem Absatz zugeordnet sind.

getComments(): Word.CommentCollection;

Gibt zurück

Hinweise

API-Satz: WordApi 1.4

Ruft die derzeit unterstützten Inhaltssteuerelemente im Absatz ab.

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApi 1.5

Wichtig: Wenn bestimmte Typen im options-Parameter angegeben werden, werden nur Inhaltssteuerelemente unterstützter Typen zurückgegeben. Beachten Sie, dass bei Verwendung der Methoden eines generischen Word eine Ausnahme ausgelöst wird. ContentControl, die für den spezifischen Typ nicht relevant sind. Mit der Zeit werden u. U. weitere Arten von Inhaltssteuerelementen unterstützt. Deshalb sollte Ihr Add-In bestimmte Arten von Inhaltssteuerelementen anfordern und verarbeiten.

Ruft eine HTML-Darstellung des Paragraph Objekts ab. Beim Rendern in einer Webseite oder einem HTML-Viewer entspricht die Formatierung genau, aber nicht exakt der Formatierung des Dokuments. Diese Methode gibt nicht genau denselben HTML-Code für dasselbe Dokument auf verschiedenen Plattformen (Windows, Mac, Word im Web usw.) zurück. Wenn Sie exakte Genauigkeit oder plattformübergreifende Konsistenz benötigen, verwenden Paragraph.getOoxml() und konvertieren Sie den zurückgegebenen XML-Code in HTML.

getHtml(): OfficeExtension.ClientResult<string>;

Gibt zurück

Hinweise

API-Satz: WordApi 1.1

Beispiele

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

Ruft den nächsten Absatz ab. Gibt einen ItemNotFound Fehler aus, wenn der Absatz der letzte ist.

getNext(): Word.Paragraph;

Gibt zurück

Hinweise

API-Satz: WordApi 1.3

Ruft den nächsten Absatz ab. Wenn der Absatz der letzte ist, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getNextOrNullObject(): Word.Paragraph;

Gibt zurück

Hinweise

API-Satz: WordApi 1.3

Ruft die Office Open XML (OOXML)-Darstellung des Paragraph Objekts ab.

getOoxml(): OfficeExtension.ClientResult<string>;

Gibt zurück

Hinweise

API-Satz: WordApi 1.1

Beispiele

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

Ruft den vorherigen Absatz ab. Gibt einen ItemNotFound Fehler aus, wenn der Absatz der erste ist.

getPrevious(): Word.Paragraph;

Gibt zurück

Hinweise

API-Satz: WordApi 1.3

Ruft den vorherigen Absatz ab. Wenn der Absatz der erste ist, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getPreviousOrNullObject(): Word.Paragraph;

Gibt zurück

Hinweise

API-Satz: WordApi 1.3

Beispiele

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

Ruft den gesamten Absatz oder den Start- bzw. Endpunkt des Absatzes als Bereich ab.

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

Parameter

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

Ruft überprüften Text basierend auf ChangeTrackingVersion einer Auswahl ab.

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApi 1.4

Ruft überprüften Text basierend auf ChangeTrackingVersion einer Auswahl ab.

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApi 1.4

Gibt den Text des Absatzes zurück. Ausgenommen sind Gleichungen, Grafiken (z. B. Bilder, Videos, Zeichnungen) und Sonderzeichen, die verschiedene Inhalte markieren (z. B. für Inhaltssteuerelemente, Felder, Kommentare, Fußnoten, Endnoten). Standardmäßig werden ausgeblendeter und als gelöscht markierter Text ausgeschlossen.

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApi 1.7

Ruft die Textbereiche im Absatz mithilfe von Satzzeichen und anderen Endzeichen ab.

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApi 1.3

Ruft die Auflistung der TrackedChange Objekte im Absatz ab.

getTrackedChanges(): Word.TrackedChangeCollection;

Gibt zurück

Hinweise

API-Satz: WordApi 1.6

Rückt den Absatz um eine Ebene ein.

indent(): void;

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Einrücken des Absatzes um eine angegebene Anzahl von Zeichen.

indentCharacterWidth(count: number): void;

Parameter

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Einrückt die erste Zeile des Absatzes um die angegebene Anzahl von Zeichen.

indentFirstLineCharacterWidth(count: number): void;

Parameter

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Fügt Anmerkungen zu diesem Paragraph Objekt ein.

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

Parameter

Gibt zurück

Ein Array der eingefügten Anmerkungsbezeichner.

Hinweise

API-Satz: WordApi 1.7

Wichtig: Diese API erfordert ein Microsoft 365-Abonnement, um aufgrund der Anforderung eines zugrunde liegenden Dienstes ordnungsgemäß zu funktionieren. Weitere Informationen hierzu finden Sie im GitHub-Problem 4953.

Beispiele

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

Fügt an der angegebenen Position im Hauptdokument einen Umbruch ein.

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApi 1.1

Beispiele

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

Fügt einen unverankerten Zeichenbereich vor dem Text mit seinem Anker am Anfang des Absatzes ein.

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.2

Umschließt das Paragraph Objekt mit einem Inhaltssteuerelement.

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;

Parameter

Gibt zurück

Hinweise

API-Satz: WordApi 1.1

Hinweis: Der contentControlType Parameter wurde in WordApi 1.5 eingeführt. plainText Unterstützung wurde in WordApi 1.5 hinzugefügt. checkBox Unterstützung wurde in WordApi 1.7 hinzugefügt. dropDownList und comboBox Unterstützung wurde in WordApi 1.9 hinzugefügt. Unterstützung für buildingBlockGallery, datePicker, grouppicture, und repeatingSection wurde in WordApiDesktop 1.3 hinzugefügt.

Beispiele

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

Fügt ein Dokument an der angegebenen Stelle in den Absatz ein.

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApi 1.1

Das Einfügen wird nicht unterstützt, wenn das einzufügende Dokument ein ActiveX-Steuerelement enthält (wahrscheinlich in einem Formularfeld). Erwägen Sie, ein solches Formularfeld durch ein Inhaltssteuerelement oder eine andere Option zu ersetzen, die für Ihr Szenario geeignet ist.

Fügt eine geometrische Form vor dem Text mit dem Anker am Anfang des Absatzes ein.

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.2

Beispiele

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

Fügt eine geometrische Form vor dem Text mit dem Anker am Anfang des Absatzes ein.

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;

Parameter

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.2

Fügt in den aktuellen Abschnitt an der angegebenen Position HTML-Code ein.

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApi 1.1

Beispiele

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

Fügt in den aktuellen Abschnitt an der angegebenen Position ein Bild ein.

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApi 1.1

Beispiele

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

Fügt OOXML an der angegebenen Stelle in den Absatz ein.

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApi 1.1

Fügt an der angegebenen Position einen Absatz ein.

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApi 1.1

Fügt ein unverankertes Bild vor dem Text mit seinem Anker am Anfang des Absatzes ein.

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.2

Fügt eine Tabelle mit der angegebenen Anzahl von Zeilen und Spalten ein.

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApi 1.3

Fügt in den Abschnitt an der angegebenen Position Text ein.

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApi 1.1

Beispiele

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

Fügt ein unverankertes Textfeld vor dem Text mit seinem Anker am Anfang des Absatzes ein.

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.2

Beispiele

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

Verknüpft einen Listenabsatz mit der nächstgelegenen Liste oberhalb oder unterhalb dieses Absatzes.

joinList(): void;

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

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(propertyNames?: string | string[]): Word.Paragraph;

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?: {
            select?: string;
            expand?: string;
        }): Word.Paragraph;

Parameter

Gibt zurück

Gibt ein Paragraph Objekt zurück, das den nächsten Absatz darstellt.

next(count: number): Word.Paragraph;

Parameter

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Schaltet den Abstand vor dem Absatz um.

openOrCloseUp(): void;

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Legt den Abstand vor dem Absatz auf 12 Punkte fest.

openUp(): void;

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Entfernt eine Einzugsebene für den Absatz.

outdent(): void;

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Wendet die Formatvorlage der nächsten Überschriftenebene (Überschrift 1 bis Überschrift 8) auf den Absatz an.

outlineDemote(): void;

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Stuft den Absatz 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 den Absatz an.

outlinePromote(): void;

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Gibt den vorherigen Absatz als Paragraph Objekt zurück.

previous(count: number): Word.Paragraph;

Parameter

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Entfernt manuell vorgenommene Absatzformatierungen (Formatierungen, die nicht mithilfe einer Formatvorlage vorgenommen wurden).

reset(): void;

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Setzt den Absatz, der benutzerdefinierte Listenebenen verwendet, auf die ursprünglichen Ebeneneinstellungen zurück.

resetAdvanceTo(): void;

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Führt eine Suche mit den angegebenen Suchoptionen für den Bereich des Objekts Paragraph aus. Die Suchergebnisse sind eine Sammlung von Range Objekten.

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApi 1.1

Wählt und navigiert die Word-Benutzeroberfläche zu diesem Absatz.

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApi 1.1

Beispiele

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

Wählt und navigiert die Word-Benutzeroberfläche zu diesem Absatz.

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApi 1.1

Markiert die Nummer oder den Aufzählungspunkt in einer Liste.

selectNumber(): void;

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Teilt eine Liste in zwei separate Listen. Bei nummerierten Listen beginnt in der neuen Liste die Nummerierung wieder mit der ersten Zahl, in der Regel ist dies 1.

separateList(): void;

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

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

Parameter

Gibt zurück

Beispiele

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

Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Word.Paragraph): void;

Parameter

Gibt zurück

Legt den Absatz auf einfachen Abstand fest.

space1(): void;

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Legt den Absatz auf einen Abstand von 1,5 Zeilen fest.

space1Pt5(): void;

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Legt den Absatz auf doppelten Abstand fest.

space2(): void;

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Teilt den Absatz mithilfe von Trennzeichen in untergeordnete Bereiche.

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

Parameter

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

Beginnt eine neue Liste mit diesem Absatz. Führt zu einem Fehler, wenn der Absatz bereits ein Listenelement ist.

startNewList(): Word.List;

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

Legt einen hängenden Einzug auf eine 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 den Absatz auf eine bestimmte 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.Paragraph Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Word.Interfaces.ParagraphData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

toJSON(): Word.Interfaces.ParagraphData;

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

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

Gibt zurück

Tritt auf, wenn neue Kommentare hinzugefügt werden.

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

Ereignistyp

Hinweise

API-Satz: WordApi BETA (NUR VORSCHAU)

Tritt auf, wenn ein Kommentar oder dessen Antwort geändert wird.

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

Ereignistyp

Hinweise

API-Satz: WordApi BETA (NUR VORSCHAU)

Tritt auf, wenn Kommentare gelöscht werden.

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

Ereignistyp

Hinweise

API-Satz: WordApi BETA (NUR VORSCHAU)

Tritt auf, wenn die Auswahl eines Kommentars aufgehoben wird.

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

Ereignistyp

Hinweise

API-Satz: WordApi BETA (NUR VORSCHAU)

Tritt auf, wenn ein Kommentar ausgewählt ist.

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

Ereignistyp

Hinweise

API-Satz: WordApi BETA (NUR VORSCHAU)