Word.Field class

Paket:

word

Stellt ein Feld dar.

Extends

OfficeExtension.ClientObject

Hinweise

[ API-Satz: WordApi 1.4 ]

Wichtig: Weitere Informationen dazu, welche Felder eingefügt werden können, finden Sie in der API, die Word.Range.insertField in Anforderungssatz 1.5 eingeführt wurde. Die Unterstützung für die Verwaltung von Feldern ähnelt dem, was auf der Word-Benutzeroberfläche verfügbar ist. Während die Word-Benutzeroberfläche im Web in erster Linie felder als schreibgeschützt unterstützt (siehe Feldfunktionen in Word für das Web), kann das Addin Feld bearbeitet werden. Weitere Informationen zu Word UI-Clients, die Felder vollständig unterstützen, finden Sie in der Produktliste am Anfang von Einfügen, Bearbeiten und Anzeigen von Feldern in Word.

Beispiele

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

// Gets the first field in the document.
await Word.run(async (context) => {
  const field: Word.Field = context.document.body.fields.getFirstOrNullObject();
  field.load(["code", "result", "locked", "type", "data", "kind"]);

  await context.sync();

  if (field.isNullObject) {
    console.log("This document has no fields.");
  } else {
    console.log("Code of first field: " + field.code, "Result of first field: " + JSON.stringify(field.result), "Type of first field: " + field.type, "Is the first field locked? " + field.locked, "Kind of the first field: " + field.kind);
  }
});

Eigenschaften

code	Gibt die Codeanweisung des Felds an.
context	Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
data	Gibt Daten in einem Addin-Feld an. Wenn es sich bei dem Feld nicht um ein "Addin"-Feld handelt, wird null eine allgemeine Ausnahme ausgelöst, wenn code versucht, es festzulegen.
kind	Ruft die Art des Felds ab.
locked	Gibt an, ob das Feld gesperrt ist. true , wenn das Feld gesperrt ist, andernfalls false .
parentBody	Ruft den übergeordneten Text des Felds ab.
parentContentControl	Ruft das Inhaltssteuerelement ab, das das Feld enthält. Löst einen Fehler aus ItemNotFound , wenn kein übergeordnetes Inhaltssteuerelement vorhanden ist.
parentContentControlOrNullObject	Ruft das Inhaltssteuerelement ab, das das Feld enthält. Wenn kein übergeordnetes Inhaltssteuerelement vorhanden ist, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
parentTable	Ruft die Tabelle ab, die das Feld enthält. Löst einen Fehler aus ItemNotFound , wenn er nicht in einer Tabelle enthalten ist.
parentTableCell	Ruft die Tabellenzelle ab, die das Feld enthält. Löst einen Fehler aus ItemNotFound , wenn er nicht in einer Tabellenzelle enthalten ist.
parentTableCellOrNullObject	Ruft die Tabellenzelle ab, die das Feld enthält. Wenn sie nicht in einer Tabellenzelle enthalten ist, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
parentTableOrNullObject	Ruft die Tabelle ab, die das Feld enthält. Wenn sie nicht in einer Tabelle enthalten ist, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
result	Ruft die Ergebnisdaten des Felds ab.
type	Ruft den Typ des Felds ab.

Methoden

delete()	Löscht das Feld.
getNext()	Ruft das nächste Feld ab. Löst einen Fehler aus ItemNotFound , wenn dieses Feld das letzte ist.
getNextOrNullObject()	Ruft das nächste Feld ab. Wenn es sich bei diesem Feld um das letzte Feld handelt, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
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.
select(selectionMode)	Wählt das Feld aus.
select(selectionModeString)	Wählt das Feld aus.
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.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Word.Field Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.FieldData) 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.
updateResult()	Updates das Feld.

Details zur Eigenschaft

code

Gibt die Codeanweisung des Felds an.

code: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApi 1.4 ]

Hinweis: Die Möglichkeit zum Festlegen des Codes wurde in WordApi 1.5 eingeführt.

Beispiele

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

// Gets the first field in the document.
await Word.run(async (context) => {
  const field: Word.Field = context.document.body.fields.getFirstOrNullObject();
  field.load(["code", "result", "locked", "type", "data", "kind"]);

  await context.sync();

  if (field.isNullObject) {
    console.log("This document has no fields.");
  } else {
    console.log("Code of first field: " + field.code, "Result of first field: " + JSON.stringify(field.result), "Type of first field: " + field.type, "Is the first field locked? " + field.locked, "Kind of the first field: " + field.kind);
  }
});

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

data

Gibt Daten in einem Addin-Feld an. Wenn es sich bei dem Feld nicht um ein "Addin"-Feld handelt, wird null eine allgemeine Ausnahme ausgelöst, wenn code versucht, es festzulegen.

data: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApi 1.5 ]

kind

Ruft die Art des Felds ab.

readonly kind: Word.FieldKind | "None" | "Hot" | "Warm" | "Cold";

Eigenschaftswert

Word.FieldKind | "None" | "Hot" | "Warm" | "Cold"

Hinweise

[ API-Satz: WordApi 1.5 ]

Beispiele

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

// Gets the first field in the document.
await Word.run(async (context) => {
  const field: Word.Field = context.document.body.fields.getFirstOrNullObject();
  field.load(["code", "result", "locked", "type", "data", "kind"]);

  await context.sync();

  if (field.isNullObject) {
    console.log("This document has no fields.");
  } else {
    console.log("Code of first field: " + field.code, "Result of first field: " + JSON.stringify(field.result), "Type of first field: " + field.type, "Is the first field locked? " + field.locked, "Kind of the first field: " + field.kind);
  }
});

locked

Gibt an, ob das Feld gesperrt ist. true , wenn das Feld gesperrt ist, andernfalls false .

locked: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.5 ]

Beispiele

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

// Gets the first field in the selection and toggles between setting it to locked or unlocked.
await Word.run(async (context) => {
  let field = context.document.getSelection().fields.getFirstOrNullObject();
  field.load(["code", "result", "type", "locked"]);
  await context.sync();

  if (field.isNullObject) {
    console.log("The selection has no fields.");
  } else {
    console.log(`The first field in the selection is currently ${field.locked ? "locked" : "unlocked"}.`);
    field.locked = !field.locked;
    await context.sync();

    console.log(`The first field in the selection is now ${field.locked ? "locked" : "unlocked"}.`);
  }
});

parentBody

Ruft den übergeordneten Text des Felds ab.

readonly parentBody: Word.Body;

Eigenschaftswert

Word.Body

Hinweise

[ API-Satz: WordApi 1.4 ]

Beispiele

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

// Gets the parent body of the first field in the document.
await Word.run(async (context) => {
  const field: Word.Field = context.document.body.fields.getFirstOrNullObject();
  field.load("parentBody/text");

  await context.sync();

  if (field.isNullObject) {
    console.log("This document has no fields.");
  } else {
    const parentBody: Word.Body = field.parentBody;
    console.log("Text of first field's parent body: " + JSON.stringify(parentBody.text));
  }
});

parentContentControl

Ruft das Inhaltssteuerelement ab, das das Feld 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.4 ]

parentContentControlOrNullObject

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

readonly parentContentControlOrNullObject: Word.ContentControl;

Eigenschaftswert

Word.ContentControl

Hinweise

[ API-Satz: WordApi 1.4 ]

parentTable

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

readonly parentTable: Word.Table;

Eigenschaftswert

Word.Table

Hinweise

[ API-Satz: WordApi 1.4 ]

parentTableCell

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

readonly parentTableCell: Word.TableCell;

Eigenschaftswert

Word.TableCell

Hinweise

[ API-Satz: WordApi 1.4 ]

parentTableCellOrNullObject

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

readonly parentTableCellOrNullObject: Word.TableCell;

Eigenschaftswert

Word.TableCell

Hinweise

[ API-Satz: WordApi 1.4 ]

parentTableOrNullObject

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

readonly parentTableOrNullObject: Word.Table;

Eigenschaftswert

Word.Table

Hinweise

[ API-Satz: WordApi 1.4 ]

result

Ruft die Ergebnisdaten des Felds ab.

readonly result: Word.Range;

Eigenschaftswert

Word.Range

Hinweise

[ API-Satz: WordApi 1.4 ]

Beispiele

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

// Gets the first field in the document.
await Word.run(async (context) => {
  const field: Word.Field = context.document.body.fields.getFirstOrNullObject();
  field.load(["code", "result", "locked", "type", "data", "kind"]);

  await context.sync();

  if (field.isNullObject) {
    console.log("This document has no fields.");
  } else {
    console.log("Code of first field: " + field.code, "Result of first field: " + JSON.stringify(field.result), "Type of first field: " + field.type, "Is the first field locked? " + field.locked, "Kind of the first field: " + field.kind);
  }
});

type

Ruft den Typ des Felds ab.

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

Eigenschaftswert

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

Hinweise

[ API-Satz: WordApi 1.5 ]

Beispiele

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

// Gets the first field in the document.
await Word.run(async (context) => {
  const field: Word.Field = context.document.body.fields.getFirstOrNullObject();
  field.load(["code", "result", "locked", "type", "data", "kind"]);

  await context.sync();

  if (field.isNullObject) {
    console.log("This document has no fields.");
  } else {
    console.log("Code of first field: " + field.code, "Result of first field: " + JSON.stringify(field.result), "Type of first field: " + field.type, "Is the first field locked? " + field.locked, "Kind of the first field: " + field.kind);
  }
});

Details zur Methode

delete()

Löscht das Feld.

delete(): void;

Gibt zurück

void

Hinweise

[ API-Satz: WordApi 1.5 ]

Beispiele

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

// Deletes the first field in the document.
await Word.run(async (context) => {
  const field: Word.Field = context.document.body.fields.getFirstOrNullObject();
  field.load();

  await context.sync();

  if (field.isNullObject) {
    console.log("This document has no fields.");
  } else {
    field.delete();
    await context.sync();

    console.log("The first field in the document was deleted.");
  }
});

getNext()

Ruft das nächste Feld ab. Löst einen Fehler aus ItemNotFound , wenn dieses Feld das letzte ist.

getNext(): Word.Field;

Gibt zurück

Word.Field

Hinweise

[ API-Satz: WordApi 1.4 ]

getNextOrNullObject()

Ruft das nächste Feld ab. Wenn es sich bei diesem Feld um das letzte Feld handelt, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getNextOrNullObject(): Word.Field;

Gibt zurück

Word.Field

Hinweise

[ API-Satz: WordApi 1.4 ]

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.FieldLoadOptions): Word.Field;

Parameter

options

Word.Interfaces.FieldLoadOptions

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

Gibt zurück

Word.Field

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

Parameter

propertyNames

string | string[]

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

Gibt zurück

Word.Field

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

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.Field

select(selectionMode)

Wählt das Feld aus.

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.5 ]

Beispiele

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

// Gets and updates the first field in the selection.
await Word.run(async (context) => {
  let field = context.document.getSelection().fields.getFirstOrNullObject();
  field.load(["code", "result", "type", "locked"]);

  await context.sync();

  if (field.isNullObject) {
    console.log("No field in selection.");
  } else {
    console.log("Before updating:", "Code of first field: " + field.code, "Result of first field: " + JSON.stringify(field.result));

    field.updateResult();
    field.select();
    await context.sync();

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

    console.log("After updating:", "Code of first field: " + field.code, "Result of first field: " + JSON.stringify(field.result));
  }
});

select(selectionModeString)

Wählt das Feld aus.

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.5 ]

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

Parameter

properties

Word.Interfaces.FieldUpdateData

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.Field): void;

Parameter

properties

Word.Field

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

toJSON(): Word.Interfaces.FieldData;

Gibt zurück

Word.Interfaces.FieldData

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

Gibt zurück

Word.Field

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

Gibt zurück

Word.Field

updateResult()

Updates das Feld.

updateResult(): void;

Gibt zurück

void

Hinweise

[ API-Satz: WordApi 1.5 ]

Beispiele

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

// Gets and updates the first field in the selection.
await Word.run(async (context) => {
  let field = context.document.getSelection().fields.getFirstOrNullObject();
  field.load(["code", "result", "type", "locked"]);

  await context.sync();

  if (field.isNullObject) {
    console.log("No field in selection.");
  } else {
    console.log("Before updating:", "Code of first field: " + field.code, "Result of first field: " + JSON.stringify(field.result));

    field.updateResult();
    field.select();
    await context.sync();

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

    console.log("After updating:", "Code of first field: " + field.code, "Result of first field: " + JSON.stringify(field.result));
  }
});