Word. Range class

context

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

context: RequestContext;

Eigenschaftswert

Word.RequestContext

endnotes

Ruft die Auflistung der Endnoten im Bereich ab.

readonly endnotes: Word.NoteItemCollection;

Eigenschaftswert

Word.NoteItemCollection

Hinweise

fields

Ruft die Auflistung von Feldobjekten im Bereich ab.

readonly fields: Word.FieldCollection;

Eigenschaftswert

Word.FieldCollection

Hinweise

font

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

readonly font: Word.Font;

Eigenschaftswert

Word.Font

Hinweise

footnotes

Ruft die Auflistung der Fußnoten im Bereich ab.

readonly footnotes: Word.NoteItemCollection;

Eigenschaftswert

Word.NoteItemCollection

Hinweise

Beispiele

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

// Gets the footnotes in the selected document range.
await Word.run(async (context) => {
  const footnotes: Word.NoteItemCollection = context.document.getSelection().footnotes;
  footnotes.load("length");
  await context.sync();

  console.log("Number of footnotes in the selected range: " + footnotes.items.length);
});

hyperlink

Ruft den ersten Link in dem Bereich ab oder legt einen Link für den Bereich fest. Wenn Sie einen neuen Link für den Bereich festlegen, werden alle Links im Bereich gelöscht. Verwenden Sie "#", um den Adressteil vom optionalen Standortteil zu trennen.

hyperlink: string;

Eigenschaftswert

string

Hinweise

inlinePictures

Ruft die Sammlung von Inlinebildobjekten im Bereich ab.

readonly inlinePictures: Word.InlinePictureCollection;

Eigenschaftswert

Word.InlinePictureCollection

Hinweise

[ API-Satz: WordApi 1.2 ]

isEmpty

Überprüft, ob die Länge des Bereichs 0 ist.

readonly isEmpty: boolean;

Eigenschaftswert

boolean

Hinweise

lists

Ruft die Sammlung von Listenobjekten im Bereich ab.

readonly lists: Word.ListCollection;

Eigenschaftswert

Word.ListCollection

Hinweise

paragraphs

Ruft die Auflistung von Absatzobjekten im Bereich ab.

readonly paragraphs: Word.ParagraphCollection;

Eigenschaftswert

Word.ParagraphCollection

Hinweise

Wichtig: Für die Anforderungssätze 1.1 und 1.2 werden Absätze in Tabellen, die vollständig in diesem Bereich enthalten sind, nicht zurückgegeben. Ab Anforderungssatz 1.3 werden auch Absätze in solchen Tabellen zurückgegeben.

parentBody

Ruft den übergeordneten Text des Bereichs ab.

readonly parentBody: Word.Body;

Eigenschaftswert

Word.Body

Hinweise

parentContentControl

Ruft das derzeit unterstützte Inhaltssteuerelement ab, das den Bereich enthält. Löst einen Fehler aus ItemNotFound , wenn kein übergeordnetes Inhaltssteuerelement vorhanden ist.

readonly parentContentControl: Word.ContentControl;

Eigenschaftswert

Word.ContentControl

Hinweise

Beispiele

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

// Toggles the isChecked property of the first checkbox content control found in the selection.
await Word.run(async (context) => {
  const selectedRange: Word.Range = context.document.getSelection();
  let selectedContentControl = selectedRange
    .getContentControls({
      types: [Word.ContentControlType.checkBox]
    })
    .getFirstOrNullObject();
  selectedContentControl.load("id,checkboxContentControl/isChecked");

  await context.sync();

  if (selectedContentControl.isNullObject) {
    const parentContentControl: Word.ContentControl = selectedRange.parentContentControl;
    parentContentControl.load("id,type,checkboxContentControl/isChecked");
    await context.sync();

    if (parentContentControl.isNullObject || parentContentControl.type !== Word.ContentControlType.checkBox) {
      console.warn("No checkbox content control is currently selected.");
      return;
    } else {
      selectedContentControl = parentContentControl;
    }
  }

  const isCheckedBefore = selectedContentControl.checkboxContentControl.isChecked;
  console.log("isChecked state before:", `id: ${selectedContentControl.id} ... isChecked: ${isCheckedBefore}`);
  selectedContentControl.checkboxContentControl.isChecked = !isCheckedBefore;
  selectedContentControl.load("id,checkboxContentControl/isChecked");
  await context.sync();

  console.log(
    "isChecked state after:",
    `id: ${selectedContentControl.id} ... isChecked: ${selectedContentControl.checkboxContentControl.isChecked}`
  );
});

parentContentControlOrNullObject

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

readonly parentContentControlOrNullObject: Word.ContentControl;

Eigenschaftswert

Word.ContentControl

Hinweise

parentTable

Ruft die Tabelle ab, die den Bereich enthält. Löst einen Fehler aus ItemNotFound , wenn er nicht in einer Tabelle enthalten ist.

readonly parentTable: Word.Table;

Eigenschaftswert

Word.Table

Hinweise

parentTableCell

Ruft die Tabellenzelle ab, die den Bereich enthält. Löst einen Fehler aus ItemNotFound , wenn er nicht in einer Tabellenzelle enthalten ist.

readonly parentTableCell: Word.TableCell;

Eigenschaftswert

Word.TableCell

Hinweise

parentTableCellOrNullObject

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

readonly parentTableCellOrNullObject: Word.TableCell;

Eigenschaftswert

Word.TableCell

Hinweise

parentTableOrNullObject

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

readonly parentTableOrNullObject: Word.Table;

Eigenschaftswert

Word.Table

Hinweise

style

Gibt den Formatvorlagennamen für den Bereich 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

string

Hinweise

styleBuiltIn

Gibt den integrierten Formatvorlagennamen für den Bereich 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

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 header: Word.Range = context.document.body.insertText("This is a sample Heading 1 Title!!\n",
        "Start" /*this means at the beginning of the body */);
    header.styleBuiltIn = Word.BuiltInStyleName.heading1;

    await context.sync();
});

tables

Ruft die Sammlung von Tabellenobjekten im Bereich ab.

readonly tables: Word.TableCollection;

Eigenschaftswert

Word.TableCollection

Hinweise

text

Ruft den Text des Bereichs ab.

readonly text: string;

Eigenschaftswert

string

Hinweise

Details zur Methode

clear()

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

clear(): void;

Gibt zurück

void

Hinweise

OfficeExtension.ClientResult<Word.LocationRelation>

Beispiele

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

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to clear the contents of the proxy range object.
    range.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 selection (range object)');
});

compareLocationWith(range)

Vergleicht die Position dieses Bereichs mit der eines anderen Bereichs.

compareLocationWith(range: Word.Range): OfficeExtension.ClientResult<Word.LocationRelation>;

Parameter

range: Word.Range

Erforderlich. Der Bereich, der mit diesem Bereich verglichen werden soll.

Gibt zurück

Hinweise

Beispiele

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

// Compares the location of one paragraph in relation to another paragraph.
await Word.run(async (context) => {
  const paragraphs: Word.ParagraphCollection = context.document.body.paragraphs;
  paragraphs.load("items");

  await context.sync();

  const firstParagraphAsRange: Word.Range = paragraphs.items[0].getRange();
  const secondParagraphAsRange: Word.Range = paragraphs.items[1].getRange();

  const comparedLocation = firstParagraphAsRange.compareLocationWith(secondParagraphAsRange);

  await context.sync();

  const locationValue: Word.LocationRelation = comparedLocation.value;
  console.log(`Location of the first paragraph in relation to the second paragraph: ${locationValue}`);
});

delete()

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

delete(): void;

Gibt zurück

void

Hinweise

Beispiele

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

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to delete the range object.
    range.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 selection (range object)');
});

expandTo(range)

Gibt einen neuen Bereich zurück, der diesen Bereich in beide Richtungen erweitert, um einen anderen Bereich zu überdecken. Dieser Bereich wird nicht geändert. Löst einen Fehler aus ItemNotFound , wenn die beiden Bereiche keine Union aufweisen.

expandTo(range: Word.Range): Word.Range;

Parameter

range: Word.Range

Erforderlich. Ein weiterer Bereich.

Gibt zurück

Word.Range

Hinweise

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

expandToOrNullObject(range)

Gibt einen neuen Bereich zurück, der diesen Bereich in beide Richtungen erweitert, um einen anderen Bereich zu überdecken. Dieser Bereich wird nicht geändert. Wenn die beiden Bereiche keine Union aufweisen, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

expandToOrNullObject(range: Word.Range): Word.Range;

Parameter

range: Word.Range

Erforderlich. Ein weiterer Bereich.

Gibt zurück

Word.Range

Hinweise

getBookmarks(includeHidden, includeAdjacent)

Ruft die Namen aller Lesezeichen im Bereich ab oder überlappen den Bereich. Ein Lesezeichen wird ausgeblendet, wenn sein Name mit dem Unterstrich beginnt.

getBookmarks(includeHidden?: boolean, includeAdjacent?: boolean): OfficeExtension.ClientResult<string[]>;

Parameter

includeHidden: boolean

Optional. Gibt an, ob ausgeblendete Lesezeichen eingeschlossen werden sollen. Der Standardwert ist false, was angibt, dass die ausgeblendeten Lesezeichen ausgeschlossen sind.

includeAdjacent: boolean

Optional. Gibt an, ob Lesezeichen eingeschlossen werden sollen, die an den Bereich angrenzen. Der Standardwert ist false, was angibt, dass die angrenzenden Lesezeichen ausgeschlossen sind.

Gibt zurück

OfficeExtension.ClientResult<string[]>

Hinweise

getComments()

Ruft dem Bereich zugeordnete Kommentare ab.

getComments(): Word.CommentCollection;

Gibt zurück

Word.CommentCollection

Hinweise

Beispiele

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

// Gets the comments in the selected content.
await Word.run(async (context) => {
  const comments: Word.CommentCollection = context.document.getSelection().getComments();

  // Load objects to log in the console.
  comments.load();
  await context.sync();

  console.log("Comments:", comments);
});

getContentControls(options)

Ruft die derzeit unterstützten Inhaltssteuerelemente im Bereich ab.

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

Parameter

options: Word.ContentControlOptions

Optional. Optionen, die definieren, welche Inhaltssteuerelemente zurückgegeben werden.

Gibt zurück

Word.ContentControlCollection

Hinweise

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

Beispiele

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

// Deletes the first checkbox content control found in the selection.
await Word.run(async (context) => {
  const selectedRange: Word.Range = context.document.getSelection();
  let selectedContentControl = selectedRange
    .getContentControls({
      types: [Word.ContentControlType.checkBox]
    })
    .getFirstOrNullObject();
  selectedContentControl.load("id");

  await context.sync();

  if (selectedContentControl.isNullObject) {
    const parentContentControl: Word.ContentControl = selectedRange.parentContentControl;
    parentContentControl.load("id,type");
    await context.sync();

    if (parentContentControl.isNullObject || parentContentControl.type !== Word.ContentControlType.checkBox) {
      console.warn("No checkbox content control is currently selected.");
      return;
    } else {
      selectedContentControl = parentContentControl;
    }
  }

  console.log(`About to delete checkbox content control with id: ${selectedContentControl.id}`);
  selectedContentControl.delete(false);
  await context.sync();

  console.log("Deleted checkbox content control.");
});

getHtml()

Ruft eine HTML-Darstellung des Bereichsobjekts ab. Wenn sie in einer Webseite oder einem HTML-Viewer gerendert wird, ist die Formatierung eine enge, aber nicht exakte Übereinstimmung mit 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 genaue Genauigkeit oder plattformübergreifende Konsistenz benötigen, verwenden Range.getOoxml() Und konvertieren Sie den zurückgegebenen XML-Code in HTML.

getHtml(): OfficeExtension.ClientResult<string>;

Gibt zurück

Hinweise

Beispiele

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

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to get the HTML of the current selection.
    const html = range.getHtml();

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

getHyperlinkRanges()

Ruft untergeordnete Linkbereiche innerhalb des Bereichs ab.

getHyperlinkRanges(): Word.RangeCollection;

Gibt zurück

Word.RangeCollection

Hinweise

Beispiele

await Word.run(async (context) => {
    // Get the entire document body.
    const bodyRange = context.document.body.getRange(Word.RangeLocation.whole);

    // Get all the ranges that only consist of hyperlinks.
    const hyperLinks = bodyRange.getHyperlinkRanges();
    hyperLinks.load("hyperlink");
    await context.sync();

    // Log each hyperlink.
    hyperLinks.items.forEach((linkRange) => {
        console.log(linkRange.hyperlink);
    });
});

getNextTextRange(endingMarks, trimSpacing)

Ruft den nächsten Textbereich mithilfe von Satzzeichen und/oder anderen Endzeichen ab. Löst einen Fehler aus ItemNotFound , wenn dieser Textbereich der letzte ist.

getNextTextRange(endingMarks: string[], trimSpacing?: boolean): Word.Range;

Parameter

endingMarks: string[]

Erforderlich. Die Interpunktionszeichen und/oder andere Endzeichen als Array von Zeichenfolgen.

trimSpacing: boolean

Optional. Gibt an, ob Abstandszeichen (Leerzeichen, Registerkarten, Spaltenumbrüche und Absatzendmarken) vom Anfang und Ende des zurückgegebenen Bereichs entfernt werden sollen. Der Standardwert ist false, was angibt, dass Die Zeichen am Anfang und Ende des Bereichs enthalten sind.

Gibt zurück

Word.Range

Hinweise

getNextTextRangeOrNullObject(endingMarks, trimSpacing)

Ruft den nächsten Textbereich mithilfe von Satzzeichen und/oder anderen Endzeichen ab. Wenn dieser Textbereich der letzte ist, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getNextTextRangeOrNullObject(endingMarks: string[], trimSpacing?: boolean): Word.Range;

Parameter

endingMarks: string[]

Erforderlich. Die Interpunktionszeichen und/oder andere Endzeichen als Array von Zeichenfolgen.

trimSpacing: boolean

Gibt zurück

Word.Range

Hinweise

getOoxml()

Ruft die OOXML-Darstellung des Bereichsobjekts ab.

getOoxml(): OfficeExtension.ClientResult<string>;

Gibt zurück

Hinweise

Beispiele

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

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to get the OOXML of the current selection.
    const ooxml = range.getOoxml();

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

getRange(rangeLocation)

Klont den Bereich oder ruft den Anfangs- bzw. Endpunkt des Bereichs als neuen 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

rangeLocation: whole | start | end | after | content | "Whole" | "Start" | "End" | "After" | "Content"

Optional. Der Bereichsspeicherort muss "Whole", "Start", "End", "After" oder "Content" sein.

Gibt zurück

Word.Range

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/insert-and-change-dropdown-list-content-control.yaml

// Places a dropdown list content control at the end of the selection.
await Word.run(async (context) => {
  let selection = context.document.getSelection();
  selection.getRange(Word.RangeLocation.end).insertContentControl(Word.ContentControlType.dropDownList);
  await context.sync();

  console.log("Dropdown list content control inserted at the end of the selection.");
});

getReviewedText(changeTrackingVersion)

Ruft überprüften Text basierend auf der ChangeTrackingVersion-Auswahl ab.

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

Parameter

changeTrackingVersion: Word.ChangeTrackingVersion

Optional. Der Wert muss "Original" oder "Current" sein. Der Standardwert ist "Aktuell".

Gibt zurück

Hinweise

Beispiele

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

// Gets the reviewed text.
await Word.run(async (context) => {
  const range: Word.Range = context.document.getSelection();
  const before = range.getReviewedText(Word.ChangeTrackingVersion.original);
  const after = range.getReviewedText(Word.ChangeTrackingVersion.current);

  await context.sync();

  console.log("Reviewed text (before):", before.value, "Reviewed text (after):", after.value);
});

getReviewedText(changeTrackingVersionString)

Ruft überprüften Text basierend auf der ChangeTrackingVersion-Auswahl ab.

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

Parameter

changeTrackingVersionString: "Original" | "Current"

Optional. Der Wert muss "Original" oder "Current" sein. Der Standardwert ist "Aktuell".

Gibt zurück

Hinweise

getTextRanges(endingMarks, trimSpacing)

Ruft die untergeordneten Textbereiche im Bereich mithilfe von Interpunktionszeichen und/oder anderen Endzeichen ab.

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

Parameter

endingMarks: string[]

Erforderlich. Die Interpunktionszeichen und/oder andere Endzeichen als Array von Zeichenfolgen.

trimSpacing: boolean

Optional. Gibt an, ob Abstandszeichen (Leerzeichen, Registerkarten, Spaltenumbrüche und Absatzendmarken) vom Anfang und Ende der in der Bereichsauflistung zurückgegebenen Bereiche entfernt werden sollen. Der Standardwert ist false, was angibt, dass die Zeilenabstandszeichen am Anfang und Ende der Bereiche in der Bereichsauflistung enthalten sind.

Gibt zurück

Word.RangeCollection

Hinweise

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

getTrackedChanges()

Ruft die Auflistung der TrackedChange-Objekte im Bereich ab.

getTrackedChanges(): Word.TrackedChangeCollection;

Gibt zurück

Word.TrackedChangeCollection

Hinweise

[ API-Satz: WordApi 1.6 ]

highlight()

Hebt den Bereich vorübergehend hervor, ohne den Dokumentinhalt zu ändern. Um den Text dauerhaft hervorzuheben, legen Sie font.HighlightColor des Bereichs fest.

highlight(): void;

Gibt zurück

void

Hinweise

[ API-Satz: WordApi 1.8 ]

insertBookmark(name)

Fügt ein Lesezeichen in den Bereich ein. Wenn irgendwo ein Lesezeichen mit demselben Namen vorhanden ist, wird es zuerst gelöscht.

insertBookmark(name: string): void;

Parameter

name: string

Erforderlich. Der Name des Lesezeichens, bei dem die Groß-/Kleinschreibung nicht beachtet wird. Es werden nur alphanumerische Zeichen und Unterstriche unterstützt. Sie muss mit einem Buchstaben beginnen, aber wenn Sie das Lesezeichen als ausgeblendet markieren möchten, beginnen Sie den Namen mit einem Unterstrich. Namen dürfen nicht länger als 40 Zeichen sein.

Gibt zurück

void

Hinweise

Hinweis: Die Bedingungen für das Einfügen eines Lesezeichens ähneln denen in der Word Ui. Weitere Informationen zum Verwalten von Lesezeichen in der Word-Benutzeroberfläche finden Sie unter Hinzufügen oder Löschen von Lesezeichen in einem Word Dokument oder einer Outlook-Nachricht.

insertBreak(breakType, insertLocation)

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

breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line"

Erforderlich. Der hinzuzufügende Umbruchtyp.

insertLocation: before | after | "Before" | "After"

Erforderlich. Der Wert muss "Before" oder "After" sein.

Gibt zurück

void

Hinweise

Beispiele

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

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert a page break after the selected text.
    range.insertBreak(Word.BreakType.page, Word.InsertLocation.after);

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Inserted a page break after the selected text.');
});

insertComment(commentText)

Fügen Sie einen Kommentar für den Bereich ein.

insertComment(commentText: string): Word.Comment;

Parameter

commentText: string

Erforderlich. Der einzufügende Kommentartext.

Gibt zurück

Word.Comment

comment-Objekt

Hinweise

Beispiele

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

// Sets a comment on the selected content.
await Word.run(async (context) => {
  const text = $("#comment-text")
    .val()
    .toString();
  const comment: Word.Comment = context.document.getSelection().insertComment(text);

  // Load object to log in the console.
  comment.load();
  await context.sync();

  console.log("Comment inserted:", comment);
});

insertContentControl(contentControlType)

Umschließt das Range-Objekt mit einem Inhaltssteuerelement.

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

Parameter

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

Optional. Inhaltssteuerelementtyp, der eingefügt werden soll. Muss "RichText", "PlainText" oder "CheckBox" sein. Der Standardwert ist "RichText".

Gibt zurück

Word.ContentControl

Hinweise

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.

Beispiele

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

// Simulates creation of a template. First searches the document for instances of the string "Contractor",
// then changes the format  of each search result,
// then wraps each search result within a content control,
// finally sets a tag and title property on each content control.
await Word.run(async (context) => {
    const results: Word.RangeCollection = context.document.body.search("Contractor");
    results.load("font/bold");

    // Check to make sure these content controls haven't been added yet.
    const customerContentControls: Word.ContentControlCollection = context.document.contentControls.getByTag("customer");
    customerContentControls.load("text");
    await context.sync();

  if (customerContentControls.items.length === 0) {
    for (let i = 0; i < results.items.length; i++) { 
        results.items[i].font.bold = true;
        let cc: Word.ContentControl = results.items[i].insertContentControl();
        cc.tag = "customer";  // This value is used in the next step of this sample.
        cc.title = "Customer Name " + i;
    }
  }
    await context.sync();
});

insertEndnote(insertText)

Fügt eine Endnote ein. Der Endnotenverweis wird hinter dem Bereich platziert.

insertEndnote(insertText?: string): Word.NoteItem;

Parameter

insertText: string

Optional. Text, der in den Endnotentext eingefügt werden soll. Der Standardwert ist "".

Gibt zurück

Word.NoteItem

Hinweise

insertField(insertLocation, fieldType, text, removeFormatting)

Fügt ein Feld an der angegebenen Position ein.

insertField(insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After", fieldType?: Word.FieldType, text?: string, removeFormatting?: boolean): Word.Field;

Parameter

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

Erforderlich. Die Position relativ zu dem Bereich, in den das Feld eingefügt wird. Der Wert muss "Replace", "Start", "End", "Before" oder "After" sein.

fieldType: Word.FieldType

Optional. Kann eine beliebige FieldType-Konstante sein. Der Standardwert ist Empty.

text: string

Optional. Zusätzliche Eigenschaften oder Optionen, falls erforderlich, für den angegebenen Feldtyp.

removeFormatting: boolean

Optional. true , um die Formatierung zu entfernen, die bei Updates auf das Feld angewendet wird, false andernfalls. Der Standardwert ist false.

Gibt zurück

Word.Field

Hinweise

Wichtig:

In Word unter Windows und auf Mac unterstützt die API das Einfügen und Verwalten aller in Word aufgeführten Typen. FieldType außer Word.FieldType.others.

In Word im Web unterstützt die API das Einfügen und Verwalten der folgenden Feldtypen.

Word.FieldType.addin
Word.FieldType.date
Word.FieldType.hyperlink
Word.FieldType.toc

Beispiele

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

// Inserts a Date field before selection.
await Word.run(async (context) => {
  const range: Word.Range = context.document.getSelection().getRange();

  const field: Word.Field = range.insertField(Word.InsertLocation.before, Word.FieldType.date, '\\@ "M/d/yyyy h:mm am/pm"', true);

  field.load("result,code");
  await context.sync();

  if (field.isNullObject) {
    console.log("There are no fields in this document.");
  } else {
    console.log("Code of the field: " + field.code, "Result of the field: " + JSON.stringify(field.result));
  }
});

insertField(insertLocation, fieldTypeString, text, removeFormatting)

Fügt ein Feld an der angegebenen Position ein.

insertField(insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After", fieldTypeString?: "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined", text?: string, removeFormatting?: boolean): Word.Field;

Parameter

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

Erforderlich. Die Position relativ zu dem Bereich, in den das Feld eingefügt wird. Der Wert muss "Replace", "Start", "End", "Before" oder "After" sein.

fieldTypeString: "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined"

Optional. Kann eine beliebige FieldType-Konstante sein. Der Standardwert ist Empty.

text: string

Optional. Zusätzliche Eigenschaften oder Optionen, falls erforderlich, für den angegebenen Feldtyp.

removeFormatting: boolean

Optional. true , um die Formatierung zu entfernen, die bei Updates auf das Feld angewendet wird, false andernfalls. Der Standardwert ist false.

Gibt zurück

Word.Field

Hinweise

Wichtig:

In Word unter Windows und auf Mac unterstützt die API das Einfügen und Verwalten aller in Word aufgeführten Typen. FieldType außer Word.FieldType.others.

In Word im Web unterstützt die API das Einfügen und Verwalten der folgenden Feldtypen.

Word.FieldType.addin
Word.FieldType.date
Word.FieldType.hyperlink
Word.FieldType.toc

insertFileFromBase64(base64File, insertLocation)

Fügt an der angegebenen Position ein Dokument ein.

insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;

Parameter

base64File: string

Erforderlich. Der Base64-codierte Inhalt einer .docx Datei.

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

Erforderlich. Der Wert muss "Replace", "Start", "End", "Before" oder "After" sein.

Gibt zurück

Word.Range

Hinweise

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

Beispiele

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

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert base64 encoded .docx at the beginning of the range.
    // You'll need to implement getBase64() to make this work.
    range.insertFileFromBase64(getBase64(), 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 base64 encoded text to the beginning of the range.');
});

insertFootnote(insertText)

Fügt eine Fußnote ein. Der Fußnotenverweis wird hinter dem Bereich platziert.

insertFootnote(insertText?: string): Word.NoteItem;

Parameter

insertText: string

Optional. Text, der in den Fußnotentext eingefügt werden soll. Der Standardwert ist "".

Gibt zurück

Word.NoteItem

Hinweise

Beispiele

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

// Sets a footnote on the selected content.
await Word.run(async (context) => {
  const text = $("#input-footnote")
    .val()
    .toString();
  const footnote: Word.NoteItem = context.document.getSelection().insertFootnote(text);
  await context.sync();

  console.log("Inserted footnote.");
});

insertHtml(html, insertLocation)

Fügt an der angegebenen Position HTML-Code ein.

insertHtml(html: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;

Parameter

html: string

Erforderlich. Der html-Code, der eingefügt werden soll.

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

Erforderlich. Der Wert muss "Replace", "Start", "End", "Before" oder "After" sein.

Gibt zurück

Word.Range

Hinweise

Beispiele

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

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert HTML in to the beginning of the range.
    range.insertHtml('<strong>This is text inserted with range.insertHtml()</strong>', 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('HTML added to the beginning of the range.');
});

insertInlinePictureFromBase64(base64EncodedImage, insertLocation)

Fügt an der angegebenen Position ein Bild ein.

insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.InlinePicture;

Parameter

base64EncodedImage: string

Erforderlich. Das einzufügende Base64-codierte Bild.

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

Erforderlich. Der Wert muss "Replace", "Start", "End", "Before" oder "After" sein.

Gibt zurück

Word.InlinePicture

Hinweise

[ API-Satz: WordApi 1.2 ]

insertOoxml(ooxml, insertLocation)

Fügt an der angegebenen Position OOXML-Code ein.

insertOoxml(ooxml: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;

Parameter

ooxml: string

Erforderlich. Der einzufügende OOXML-Code.

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

Erforderlich. Der Wert muss "Replace", "Start", "End", "Before" oder "After" sein.

Gibt zurück

Word.Range

Hinweise

Beispiele

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

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert OOXML in to the beginning of the range.
    range.insertOoxml("<pkg:package xmlns:pkg='http://schemas.microsoft.com/office/2006/xmlPackage'><pkg:part pkg:name='/_rels/.rels' pkg:contentType='application/vnd.openxmlformats-package.relationships+xml' pkg:padding='512'><pkg:xmlData><Relationships xmlns='http://schemas.openxmlformats.org/package/2006/relationships'><Relationship Id='rId1' Type='http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument' Target='word/document.xml'/></Relationships></pkg:xmlData></pkg:part><pkg:part pkg:name='/word/document.xml' pkg:contentType='application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml'><pkg:xmlData><w:document xmlns:w='http://schemas.openxmlformats.org/wordprocessingml/2006/main' ><w:body><w:p><w:pPr><w:spacing w:before='360' w:after='0' w:line='480' w:lineRule='auto'/><w:rPr><w:color w:val='70AD47' w:themeColor='accent6'/><w:sz w:val='28'/></w:rPr></w:pPr><w:r><w:rPr><w:color w:val='70AD47' w:themeColor='accent6'/><w:sz w:val='28'/></w:rPr><w:t>This text has formatting directly applied to achieve its font size, color, line spacing, and paragraph spacing.</w:t></w:r></w:p></w:body></w:document></pkg:xmlData></pkg:part></pkg:package>", 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('OOXML added to the beginning of the range.');
});

// Read "Create better add-ins for Word with Office Open XML" for guidance on working with OOXML.
// https://learn.microsoft.com/office/dev/add-ins/word/create-better-add-ins-for-word-with-office-open-xml

insertParagraph(paragraphText, insertLocation)

Fügt an der angegebenen Position einen Absatz ein.

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

Parameter

paragraphText: string

Erforderlich. Der einzufügende Absatztext.

insertLocation: before | after | "Before" | "After"

Erforderlich. Der Wert muss "Before" oder "After" sein.

Gibt zurück

Word.Paragraph

Hinweise

Beispiele

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

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert the paragraph after the range.
    range.insertParagraph('Content of a new paragraph', Word.InsertLocation.after);

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Paragraph added to the end of the range.');
});

insertTable(rowCount, columnCount, insertLocation, values)

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

rowCount: number

Erforderlich. Die Anzahl der Zeilen in der Tabelle.

columnCount: number

Erforderlich. Die Anzahl der Spalten in der Tabelle.

insertLocation: before | after | "Before" | "After"

Erforderlich. Der Wert muss "Before" oder "After" sein.

values: string[][]

Optionales 2D-Array. Wenn die entsprechenden Zeichenfolgen im Array angegeben sind, werden die Zellen gefüllt.

Gibt zurück

Word.Table

Hinweise

insertText(text, insertLocation)

Fügt an der angegebenen Position Text ein.

insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;

Parameter

text: string

Erforderlich. Der einzufügende Text.

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

Erforderlich. Der Wert muss "Replace", "Start", "End", "Before" oder "After" sein.

Gibt zurück

Word.Range

Hinweise

Beispiele

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

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert the paragraph at the end of the range.
    range.insertText('New text inserted into the range.', 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('Text added to the end of the range.');
});

intersectWith(range)

Gibt einen neuen Bereich als Schnittmenge dieses Bereichs mit einem anderen Bereich zurück. Dieser Bereich wird nicht geändert. Löst einen Fehler aus ItemNotFound , wenn die beiden Bereiche nicht überlappend oder nebeneinander liegen.

intersectWith(range: Word.Range): Word.Range;

Parameter

range: Word.Range

Erforderlich. Ein weiterer Bereich.

Gibt zurück

Word.Range

Hinweise

intersectWithOrNullObject(range)

Gibt einen neuen Bereich als Schnittmenge dieses Bereichs mit einem anderen Bereich zurück. Dieser Bereich wird nicht geändert. Wenn sich die beiden Bereiche nicht überlappen oder angrenzen, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

intersectWithOrNullObject(range: Word.Range): Word.Range;

Parameter

range: Word.Range

Erforderlich. Ein weiterer Bereich.

Gibt zurück

Word.Range

Hinweise

load(options)

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.RangeLoadOptions): Word.Range;

Parameter

options: Word.Interfaces.RangeLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

Word.Range

load(propertyNames)

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

Parameter

propertyNames: string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

Word.Range

load(propertyNamesAndPaths)

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

Parameter

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

Word.Range

removeHighlight()

Entfernt die hervorhebung, die von der Highlight-Funktion hinzugefügt wurde, falls vorhanden.

removeHighlight(): void;

Gibt zurück

void

Hinweise

[ API-Satz: WordApi 1.8 ]

search(searchText, searchOptions)

Führt eine Suche mit den angegebenen SearchOptions im Bereich des Bereichsobjekts aus. Die Suchergebnisse sind eine Sammlung von Bereichsobjekten.

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

Parameter

searchText: string

Erforderlich. Der Suchtext.

searchOptions: Word.SearchOptions | { ignorePunct?: boolean; ignoreSpace?: boolean; matchCase?: boolean; matchPrefix?: boolean; matchSuffix?: boolean; matchWholeWord?: boolean; matchWildcards?: boolean; }

Optional. Optionen für die Suche.

Gibt zurück

Word.RangeCollection

Hinweise

select(selectionMode)

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

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

Parameter

selectionMode: Word.SelectionMode

Optional. Der Auswahlmodus muss "Select", "Start" oder "End" sein. „Select“ ist die Standardeinstellung.

Gibt zurück

void

Hinweise

Beispiele

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

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert HTML in to the beginning of the range.
    range.insertHtml('<strong>This is text inserted with range.insertHtml()</strong>', Word.InsertLocation.start);

    // Queue a command to select the HTML that was inserted.
    range.select();

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

select(selectionModeString)

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

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

Parameter

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

Optional. Der Auswahlmodus muss "Select", "Start" oder "End" sein. „Select“ ist die Standardeinstellung.

Gibt zurück

void

Hinweise

set(properties, options)

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

Parameter

properties: Word.Interfaces.RangeUpdateData

Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.

options: OfficeExtension.UpdateOptions

Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.

Gibt zurück

void

set(properties)

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

set(properties: Word.Range): void;

Parameter

properties: Word.Range

Gibt zurück

void

split(delimiters, multiParagraphs, trimDelimiters, trimSpacing)

Teilt den Bereich mithilfe von Trennzeichen in untergeordnete Bereiche.

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

Parameter

delimiters: string[]

Erforderlich. Die Trennzeichen als Array von Zeichenfolgen.

multiParagraphs: boolean

Optional. Gibt an, ob ein zurückgegebener untergeordneter Bereich mehrere Absätze abdecken kann. Der Standardwert ist false, was angibt, dass die Absatzgrenzen auch als Trennzeichen verwendet werden.

trimDelimiters: boolean

Optional. Gibt an, ob Trennzeichen aus den Bereichen in der Bereichsauflistung abgegrenzt werden sollen. Der Standardwert ist false, was angibt, dass die Trennzeichen in den Bereichen enthalten sind, die in der Bereichsauflistung zurückgegeben werden.

trimSpacing: boolean

Gibt zurück

Word.RangeCollection

Hinweise