Word.Range class

Referenz

Paket:: word

Stellt einen zusammenhängenden Bereich in einem Dokument dar.

Extends: OfficeExtension.ClientObject

Hinweise

Beispiele

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

// Gets the range of the first comment in the selected content.
await Word.run(async (context) => {
  const comment: Word.Comment = context.document.getSelection().getComments().getFirstOrNullObject();
  comment.load("contentRange");
  const range: Word.Range = comment.getRange();
  range.load("text");
  await context.sync();

  if (comment.isNullObject) {
    console.warn("No comments in the selection, so no range to get.");
    return;
  }

  console.log(`Comment location: ${range.text}`);
  const contentRange: Word.CommentContentRange = comment.contentRange;
  console.log("Comment content range:", contentRange);
});

Eigenschaften

contentControls	Ruft die Auflistung von Inhaltssteuerelementobjekten im Bereich ab.
context	Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
font	Ruft das Textformat des Bereichs ab. Verwenden Sie diese Option zum Abrufen und Festlegen des Schriftartnamens, der Größe, Farbe und anderer Eigenschaften.
paragraphs	Ruft die Auflistung von Absatzobjekten im Bereich ab.
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.
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".
text	Ruft den Text des Bereichs ab.

Methoden

clear()	Löscht den Inhalt des Bereichsobjekts. Der Benutzer kann den Rückgängig-Vorgang auf den gelöschten Inhalt durchführen.
delete()	Löscht den Bereich und seinen Inhalt aus dem Dokument.
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.
getOoxml()	Ruft die OOXML-Darstellung des Bereichsobjekts ab.
insertBreak(breakType, insertLocation)	Fügt an der angegebenen Position im Hauptdokument einen Umbruch ein.
insertContentControl(contentControlType)	Umschließt das Range-Objekt mit einem Inhaltssteuerelement.
insertFileFromBase64(base64File, insertLocation)	Fügt an der angegebenen Position ein Dokument ein.
insertHtml(html, insertLocation)	Fügt an der angegebenen Position HTML-Code ein.
insertOoxml(ooxml, insertLocation)	Fügt an der angegebenen Position OOXML-Code ein.
insertParagraph(paragraphText, insertLocation)	Fügt an der angegebenen Position einen Absatz ein.
insertText(text, insertLocation)	Fügt an der angegebenen Position Text ein.
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(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(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.
search(searchText, searchOptions)	Führt eine Suche mit den angegebenen SearchOptions im Bereich des Bereichsobjekts aus. Die Suchergebnisse sind eine Sammlung von Bereichsobjekten.
select(selectionMode)	Wählt und navigiert die Word-Benutzeroberfläche zu diesem Bereich.
select(selectionModeString)	Wählt und navigiert die Word-Benutzeroberfläche zu diesem Bereich.
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)	Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
toJSON()	Überschreibt die JavaScript-Methode `toJSON()` , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an `JSON.stringify()`übergeben wird. (`JSON.stringify`ruft wiederum die `toJSON` -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche `Word.Range` Objekt ein API-Objekt ist, gibt die `toJSON` Methode ein einfaches JavaScript-Objekt (typisiert als `Word.Interfaces.RangeData`) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
track()	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 über `.sync` Aufrufe hinweg 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 den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Auflistung ist, sollten Sie auch die übergeordnete Auflistung nachverfolgen.
untrack()	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 aufrufen `context.sync()` , bevor die Speicherfreigabe wirksam wird.

Details zur Eigenschaft

contentControls

Ruft die Auflistung von Inhaltssteuerelementobjekten im Bereich ab.

readonly contentControls: Word.ContentControlCollection;

Eigenschaftswert

Word.ContentControlCollection

Hinweise

[ API-Satz: WordApi 1.1 ]

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

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

[ API-Satz: WordApi 1.1 ]

paragraphs

Ruft die Auflistung von Absatzobjekten im Bereich ab.

readonly paragraphs: Word.ParagraphCollection;

Eigenschaftswert

Word.ParagraphCollection

Hinweise

[ API-Satz: WordApi 1.1 ]

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.

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

[ API-Satz: WordApi 1.1 ]

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

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

[ API-Satz: WordApi 1.1 ]

text

Ruft den Text des Bereichs ab.

readonly text: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApi 1.1 ]

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

[ API-Satz: WordApi 1.1 ]

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

delete()

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

delete(): void;

Gibt zurück

void

Hinweise

[ API-Satz: WordApi 1.1 ]

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

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

OfficeExtension.ClientResult<string>

Hinweise

[ API-Satz: WordApi 1.1 ]

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

getOoxml()

Ruft die OOXML-Darstellung des Bereichsobjekts ab.

getOoxml(): OfficeExtension.ClientResult<string>;

Gibt zurück

OfficeExtension.ClientResult<string>

Hinweise

[ API-Satz: WordApi 1.1 ]

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

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

[ API-Satz: WordApi 1.1 ]

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

insertContentControl(contentControlType)

Umschließt das Range-Objekt mit einem Inhaltssteuerelement.

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

Parameter

contentControlType: richText | plainText | checkBox | dropDownList | comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox"

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

Gibt zurück

Word.ContentControl

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.

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

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

[ API-Satz: WordApi 1.1 ]

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

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

[ API-Satz: WordApi 1.1 ]

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

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

[ API-Satz: WordApi 1.1 ]

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

[ API-Satz: WordApi 1.1 ]

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

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

[ API-Satz: WordApi 1.1 ]

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

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

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

[ API-Satz: WordApi 1.1 ]

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

[ API-Satz: WordApi 1.1 ]

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

[ API-Satz: WordApi 1.1 ]

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

toJSON()

Ü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 das Objekt übergeben wird.) Während das ursprüngliche Word.Range Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.RangeData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Word.Interfaces.RangeData;

Gibt zurück

Word.Interfaces.RangeData

track()

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 über .sync Aufrufe hinweg 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 den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Auflistung ist, sollten Sie auch die übergeordnete Auflistung nachverfolgen.

track(): Word.Range;

Gibt zurück

Word.Range

untrack()

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 aufrufen context.sync() , bevor die Speicherfreigabe wirksam wird.

untrack(): Word.Range;

Gibt zurück

Word.Range

Freigeben über

Word.Range class

Hinweise

Beispiele

Eigenschaften

Methoden

Details zur Eigenschaft

contentControls

Eigenschaftswert

Hinweise

context

Eigenschaftswert

font

Eigenschaftswert

Hinweise

paragraphs

Eigenschaftswert

Hinweise

parentContentControl

Eigenschaftswert

Hinweise

Beispiele

style

Eigenschaftswert

Hinweise

text

Eigenschaftswert

Hinweise

Details zur Methode

clear()

Gibt zurück

Hinweise

Beispiele

delete()

Gibt zurück

Hinweise

Beispiele

getHtml()

Gibt zurück

Hinweise

Beispiele

getOoxml()

Gibt zurück

Hinweise

Beispiele

insertBreak(breakType, insertLocation)

Parameter

Gibt zurück

Hinweise

Beispiele

insertContentControl(contentControlType)

Parameter

Gibt zurück

Hinweise

Beispiele

insertFileFromBase64(base64File, insertLocation)

Parameter

Gibt zurück

Hinweise

Beispiele

insertHtml(html, insertLocation)

Parameter

Gibt zurück

Hinweise

Beispiele

insertOoxml(ooxml, insertLocation)

Parameter

Gibt zurück

Hinweise

Beispiele

insertParagraph(paragraphText, insertLocation)

Parameter

Gibt zurück

Hinweise

Beispiele

insertText(text, insertLocation)

Parameter

Gibt zurück

Hinweise

Beispiele