Word. Content Control class

Verwendet von

Beispiele

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

    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;

    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to load the properties on the first content control.
        contentControls.items[0].load(  'appearance,' +
                                        'cannotDelete,' +
                                        'cannotEdit,' +
                                        'color,' +
                                        'id,' +
                                        'placeHolderText,' +
                                        'removeWhenEdited,' +
                                        'title,' +
                                        'text,' +
                                        'type,' +
                                        'style,' +
                                        'tag,' +
                                        'font/size,' +
                                        'font/name,' +
                                        'font/color');

        // Synchronize the document state by executing the queued commands,
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Property values of the first content control:' +
            '   ----- appearance: ' + contentControls.items[0].appearance +
            '   ----- cannotDelete: ' + contentControls.items[0].cannotDelete +
            '   ----- cannotEdit: ' + contentControls.items[0].cannotEdit +
            '   ----- color: ' + contentControls.items[0].color +
            '   ----- id: ' + contentControls.items[0].id +
            '   ----- placeHolderText: ' + contentControls.items[0].placeholderText +
            '   ----- removeWhenEdited: ' + contentControls.items[0].removeWhenEdited +
            '   ----- title: ' + contentControls.items[0].title +
            '   ----- text: ' + contentControls.items[0].text +
            '   ----- type: ' + contentControls.items[0].type +
            '   ----- style: ' + contentControls.items[0].style +
            '   ----- tag: ' + contentControls.items[0].tag +
            '   ----- font size: ' + contentControls.items[0].font.size +
            '   ----- font name: ' + contentControls.items[0].font.name +
            '   ----- font color: ' + contentControls.items[0].font.color);
    }
});

Eigenschaften

appearance	Gibt die Darstellung des Inhaltssteuerelements an. Der Wert kann ,`tags` oder`hidden` sein`boundingBox`.
buildingBlockGalleryContentControl	Ruft die Daten zum Bausteinkatalog ab, wenn das Inhaltssteuerelement Word ist. ContentControlType ist `buildingBlockGallery`. Es ist `null` anders.
cannotDelete	Gibt an, ob der Benutzer das Inhaltssteuerelement löschen kann. Schließt sich gegenseitig mit `removeWhenEdited`aus.
cannotEdit	Gibt an, ob der Benutzer den Inhalt des Inhaltssteuerelements bearbeiten kann.
checkboxContentControl	Ruft die Daten des Inhaltssteuerelements ab, wenn sein Typ ist `checkBox`. Es ist `null` anders.
color	Gibt die Farbe des Inhaltssteuerelements an. Die Farbe wird im Format '#RRGGBB' oder mithilfe des Farbnamens angegeben.
comboBoxContentControl	Ruft die Daten des Inhaltssteuerelements ab, wenn sein Typ ist `comboBox`. Es ist `null` anders.
contentControls	Ruft die Auflistung der `ContentControl` Objekte im Inhaltssteuerelement ab.
context	Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
datePickerContentControl	Ruft die Daten zur Datumsauswahl ab, wenn es sich bei dem Inhaltssteuerelement um Word handelt. ContentControlType ist `datePicker`. Es ist `null` anders.
dropDownListContentControl	Ruft die Daten des Inhaltssteuerelements ab, wenn sein Typ ist `dropDownList`. Es ist `null` anders.
endnotes	Ruft die Sammlung der Endnoten im Inhaltssteuerelement ab.
fields	Ruft die Auflistung der `Field` Objekte im Inhaltssteuerelement ab.
font	Ruft das Textformat des Inhaltssteuerelements ab. Verwenden Sie diese zum Abrufen und Festlegen der Schriftart, Größe, Farbe und andere Eigenschaften.
footnotes	Ruft die Sammlung der Fußnoten im Inhaltssteuerelement ab.
groupContentControl	Ruft die gruppenbezogenen Daten ab, wenn das Inhaltssteuerelement Word ist. ContentControlType ist `group`. Es ist `null` anders.
id	Ruft eine Ganzzahl ab, die den Inhaltssteuerelement-Bezeichner darstellt.
inlinePictures	Ruft die Auflistung der `InlinePicture` Objekte im Inhaltssteuerelement ab. Die Sammlung enthält keine schwebenden Bilder.
lists	Ruft die Auflistung der `List` Objekte im Inhaltssteuerelement ab.
paragraphs	Ruft die Auflistung der `Paragraph` Objekte im Inhaltssteuerelement ab.
parentBody	Ruft den übergeordneten Text des Inhaltssteuerelements ab.
parentContentControl	Ruft das Inhaltssteuerelement ab, das das Inhaltssteuerelement enthält. Gibt einen `ItemNotFound` Fehler aus, wenn kein übergeordnetes Inhaltssteuerelement vorhanden ist.
parentContentControlOrNullObject	Ruft das Inhaltssteuerelement ab, das das Inhaltssteuerelement 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.
parentTable	Ruft die Tabelle ab, die das Inhaltssteuerelement enthält. Gibt einen `ItemNotFound` Fehler aus, wenn er nicht in einer Tabelle enthalten ist.
parentTableCell	Ruft die Tabellenzelle ab, die das Inhaltssteuerelement enthält. Gibt einen `ItemNotFound` Fehler aus, wenn er nicht in einer Tabellenzelle enthalten ist.
parentTableCellOrNullObject	Ruft die Tabellenzelle ab, die das Inhaltssteuerelement 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.
parentTableOrNullObject	Ruft die Tabelle ab, die das Inhaltssteuerelement 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.
pictureContentControl	Ruft die bildbezogenen Daten ab, wenn das Inhaltssteuerelement Word ist. ContentControlType ist `picture`. Es ist `null` anders.
placeholderText	Gibt den Platzhaltertext des Inhaltssteuerelements an. Abgeblendeter Text wird angezeigt, wenn das Inhaltssteuerelement leer ist.
removeWhenEdited	Gibt an, ob das Inhaltssteuerelement nach der Bearbeitung entfernt wird. Schließt sich gegenseitig mit `cannotDelete`aus.
repeatingSectionContentControl	Ruft die Daten zu wiederholten Abschnitten ab, wenn das Inhaltssteuerelement Word ist. ContentControlType ist `repeatingSection`. Es ist `null` anders.
style	Gibt den Formatvorlagennamen für das Inhaltssteuerelement an. Verwenden Sie diese Eigenschaft für benutzerdefinierte Formatvorlagen und lokalisierte Formatvorlagennamen. Informationen zur Verwendung der integrierten Formatvorlagen, die zwischen Gebietsschemas portierbar sind, finden Sie in der `styleBuiltIn` Eigenschaft.
styleBuiltIn	Gibt den vordefinierten Formatvorlagennamen für das Inhaltssteuerelement an. Verwenden Sie diese Eigenschaft für integrierte Formatvorlagen, die zwischen Gebietsschemas portabel sind. Informationen zum Verwenden von benutzerdefinierten Formatvorlagen oder lokalisierten Formatvorlagennamen finden Sie in der `style` Eigenschaft.
subtype	Ruft den Untertyp des Inhaltssteuerelements ab. Der Untertyp kann ", `richTextParagraphs`, `richTextTableCellrichTextTableRow`" sein und `richTextTable` für Rich-Text-Inhaltssteuerelemente `plainTextInline` sowie `plainTextParagraph` für Nur-Text-Inhaltssteuerelemente`richTextInline`, `checkBox` für Kontrollkästchen-Inhaltssteuerelemente, `dropDownList` für Dropdownlisten-Inhaltssteuerelemente, für Kombinationsfeld-Inhaltssteuerelemente, `buildingBlockGallerycomboBox` für Bausteinkatalog-Inhaltssteuerelemente, `datePicker` für Datumsauswahl-Inhaltssteuerelemente, `repeatingSection` für Inhaltssteuerelemente für wiederholte Abschnitte, `picture` für Bild-Inhaltssteuerelemente und `group` für Gruppeninhaltssteuerelemente.
tables	Ruft die Auflistung der `Table` Objekte im Inhaltssteuerelement ab.
tag	Gibt ein Tag zum Identifizieren eines Inhaltssteuerelements an.
text	Ruft den Text des Inhaltssteuerelements ab.
title	Gibt den Titel für ein Inhaltssteuerelement an.
type	Ruft den Typen des Inhaltssteuerelements ab. Derzeit werden nur Rich-Text-, Nur-Text-, Kontrollkästchen-, Dropdownlisten-, Kombinationsfeld-, Bausteinkatalog-, Datumsauswahl-, Wiederholte Abschnitt-, Bild- und Gruppeninhaltssteuerelemente unterstützt.
xmlMapping	Gibt ein `XmlMapping` Objekt zurück, das die Zuordnung des Inhaltssteuerelements zu XML-Daten im Datenspeicher des Dokuments darstellt.

Methoden

clear()	Löscht den Inhalt des Inhaltssteuerelements. Der Benutzer kann den Rückgängig-Vorgang auf den gelöschten Inhalt durchführen.
delete(keepContent)	Löscht das Inhaltssteuerelement und dessen Inhalt. Wenn `keepContent` diese Option auf `true`festgelegt ist, wird der Inhalt nicht gelöscht.
getComments()	Ruft Kommentare ab, die dem Inhaltssteuerelement zugeordnet sind.
getContentControls(options)	Ruft die derzeit unterstützten untergeordneten Inhaltssteuerelemente in diesem Inhaltssteuerelement ab.
getHtml()	Ruft eine HTML-Darstellung des `ContentControl` Objekts ab. Beim Rendern in einer Webseite oder einem HTML-Viewer entspricht die Formatierung der Formatierung des Dokuments nahe, aber nicht exakt. 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 `ContentControl.getOoxml()` und konvertieren Sie den zurückgegebenen XML-Code in HTML.
getOoxml()	Ruft die Office Open XML (OOXML)-Darstellung des `ContentControl` Objekts ab.
getRange(rangeLocation)	Ruft das gesamte Inhaltssteuerelement oder den Start- bzw. Endpunkt des Inhaltssteuerelements als Bereich ab.
getReviewedText(changeTrackingVersion)	Ruft den überprüften Text basierend auf der ChangeTrackingVersion-Auswahl ab.
getReviewedText(changeTrackingVersion)	Ruft den überprüften Text basierend auf der ChangeTrackingVersion-Auswahl ab.
getTextRanges(endingMarks, trimSpacing)	Ruft die Textbereiche im Inhaltssteuerelement mithilfe von Satzzeichen und anderen Endzeichen ab.
getTrackedChanges()	Ruft die Auflistung der `TrackedChange` Objekte im Inhaltssteuerelement ab.
insertBreak(breakType, insertLocation)	Fügt an der angegebenen Position im Hauptdokument einen Umbruch ein. Diese Methode kann nicht mit `richTextTablerichTextTableRow`, und `richTextTableCell` Inhaltssteuerelementen verwendet werden.
insertFileFromBase64(base64File, insertLocation)	Fügt ein Dokument an der angegebenen Position in das Inhaltssteuerelement ein.
insertHtml(html, insertLocation)	Fügt an der angegebenen Position HTML ein.
insertInlinePictureFromBase64(base64EncodedImage, insertLocation)	Fügt an der angegebenen Position ein eingebundenes Bild in das Inhaltssteuerelement ein.
insertOoxml(ooxml, insertLocation)	Fügt OOXML an der angegebenen Position in das Inhaltssteuerelement ein.
insertParagraph(paragraphText, insertLocation)	Fügt an der angegebenen Position einen Absatz ein.
insertTable(rowCount, columnCount, insertLocation, values)	Fügt eine Tabelle mit der angegebenen Anzahl von Zeilen und Spalten in oder neben ein Inhaltssteuerelement ein.
insertText(text, insertLocation)	Fügt an der angegebenen Position Text in das Inhaltssteuerelement 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.
resetState()	Setzt den Status des Inhaltssteuerelements zurück.
search(searchText, searchOptions)	Führt eine Suche mit den angegebenen Suchoptionen für den Bereich des Objekts `ContentControl` aus. Die Suchergebnisse sind eine Sammlung von `Range` Objekten.
select(selectionMode)	Wählt das Inhaltssteuerelement aus. Dies bewirkt, dass Word einen Bildlauf zur Auswahl durchführt.
select(selectionMode)	Wählt das Inhaltssteuerelement aus. Dies bewirkt, dass Word einen Bildlauf zur Auswahl durchführt.
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.
setState(contentControlState)	Legt den Status des Inhaltssteuerelements fest.
setState(contentControlState)	Legt den Status des Inhaltssteuerelements fest.
split(delimiters, multiParagraphs, trimDelimiters, trimSpacing)	Teilt das Inhaltssteuerelement mithilfe von Trennzeichen in untergeordnete Bereiche.
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 sie übergeben wird.) Während das ursprüngliche `Word.ContentControl` Objekt ein API-Objekt ist, gibt die `toJSON` Methode ein einfaches JavaScript-Objekt (als `Word.Interfaces.ContentControlData`) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts 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 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.
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 einen Aufruf durchführen `context.sync()` , bevor die Speicherfreigabe wirksam wird.

Ereignisse

onCommentAdded	Tritt auf, wenn neue Kommentare hinzugefügt werden.
onCommentChanged	Tritt auf, wenn ein Kommentar oder dessen Antwort geändert wird.
onCommentDeselected	Tritt auf, wenn die Auswahl eines Kommentars aufgehoben wird.
onCommentSelected	Tritt auf, wenn ein Kommentar ausgewählt ist.
onDataChanged	Tritt auf, wenn Daten innerhalb des Inhaltssteuerelements geändert werden. Um den neuen Text abzurufen, laden Sie dieses Inhaltssteuerelement in den Handler. Laden Sie den alten Text nicht, um ihn zu erhalten.
onDeleted	Tritt auf, wenn das Inhaltssteuerelement gelöscht wird. Laden Sie dieses Inhaltssteuerelement nicht in den Handler, da Sie sonst seine ursprünglichen Eigenschaften nicht abrufen können.
onEntered	Tritt auf, wenn das Inhaltssteuerelement eingegeben wird.
onExited	Tritt auf, wenn das Inhaltssteuerelement verlassen wird, z. B. wenn der Cursor das Inhaltssteuerelement verlässt.
onSelectionChanged	Tritt auf, wenn die Auswahl innerhalb des Inhaltssteuerelements geändert wird.

appearance

Gibt die Darstellung des Inhaltssteuerelements an. Der Wert kann ,tags oderhidden seinboundingBox.

appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden";

Eigenschaftswert

Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"

Hinweise

buildingBlockGalleryContentControl

Ruft die Daten zum Bausteinkatalog ab, wenn das Inhaltssteuerelement Word ist. ContentControlType ist buildingBlockGallery. Es ist null anders.

readonly buildingBlockGalleryContentControl: Word.BuildingBlockGalleryContentControl;

Eigenschaftswert

Word.BuildingBlockGalleryContentControl

Hinweise

cannotDelete

Gibt an, ob der Benutzer das Inhaltssteuerelement löschen kann. Schließt sich gegenseitig mit removeWhenEditedaus.

cannotDelete: boolean;

Eigenschaftswert

boolean

Hinweise

cannotEdit

Gibt an, ob der Benutzer den Inhalt des Inhaltssteuerelements bearbeiten kann.

cannotEdit: boolean;

Eigenschaftswert

boolean

Hinweise

checkboxContentControl

Ruft die Daten des Inhaltssteuerelements ab, wenn sein Typ ist checkBox. Es ist null anders.

readonly checkboxContentControl: Word.CheckboxContentControl;

Eigenschaftswert

Word.CheckboxContentControl

Hinweise

API-Satz: WordApi 1.7

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

color

Gibt die Farbe des Inhaltssteuerelements an. Die Farbe wird im Format '#RRGGBB' oder mithilfe des Farbnamens angegeben.

color: string;

Eigenschaftswert

string

Hinweise

comboBoxContentControl

Ruft die Daten des Inhaltssteuerelements ab, wenn sein Typ ist comboBox. Es ist null anders.

readonly comboBoxContentControl: Word.ComboBoxContentControl;

Eigenschaftswert

Word.ComboBoxContentControl

Hinweise

API-Satz: WordApi 1.9

Beispiele

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

// Adds the provided list item to the first combo box content control in the selection.
await Word.run(async (context) => {
  const listItemText = (document.getElementById("item-to-add") as HTMLInputElement).value.trim();
  const selectedRange: Word.Range = context.document.getSelection();
  let selectedContentControl = selectedRange
    .getContentControls({
      types: [Word.ContentControlType.comboBox]
    })
    .getFirstOrNullObject();
  selectedContentControl.load("id,comboBoxContentControl");
  await context.sync();

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

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

  selectedContentControl.comboBoxContentControl.addListItem(listItemText);
  await context.sync();

  console.log(`List item added to control with ID ${selectedContentControl.id}: ${listItemText}`);
});

contentControls

Ruft die Auflistung der ContentControl Objekte im Inhaltssteuerelement ab.

readonly contentControls: Word.ContentControlCollection;

Eigenschaftswert

Word.ContentControlCollection

Hinweise

context

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

context: RequestContext;

Eigenschaftswert

Word.RequestContext

datePickerContentControl

Ruft die Daten zur Datumsauswahl ab, wenn es sich bei dem Inhaltssteuerelement um Word handelt. ContentControlType ist datePicker. Es ist null anders.

readonly datePickerContentControl: Word.DatePickerContentControl;

Eigenschaftswert

Word.DatePickerContentControl

Hinweise

Beispiele

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

// Gets and logs the properties of the first date picker content control.
await Word.run(async (context) => {
  let contentControls = context.document.getContentControls({
    types: [Word.ContentControlType.datePicker]
  });
  contentControls.load("items");

  await context.sync();

  if (contentControls.items.length === 0) {
    console.warn("No date picker content controls found in the document.");
    return;
  }

  const firstControl = contentControls.items[0];
  firstControl.load("datePickerContentControl");

  await context.sync();

  const datePicker: Word.DatePickerContentControl = firstControl.datePickerContentControl;
  datePicker.load("dateCalendarType, dateDisplayFormat, dateDisplayLocale, dateStorageFormat");

  await context.sync();

  console.log("Date picker content control properties:");
  console.log("  Calendar type: " + datePicker.dateCalendarType);
  console.log("  Display format: " + datePicker.dateDisplayFormat);
  console.log("  Display locale: " + datePicker.dateDisplayLocale);
  console.log("  Storage format: " + datePicker.dateStorageFormat);
});

dropDownListContentControl

Ruft die Daten des Inhaltssteuerelements ab, wenn sein Typ ist dropDownList. Es ist null anders.

readonly dropDownListContentControl: Word.DropDownListContentControl;

Eigenschaftswert

Word.DropDownListContentControl

Hinweise

API-Satz: WordApi 1.9

Beispiele

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

// Adds the provided list item to the first dropdown list content control in the selection.
await Word.run(async (context) => {
  const listItemText = (document.getElementById("item-to-add") as HTMLInputElement).value.trim();
  const selectedRange: Word.Range = context.document.getSelection();
  let selectedContentControl = selectedRange
    .getContentControls({
      types: [Word.ContentControlType.dropDownList]
    })
    .getFirstOrNullObject();
  selectedContentControl.load("id,dropDownListContentControl");
  await context.sync();

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

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

  selectedContentControl.dropDownListContentControl.addListItem(listItemText);
  await context.sync();

  console.log(`List item added to control with ID ${selectedContentControl.id}: ${listItemText}`);
});

endnotes

Ruft die Sammlung der Endnoten im Inhaltssteuerelement ab.

readonly endnotes: Word.NoteItemCollection;

Eigenschaftswert

Word.NoteItemCollection

Hinweise

fields

Ruft die Auflistung der Field Objekte im Inhaltssteuerelement ab.

readonly fields: Word.FieldCollection;

Eigenschaftswert

Word.FieldCollection

Hinweise

font

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

readonly font: Word.Font;

Eigenschaftswert

Word.Font

Hinweise

footnotes

Ruft die Sammlung der Fußnoten im Inhaltssteuerelement ab.

readonly footnotes: Word.NoteItemCollection;

Eigenschaftswert

Word.NoteItemCollection

Hinweise

groupContentControl

Ruft die gruppenbezogenen Daten ab, wenn das Inhaltssteuerelement Word ist. ContentControlType ist group. Es ist null anders.

readonly groupContentControl: Word.GroupContentControl;

Eigenschaftswert

Word.GroupContentControl

Hinweise

id

Ruft eine Ganzzahl ab, die den Inhaltssteuerelement-Bezeichner darstellt.

readonly id: number;

Eigenschaftswert

number

Hinweise

inlinePictures

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

readonly inlinePictures: Word.InlinePictureCollection;

Eigenschaftswert

Word.InlinePictureCollection

Hinweise

lists

Ruft die Auflistung der List Objekte im Inhaltssteuerelement ab.

readonly lists: Word.ListCollection;

Eigenschaftswert

Word.ListCollection

Hinweise

paragraphs

Ruft die Auflistung der Paragraph Objekte im Inhaltssteuerelement 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 Inhaltssteuerelement enthalten sind, nicht zurückgegeben. Aus Anforderungssatz 1.3 werden auch Absätze in solchen Tabellen zurückgegeben.

parentBody

Ruft den übergeordneten Text des Inhaltssteuerelements ab.

readonly parentBody: Word.Body;

Eigenschaftswert

Word.Body

Hinweise

parentContentControl

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

readonly parentContentControl: Word.ContentControl;

Eigenschaftswert

Word.ContentControl

Hinweise

parentContentControlOrNullObject

Ruft das Inhaltssteuerelement ab, das das Inhaltssteuerelement 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

Word.ContentControl

Hinweise

parentTable

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

readonly parentTable: Word.Table;

Eigenschaftswert

Word.Table

Hinweise

parentTableCell

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

readonly parentTableCell: Word.TableCell;

Eigenschaftswert

Word.TableCell

Hinweise

parentTableCellOrNullObject

Ruft die Tabellenzelle ab, die das Inhaltssteuerelement 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

Word.TableCell

Hinweise

parentTableOrNullObject

Ruft die Tabelle ab, die das Inhaltssteuerelement 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

Word.Table

Hinweise

pictureContentControl

Ruft die bildbezogenen Daten ab, wenn das Inhaltssteuerelement Word ist. ContentControlType ist picture. Es ist null anders.

readonly pictureContentControl: Word.PictureContentControl;

Eigenschaftswert

Word.PictureContentControl

Hinweise

placeholderText

Gibt den Platzhaltertext des Inhaltssteuerelements an. Abgeblendeter Text wird angezeigt, wenn das Inhaltssteuerelement leer ist.

placeholderText: string;

Eigenschaftswert

string

Hinweise

removeWhenEdited

Gibt an, ob das Inhaltssteuerelement nach der Bearbeitung entfernt wird. Schließt sich gegenseitig mit cannotDeleteaus.

removeWhenEdited: boolean;

Eigenschaftswert

boolean

Hinweise

repeatingSectionContentControl

Ruft die Daten zu wiederholten Abschnitten ab, wenn das Inhaltssteuerelement Word ist. ContentControlType ist repeatingSection. Es ist null anders.

readonly repeatingSectionContentControl: Word.RepeatingSectionContentControl;

Eigenschaftswert

Word.RepeatingSectionContentControl

Hinweise

style

Gibt den Formatvorlagennamen für das Inhaltssteuerelement an. Verwenden Sie diese Eigenschaft für benutzerdefinierte Formatvorlagen und lokalisierte Formatvorlagennamen. Informationen zur Verwendung der integrierten Formatvorlagen, die zwischen Gebietsschemas portierbar sind, finden Sie in der styleBuiltIn Eigenschaft.

style: string;

Eigenschaftswert

string

Hinweise

styleBuiltIn

Gibt den vordefinierten Formatvorlagennamen für das Inhaltssteuerelement an. Verwenden Sie diese Eigenschaft für integrierte Formatvorlagen, die zwischen Gebietsschemas portabel sind. Informationen zum Verwenden von benutzerdefinierten Formatvorlagen oder lokalisierten Formatvorlagennamen finden Sie in der style Eigenschaft.

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

subtype

Ruft den Untertyp des Inhaltssteuerelements ab. Der Untertyp kann ", richTextParagraphs, richTextTableCellrichTextTableRow" sein und richTextTable für Rich-Text-Inhaltssteuerelemente plainTextInline sowie plainTextParagraph für Nur-Text-InhaltssteuerelementerichTextInline, checkBox für Kontrollkästchen-Inhaltssteuerelemente, dropDownList für Dropdownlisten-Inhaltssteuerelemente, für Kombinationsfeld-Inhaltssteuerelemente, buildingBlockGallerycomboBox für Bausteinkatalog-Inhaltssteuerelemente, datePicker für Datumsauswahl-Inhaltssteuerelemente, repeatingSection für Inhaltssteuerelemente für wiederholte Abschnitte, picture für Bild-Inhaltssteuerelemente und group für Gruppeninhaltssteuerelemente.

readonly subtype: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText" | "Group";

Eigenschaftswert

Hinweise

tables

Ruft die Auflistung der Table Objekte im Inhaltssteuerelement ab.

readonly tables: Word.TableCollection;

Eigenschaftswert

Word.TableCollection

Hinweise

tag

Gibt ein Tag zum Identifizieren eines Inhaltssteuerelements an.

tag: string;

Eigenschaftswert

string

Hinweise

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

text

Ruft den Text des Inhaltssteuerelements ab.

readonly text: string;

Eigenschaftswert

string

Hinweise

title

Gibt den Titel für ein Inhaltssteuerelement an.

title: string;

Eigenschaftswert

string

Hinweise

type

Ruft den Typen des Inhaltssteuerelements ab. Derzeit werden nur Rich-Text-, Nur-Text-, Kontrollkästchen-, Dropdownlisten-, Kombinationsfeld-, Bausteinkatalog-, Datumsauswahl-, Wiederholte Abschnitt-, Bild- und Gruppeninhaltssteuerelemente unterstützt.

readonly type: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText" | "Group";

Eigenschaftswert

Hinweise

xmlMapping

Gibt ein XmlMapping Objekt zurück, das die Zuordnung des Inhaltssteuerelements zu XML-Daten im Datenspeicher des Dokuments darstellt.

readonly xmlMapping: Word.XmlMapping;

Eigenschaftswert

Word.XmlMapping

Hinweise

clear()

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

clear(): void;

Gibt zurück

void

Hinweise

Beispiele

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the content controls collection.
    contentControls.load('text');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
        
    if (contentControls.items.length === 0) {
        console.log("There isn't a content control in this document.");
    } else {
        // Queue a command to clear the contents of the first content control.
        contentControls.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('Content control cleared of contents.');
    }
});

delete(keepContent)

Löscht das Inhaltssteuerelement und dessen Inhalt. Wenn keepContent diese Option auf truefestgelegt ist, wird der Inhalt nicht gelöscht.

delete(keepContent: boolean): void;

Parameter

keepContent: boolean

Gibt an, ob der Inhalt mit dem Inhaltssteuerelement gelöscht werden soll. Wenn keepContent diese Option auf truefestgelegt ist, wird der Inhalt nicht gelöscht.

Gibt zurück

void

Hinweise

Beispiele

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

await Word.run(async (context) => {
  const contentControls: Word.ContentControlCollection = context.document.contentControls.getByTag("forTesting");
  contentControls.load("items");
  await context.sync();

  if (contentControls.items.length === 0) {
    console.log("There are no content controls in this document.");
  } else {
    console.log("Control to be deleted:", contentControls.items[0]);
    contentControls.items[0].delete(false);
    await context.sync();
  }
});

getComments()

Ruft Kommentare ab, die dem Inhaltssteuerelement zugeordnet sind.

getComments(): Word.CommentCollection;

Gibt zurück

Word.CommentCollection

Hinweise

getContentControls(options)

Ruft die derzeit unterstützten untergeordneten Inhaltssteuerelemente in diesem Inhaltssteuerelement 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 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.

getHtml()

Ruft eine HTML-Darstellung des ContentControl Objekts ab. Beim Rendern in einer Webseite oder einem HTML-Viewer entspricht die Formatierung der Formatierung des Dokuments nahe, aber nicht exakt. 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 ContentControl.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) => {
    
    // Create a proxy object for the content controls collection that contains a specific tag.
    const contentControlsWithTag = context.document.contentControls.getByTag('Customer-Address');
    
    // Queue a command to load the tag property for all of content controls.
    contentControlsWithTag.load('tag');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControlsWithTag.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to get the HTML contents of the first content control.
        const html = contentControlsWithTag.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('Content control HTML: ' + html.value);
    }
});

getOoxml()

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

getOoxml(): OfficeExtension.ClientResult<string>;

Gibt zurück

Hinweise

Beispiele

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to get the OOXML contents of the first content control.
        const ooxml = contentControls.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('Content control OOXML: ' + ooxml.value);
    }
});

getRange(rangeLocation)

Ruft das gesamte Inhaltssteuerelement oder den Start- bzw. Endpunkt des Inhaltssteuerelements als Bereich ab.

getRange(rangeLocation?: Word.RangeLocation | "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;

Parameter

rangeLocation: Word.RangeLocation | "Whole" | "Start" | "End" | "Before" | "After" | "Content"

Optional. Die Bereichsposition muss , start, end, afterbefore, oder sein.contentwhole

Gibt zurück

Word.Range

Hinweise

getReviewedText(changeTrackingVersion)

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

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

Parameter

changeTrackingVersion: Word.ChangeTrackingVersion

Optional. Der Wert muss OR currentseinoriginal. Der Standardwert ist current.

Gibt zurück

Hinweise

getReviewedText(changeTrackingVersion)

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

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

Parameter

changeTrackingVersion: "Original" | "Current"

Optional. Der Wert muss OR currentseinoriginal. Der Standardwert ist current.

Gibt zurück

Hinweise

getTextRanges(endingMarks, trimSpacing)

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

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

Parameter

endingMarks: string[]

Die Satzzeichen und andere Endzeichen als Array von Zeichenfolgen.

trimSpacing: boolean

Optional. Gibt an, ob Abstandszeichen (Leerzeichen, Tabstopps, Spaltenumbrüche und Absatzendmarken) vom Anfang und Ende der in der Bereichssammlung zurückgegebenen Bereiche entfernt werden sollen. "Standard" gibt false an, dass Abstandszeichen am Anfang und Ende der Bereiche in die Bereichssammlung eingeschlossen werden.

Gibt zurück

Word.RangeCollection

Hinweise

getTrackedChanges()

Ruft die Auflistung der TrackedChange Objekte im Inhaltssteuerelement ab.

getTrackedChanges(): Word.TrackedChangeCollection;

Gibt zurück

Word.TrackedChangeCollection

Hinweise

API-Satz: WordApi 1.6

insertBreak(breakType, insertLocation)

Fügt an der angegebenen Position im Hauptdokument einen Umbruch ein. Diese Methode kann nicht mit richTextTablerichTextTableRow, und richTextTableCell Inhaltssteuerelementen verwendet werden.

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

Parameter

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

Art der Pause.

insertLocation: start | end | before | after | "Start" | "End" | "Before" | "After"

Der Wert muss , end, beforeoder sein.afterstart

Gibt zurück

void

Hinweise

Beispiele

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of content controls.
    contentControls.load('id');
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    // We now will have access to the content control collection.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to insert a page break after the first content control.
        contentControls.items[0].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 first content control.');    
    }
});

insertFileFromBase64(base64File, insertLocation)

Fügt ein Dokument an der angegebenen Position in das Inhaltssteuerelement ein.

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

Parameter

base64File: string

Der Base64-codierte Inhalt einer .docx Datei.

insertLocation: replace | start | end | "Replace" | "Start" | "End"

Der Wert muss ,start oderend seinreplace. replace kann nicht mit richTextTablerichTextTableRow und Inhaltssteuerelementen verwendet werden.

Gibt zurück

Word.Range

Hinweise

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.

insertHtml(html, insertLocation)

Fügt an der angegebenen Position HTML ein.

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

Parameter

html: string

Der in das Inhaltssteuerelement einzufügende HTML-Code.

insertLocation: replace | start | end | "Replace" | "Start" | "End"

Der Wert muss ,start oderend seinreplace. replace kann nicht mit richTextTablerichTextTableRow und Inhaltssteuerelementen verwendet werden.

Gibt zurück

Word.Range

Hinweise

Beispiele

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to put HTML into the contents of the first content control.
        contentControls.items[0].insertHtml(
            '<strong>HTML content inserted into the content control.</strong>',
            'Start');
    
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Inserted HTML in the first content control.');
    }
});

insertInlinePictureFromBase64(base64EncodedImage, insertLocation)

Fügt an der angegebenen Position ein eingebundenes Bild in das Inhaltssteuerelement ein.

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

Parameter

base64EncodedImage: string

Das Base64-codierte Bild, das in das Inhaltssteuerelement eingefügt werden soll.

insertLocation: replace | start | end | "Replace" | "Start" | "End"

Der Wert muss ,start oderend seinreplace. replace kann nicht mit richTextTablerichTextTableRow und Inhaltssteuerelementen verwendet werden.

Gibt zurück

Word.InlinePicture

Hinweise

API-Satz: WordApi 1.2

insertOoxml(ooxml, insertLocation)

Fügt OOXML an der angegebenen Position in das Inhaltssteuerelement ein.

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

Parameter

ooxml: string

Das OOXML, das in das Inhaltssteuerelement eingefügt werden soll.

insertLocation: replace | start | end | "Replace" | "Start" | "End"

Der Wert muss ,start oderend seinreplace. replace kann nicht mit richTextTablerichTextTableRow und Inhaltssteuerelementen verwendet werden.

Gibt zurück

Word.Range

Hinweise

Beispiele

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to put OOXML into the contents of the first content control.
        contentControls.items[0].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>", "End");
    
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Inserted OOXML in the first content control.');
    }
});  

// 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.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): Word.Paragraph;

Parameter

paragraphText: string

Der einzufügende Absatztext.

insertLocation: start | end | before | after | "Start" | "End" | "Before" | "After"

Der Wert muss , end, beforeoder sein.afterstart beforeund after kann nicht mit richTextTableRowrichTextTable, und richTextTableCell Inhaltssteuerelementen verwendet werden.

Gibt zurück

Word.Paragraph

Hinweise

Beispiele

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to insert a paragraph after the first content control.
        contentControls.items[0].insertParagraph('Text of the inserted paragraph.', '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 paragraph after the first content control.');
    }
});

insertTable(rowCount, columnCount, insertLocation, values)

Fügt eine Tabelle mit der angegebenen Anzahl von Zeilen und Spalten in oder neben ein Inhaltssteuerelement ein.

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

Parameter

rowCount: number

Die Anzahl der Zeilen in der Tabelle.

columnCount: number

Die Anzahl der Spalten in der Tabelle.

insertLocation: start | end | before | after | "Start" | "End" | "Before" | "After"

Der Wert muss , end, beforeoder sein.afterstart beforeund after kann nicht mit richTextTableRowrichTextTable, und richTextTableCell Inhaltssteuerelementen verwendet werden.

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 in das Inhaltssteuerelement ein.

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

Parameter

text: string

Der in das Inhaltssteuerelement einzufügende Text.

insertLocation: replace | start | end | "Replace" | "Start" | "End"

Der Wert muss ,start oderend seinreplace. replace kann nicht mit richTextTablerichTextTableRow und Inhaltssteuerelementen verwendet werden.

Gibt zurück

Word.Range

Hinweise

Beispiele

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to replace text in the first content control.
        contentControls.items[0].insertText('Replaced text in the first content control.', 'Replace');
    
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Replaced text in the first content control.');
    }
});  

// The Silly stories add-in sample shows how to use the insertText method.
// https://aka.ms/sillystorywordaddin

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.ContentControlLoadOptions): Word.ContentControl;

Parameter

options: Word.Interfaces.ContentControlLoadOptions

Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.

Gibt zurück

Word.ContentControl

Beispiele

// Load all of the content control properties
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    } else {
        // Queue a command to load the properties on the first content control.
        contentControls.items[0].load(  'appearance,' +
                                        'cannotDelete,' +
                                        'cannotEdit,' +
                                        'id,' +
                                        'placeHolderText,' +
                                        'removeWhenEdited,' +
                                        'title,' +
                                        'text,' +
                                        'type,' +
                                        'style,' +
                                        'tag,' +
                                        'font/size,' +
                                        'font/name,' +
                                        'font/color');             
    
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Property values of the first content control:' + 
            '   ----- appearance: ' + contentControls.items[0].appearance + 
            '   ----- cannotDelete: ' + contentControls.items[0].cannotDelete +
            '   ----- cannotEdit: ' + contentControls.items[0].cannotEdit +
            '   ----- color: ' + contentControls.items[0].color +
            '   ----- id: ' + contentControls.items[0].id +
            '   ----- placeHolderText: ' + contentControls.items[0].placeholderText +
            '   ----- removeWhenEdited: ' + contentControls.items[0].removeWhenEdited +
            '   ----- title: ' + contentControls.items[0].title +
            '   ----- text: ' + contentControls.items[0].text +
            '   ----- type: ' + contentControls.items[0].type +
            '   ----- style: ' + contentControls.items[0].style +
            '   ----- tag: ' + contentControls.items[0].tag +
            '   ----- font size: ' + contentControls.items[0].font.size +
            '   ----- font name: ' + contentControls.items[0].font.name +
            '   ----- font color: ' + contentControls.items[0].font.color);
    }
});

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

Parameter

propertyNames: string | string[]

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

Gibt zurück

Word.ContentControl

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

Parameter

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

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

Gibt zurück

Word.ContentControl

resetState()

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Setzt den Status des Inhaltssteuerelements zurück.

resetState(): void;

Gibt zurück

void

Hinweise

Beispiele

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

// Resets the state of the first content control.
await Word.run(async (context) => {
  let firstContentControl = context.document.contentControls.getFirstOrNullObject();
  await context.sync();

  if (firstContentControl.isNullObject) {
    console.warn("There are no content controls in this document.");
    return;
  }

  firstContentControl.resetState();
  firstContentControl.load("id");
  await context.sync();

  console.log(`Reset state of first content control with ID: ${firstContentControl.id}`);
});

search(searchText, searchOptions)

Führt eine Suche mit den angegebenen Suchoptionen für den Bereich des Objekts ContentControl 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

searchText: string

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

Beispiele

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to select the first content control.
        contentControls.items[0].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 first content control.');
    }
});

select(selectionMode)

Wählt das Inhaltssteuerelement aus. Dies bewirkt, dass Word einen Bildlauf zur Auswahl durchführt.

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

Parameter

selectionMode: Word.SelectionMode

Optional. Der Auswahlmodus muss , oder seinendselect. start select ist die Standardeinstellung.

Gibt zurück

void

Hinweise

select(selectionMode)

Wählt das Inhaltssteuerelement aus. Dies bewirkt, dass Word einen Bildlauf zur Auswahl durchführt.

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

Parameter

selectionMode: "Select" | "Start" | "End"

Optional. Der Auswahlmodus muss , oder seinendselect. start 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.ContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameter

properties: Word.Interfaces.ContentControlUpdateData

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

options: OfficeExtension.UpdateOptions

Bietet eine Option zum Unterdrücken von Fehlern, wenn das properties-Objekt versucht, schreibgeschützte Eigenschaften festzulegen.

Gibt zurück

void

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

// Adds title and colors to odd and even content controls and changes their appearance.
await Word.run(async (context) => {
  // Get the complete sentence (as range) associated with the insertion point.
  let evenContentControls = context.document.contentControls.getByTag("even");
  let oddContentControls = context.document.contentControls.getByTag("odd");
  evenContentControls.load("length");
  oddContentControls.load("length");

  await context.sync();

  for (let i = 0; i < evenContentControls.items.length; i++) {
    // Change a few properties and append a paragraph.
    evenContentControls.items[i].set({
      color: "red",
      title: "Odd ContentControl #" + (i + 1),
      appearance: Word.ContentControlAppearance.tags
    });
    evenContentControls.items[i].insertParagraph("This is an odd content control", "End");
  }

  for (let j = 0; j < oddContentControls.items.length; j++) {
    // Change a few properties and append a paragraph.
    oddContentControls.items[j].set({
      color: "green",
      title: "Even ContentControl #" + (j + 1),
      appearance: "Tags"
    });
    oddContentControls.items[j].insertHtml("This is an <b>even</b> content control", "End");
  }

  await context.sync();
});

set(properties)

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

set(properties: Word.ContentControl): void;

Parameter

properties: Word.ContentControl

Gibt zurück

void

setState(contentControlState)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Legt den Status des Inhaltssteuerelements fest.

setState(contentControlState: Word.ContentControlState): void;

Parameter

contentControlState: Word.ContentControlState

noch festzulegender Zustand.

Gibt zurück

void

Hinweise

Beispiele

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

// Sets the state of the first content control.
await Word.run(async (context) => {
  const state = ((document.getElementById("state-to-set") as HTMLSelectElement)
    .value as unknown) as Word.ContentControlState;
  let firstContentControl = context.document.contentControls.getFirstOrNullObject();
  await context.sync();

  if (firstContentControl.isNullObject) {
    console.warn("There are no content controls in this document.");
    return;
  }

  firstContentControl.setState(state);
  firstContentControl.load("id");
  await context.sync();

  console.log(`Set state of first content control with ID ${firstContentControl.id} to ${state}.`);
});

setState(contentControlState)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Legt den Status des Inhaltssteuerelements fest.

setState(contentControlState: "Error" | "Warning"): void;

Parameter

contentControlState: "Error" | "Warning"

noch festzulegender Zustand.

Gibt zurück

void

Hinweise

split(delimiters, multiParagraphs, trimDelimiters, trimSpacing)

Teilt das Inhaltssteuerelement mithilfe von Trennzeichen in untergeordnete Bereiche.

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

Parameter

delimiters: string[]

Die Trennzeichen als Array von Zeichenfolgen.

multiParagraphs: boolean

Optional. Gibt an, ob ein zurückgegebener untergeordneter Bereich mehrere Absätze umfassen kann. Der Standardwert gibt false an, dass die Absatzbegrenzungen auch als Trennzeichen verwendet werden.

trimDelimiters: boolean

Optional. Gibt an, ob Trennzeichen aus den Bereichen in der Bereichssammlung entfernt werden sollen. Der Standardwert gibt false an, dass die Trennzeichen in den Bereichen enthalten sind, die in der Bereichsauflistung zurückgegeben werden.

trimSpacing: boolean

Optional. Gibt an, ob Abstandszeichen (Leerzeichen, Tabstopps, Spaltenumbrüche und Absatzendmarken) vom Anfang und Ende der in der Bereichssammlung zurückgegebenen Bereiche entfernt werden sollen. "Standard" gibt false an, dass Abstandszeichen am Anfang und Ende der Bereiche in die Bereichssammlung eingeschlossen werden.

Gibt zurück

Word.RangeCollection

Hinweise

OfficeExtension.EventHandlers<Word.CommentEventArgs>

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

toJSON(): Word.Interfaces.ContentControlData;

Gibt zurück

Word.Interfaces.ContentControlData

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

Gibt zurück

Word.ContentControl

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 einen Aufruf durchführen context.sync() , bevor die Speicherfreigabe wirksam wird.

untrack(): Word.ContentControl;

Gibt zurück

Word.ContentControl

onCommentAdded

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Tritt auf, wenn neue Kommentare hinzugefügt werden.

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

Ereignistyp

Hinweise

OfficeExtension.EventHandlers<Word.CommentEventArgs>

onCommentChanged

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

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

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

Ereignistyp

Hinweise

OfficeExtension.EventHandlers<Word.CommentEventArgs>

onCommentDeselected

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Tritt auf, wenn die Auswahl eines Kommentars aufgehoben wird.

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

Ereignistyp

Hinweise

OfficeExtension.EventHandlers<Word.CommentEventArgs>

onCommentSelected

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Tritt auf, wenn ein Kommentar ausgewählt ist.

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

Ereignistyp

Hinweise

OfficeExtension.EventHandlers<Word.ContentControlDataChangedEventArgs>

onDataChanged

Tritt auf, wenn Daten innerhalb des Inhaltssteuerelements geändert werden. Um den neuen Text abzurufen, laden Sie dieses Inhaltssteuerelement in den Handler. Laden Sie den alten Text nicht, um ihn zu erhalten.

readonly onDataChanged: OfficeExtension.EventHandlers<Word.ContentControlDataChangedEventArgs>;

Ereignistyp

Hinweise

OfficeExtension.EventHandlers<Word.ContentControlDeletedEventArgs>

Beispiele

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

await Word.run(async (context) => {
  const contentControls: Word.ContentControlCollection = context.document.contentControls;
  contentControls.load("items");
  await context.sync();

  // Register the onDataChanged event handler on each content control.
  if (contentControls.items.length === 0) {
    console.log("There aren't any content controls in this document so can't register event handlers.");
  } else {
    for (let i = 0; i < contentControls.items.length; i++) {
      eventContexts[i] = contentControls.items[i].onDataChanged.add(contentControlDataChanged);
      contentControls.items[i].track();
    }

    await context.sync();

    console.log("Added event handlers for when data is changed in content controls.");
  }
});

...

async function contentControlDataChanged(event: Word.ContentControlDataChangedEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.eventType} event detected. IDs of content controls where data was changed:`, event.ids);
  });
}

onDeleted

Tritt auf, wenn das Inhaltssteuerelement gelöscht wird. Laden Sie dieses Inhaltssteuerelement nicht in den Handler, da Sie sonst seine ursprünglichen Eigenschaften nicht abrufen können.

readonly onDeleted: OfficeExtension.EventHandlers<Word.ContentControlDeletedEventArgs>;

Ereignistyp

Hinweise

OfficeExtension.EventHandlers<Word.ContentControlEnteredEventArgs>

Beispiele

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

await Word.run(async (context) => {
  const contentControls: Word.ContentControlCollection = context.document.contentControls;
  contentControls.load("items");
  await context.sync();

  // Register the onDeleted event handler on each content control.
  if (contentControls.items.length === 0) {
    console.log("There aren't any content controls in this document so can't register event handlers.");
  } else {
    for (let i = 0; i < contentControls.items.length; i++) {
      eventContexts[i] = contentControls.items[i].onDeleted.add(contentControlDeleted);
      contentControls.items[i].track();
    }

    await context.sync();

    console.log("Added event handlers for when content controls are deleted.");
  }
});

...

async function contentControlDeleted(event: Word.ContentControlDeletedEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.eventType} event detected. IDs of content controls that were deleted:`, event.ids);
  });
}

onEntered

Tritt auf, wenn das Inhaltssteuerelement eingegeben wird.

readonly onEntered: OfficeExtension.EventHandlers<Word.ContentControlEnteredEventArgs>;

Ereignistyp

Hinweise

OfficeExtension.EventHandlers<Word.ContentControlExitedEventArgs>

Beispiele

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

await Word.run(async (context) => {
  const contentControls: Word.ContentControlCollection = context.document.contentControls;
  contentControls.load("items");
  await context.sync();

  // Register the onEntered event handler on each content control.
  if (contentControls.items.length === 0) {
    console.log("There aren't any content controls in this document so can't register event handlers.");
  } else {
    for (let i = 0; i < contentControls.items.length; i++) {
      eventContexts[i] = contentControls.items[i].onEntered.add(contentControlEntered);
      contentControls.items[i].track();
    }

    await context.sync();

    console.log("Added event handlers for when the cursor is placed in content controls.");
  }
});

...

async function contentControlEntered(event: Word.ContentControlEnteredEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.eventType} event detected. ID of content control that was entered: ${event.ids[0]}`);
  });
}

onExited

Tritt auf, wenn das Inhaltssteuerelement verlassen wird, z. B. wenn der Cursor das Inhaltssteuerelement verlässt.

readonly onExited: OfficeExtension.EventHandlers<Word.ContentControlExitedEventArgs>;

Ereignistyp

Hinweise

OfficeExtension.EventHandlers<Word.ContentControlSelectionChangedEventArgs>

Beispiele

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

await Word.run(async (context) => {
  const contentControls: Word.ContentControlCollection = context.document.contentControls;
  contentControls.load("items");
  await context.sync();

  // Register the onExited event handler on each content control.
  if (contentControls.items.length === 0) {
    console.log("There aren't any content controls in this document so can't register event handlers.");
  } else {
    for (let i = 0; i < contentControls.items.length; i++) {
      eventContexts[i] = contentControls.items[i].onExited.add(contentControlExited);
      contentControls.items[i].track();
    }

    await context.sync();

    console.log("Added event handlers for when the cursor is removed from within content controls.");
  }
});

...

async function contentControlExited(event: Word.ContentControlExitedEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.eventType} event detected. ID of content control that was exited: ${event.ids[0]}`);
  });
}

onSelectionChanged

Tritt auf, wenn die Auswahl innerhalb des Inhaltssteuerelements geändert wird.

readonly onSelectionChanged: OfficeExtension.EventHandlers<Word.ContentControlSelectionChangedEventArgs>;

Ereignistyp

Hinweise