Word.List class

Referenz

Paket:: word

Enthält eine Auflistung von Word. Absatzobjekte.

Extends: OfficeExtension.ClientObject

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/insert-list.yaml

// This example starts a new list with the second paragraph.
await Word.run(async (context) => {
  const paragraphs = context.document.body.paragraphs;
  paragraphs.load("$none");

  await context.sync();

  // Start new list using the second paragraph.
  const list = paragraphs.items[1].startNewList();
  list.load("$none");

  await context.sync();

  // To add new items to the list, use Start or End on the insertLocation parameter.
  list.insertParagraph("New list item at the start of the list", "Start");
  const paragraph = list.insertParagraph("New list item at the end of the list (set to list level 5)", "End");

  // Set up list level for the list item.
  paragraph.listItem.level = 4;

  // To add paragraphs outside the list, use Before or After.
  list.insertParagraph("New paragraph goes after (not part of the list)", "After");

  await context.sync();
});

Eigenschaften

context	Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
id	Ruft die ID der Liste ab.
levelExistences	Überprüft, ob jede der 9 Ebenen in der Liste vorhanden ist. Der Wert true gibt an, dass die Ebene vorhanden ist, was bedeutet, dass mindestens ein Listenelement auf dieser Ebene vorhanden ist.
levelTypes	Ruft die Typen aller 9 Ebenen in der Liste ab. Jeder Typ kann "Bullet", "Number" oder "Picture" sein.
paragraphs	Ruft die Absätze in der Liste ab. Schreibgeschützt.

Methoden

getLevelFont(level)	Ruft die Schriftart des Aufzählungszeichens, der Zahl oder des Bilds auf der angegebenen Ebene in der Liste ab.
getLevelParagraphs(level)	Ruft die Absätze auf der angegebenen Ebene in der Liste ab.
getLevelPicture(level)	Ruft die Base64-codierte Zeichenfolgendarstellung der Grafik auf der angegebenen Ebene in der Liste ab.
getLevelString(level)	Ruft das Aufzählungszeichen, die Zahl oder das Bild auf der angegebenen Ebene als Zeichenfolge ab.
insertParagraph(paragraphText, insertLocation)	Fügt an der angegebenen Position einen Absatz 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.
resetLevelFont(level, resetFontName)	Setzt die Schriftart des Aufzählungszeichens, der Zahl oder des Bilds auf der angegebenen Ebene in der Liste zurück.
setLevelAlignment(level, alignment)	Legt die Ausrichtung des Aufzählungszeichens, der Zahl oder des Bilds auf der angegebenen Ebene in der Liste fest.
setLevelAlignment(level, alignmentString)	Legt die Ausrichtung des Aufzählungszeichens, der Zahl oder des Bilds auf der angegebenen Ebene in der Liste fest.
setLevelBullet(level, listBullet, charCode, fontName)	Legt das Format des Aufzählungszeichens auf der angegebenen Ebene in der Liste fest. Wenn das Aufzählungszeichen vom Typ "Custom" ist, ist charCode erforderlich.
setLevelBullet(level, listBulletString, charCode, fontName)	Legt das Format des Aufzählungszeichens auf der angegebenen Ebene in der Liste fest. Wenn das Aufzählungszeichen vom Typ "Custom" ist, ist charCode erforderlich.
setLevelIndents(level, textIndent, bulletNumberPictureIndent)	Legt die zwei Einzüge der angegebenen Ebene in der Liste fest.
setLevelNumbering(level, listNumbering, formatString)	Legt das Nummerierungsformat auf der angegebenen Ebene in der Liste fest.
setLevelNumbering(level, listNumberingString, formatString)	Legt das Nummerierungsformat auf der angegebenen Ebene in der Liste fest.
setLevelPicture(level, base64EncodedImage)	Legt das Bild auf der angegebenen Ebene in der Liste fest.
setLevelStartingNumber(level, startingNumber)	Legt die Anfangsnummer auf der angegebenen Ebene in der Liste fest. Der Standardwert ist 1.
toJSON()	Überschreibt die JavaScript-Methode `toJSON()` , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an `JSON.stringify()`übergeben wird. (`JSON.stringify`ruft wiederum die `toJSON` -Methode des Objekts auf, das an das Objekt übergeben wird.) Die ursprüngliche Word. Das List-Objekt ist ein API-Objekt. Die `toJSON` Methode gibt ein einfaches JavaScript-Objekt (typisiert als `Word.Interfaces.ListData`) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
track()	Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über `.sync` Aufrufe hinweg und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Auflistung ist, sollten Sie auch die übergeordnete Auflistung nachverfolgen.
untrack()	Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen `context.sync()` , bevor die Speicherfreigabe wirksam wird.

Details zur Eigenschaft

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

id

Ruft die ID der Liste ab.

readonly id: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApi 1.3 ]

levelExistences

Überprüft, ob jede der 9 Ebenen in der Liste vorhanden ist. Der Wert true gibt an, dass die Ebene vorhanden ist, was bedeutet, dass mindestens ein Listenelement auf dieser Ebene vorhanden ist.

readonly levelExistences: boolean[];

Eigenschaftswert

boolean[]

Hinweise

[ API-Satz: WordApi 1.3 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/organize-list.yaml

// Gets information about the first list in the document.
await Word.run(async (context) => {
  const lists = context.document.body.lists;
  lists.load("items");

  await context.sync();

  if (lists.items.length === 0) {
    console.warn("There are no lists in this document");
    return;
  }
  
  // Get the first list.
  const list = lists.getFirst();
  list.load("levelTypes,levelExistences");

  await context.sync();

  const levelTypes = list.levelTypes;
  console.log("Level types of the first list:");
  for (let i = 0; i < levelTypes.length; i++) {
    console.log(`- Level ${i + 1} (index ${i}): ${levelTypes[i]}`);
  }

  const levelExistences = list.levelExistences;
  console.log("Level existences of the first list:");
  for (let i = 0; i < levelExistences.length; i++) {
    console.log(`- Level ${i + 1} (index ${i}): ${levelExistences[i]}`);
  }
});

levelTypes

Ruft die Typen aller 9 Ebenen in der Liste ab. Jeder Typ kann "Bullet", "Number" oder "Picture" sein.

readonly levelTypes: Word.ListLevelType[];

Eigenschaftswert

Word.ListLevelType[]

Hinweise

[ API-Satz: WordApi 1.3 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/organize-list.yaml

// Gets information about the first list in the document.
await Word.run(async (context) => {
  const lists = context.document.body.lists;
  lists.load("items");

  await context.sync();

  if (lists.items.length === 0) {
    console.warn("There are no lists in this document");
    return;
  }
  
  // Get the first list.
  const list = lists.getFirst();
  list.load("levelTypes,levelExistences");

  await context.sync();

  const levelTypes = list.levelTypes;
  console.log("Level types of the first list:");
  for (let i = 0; i < levelTypes.length; i++) {
    console.log(`- Level ${i + 1} (index ${i}): ${levelTypes[i]}`);
  }

  const levelExistences = list.levelExistences;
  console.log("Level existences of the first list:");
  for (let i = 0; i < levelExistences.length; i++) {
    console.log(`- Level ${i + 1} (index ${i}): ${levelExistences[i]}`);
  }
});

paragraphs

Ruft die Absätze in der Liste ab. Schreibgeschützt.

readonly paragraphs: Word.ParagraphCollection;

Eigenschaftswert

Word.ParagraphCollection

Hinweise

[ API-Satz: WordApi 1.3 ]

Details zur Methode

getLevelFont(level)

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.

Ruft die Schriftart des Aufzählungszeichens, der Zahl oder des Bilds auf der angegebenen Ebene in der Liste ab.

getLevelFont(level: number): Word.Font;

Parameter

level: number

Erforderlich. Die Ebene in der Liste.

Gibt zurück

Word.Font

Hinweise

[ API-Satz: WordApi BETA (NUR VORSCHAU) ]

getLevelParagraphs(level)

Ruft die Absätze auf der angegebenen Ebene in der Liste ab.

getLevelParagraphs(level: number): Word.ParagraphCollection;

Parameter

level: number

Erforderlich. Die Ebene in der Liste.

Gibt zurück

Word.ParagraphCollection

Hinweise

[ API-Satz: WordApi 1.3 ]

getLevelPicture(level)

Hinweis

Ruft die Base64-codierte Zeichenfolgendarstellung der Grafik auf der angegebenen Ebene in der Liste ab.

getLevelPicture(level: number): OfficeExtension.ClientResult<string>;

Parameter

level: number

Erforderlich. Die Ebene in der Liste.

Gibt zurück

OfficeExtension.ClientResult<string>

Hinweise

[ API-Satz: WordApi BETA (NUR VORSCHAU) ]

getLevelString(level)

Ruft das Aufzählungszeichen, die Zahl oder das Bild auf der angegebenen Ebene als Zeichenfolge ab.

getLevelString(level: number): OfficeExtension.ClientResult<string>;

Parameter

level: number

Erforderlich. Die Ebene in der Liste.

Gibt zurück

OfficeExtension.ClientResult<string>

Hinweise

[ API-Satz: WordApi 1.3 ]

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

Erforderlich. Der einzufügende Absatztext.

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

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

Gibt zurück

Word.Paragraph

Hinweise

[ API-Satz: WordApi 1.3 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/insert-list.yaml

// This example starts a new list with the second paragraph.
await Word.run(async (context) => {
  const paragraphs = context.document.body.paragraphs;
  paragraphs.load("$none");

  await context.sync();

  // Start new list using the second paragraph.
  const list = paragraphs.items[1].startNewList();
  list.load("$none");

  await context.sync();

  // To add new items to the list, use Start or End on the insertLocation parameter.
  list.insertParagraph("New list item at the start of the list", "Start");
  const paragraph = list.insertParagraph("New list item at the end of the list (set to list level 5)", "End");

  // Set up list level for the list item.
  paragraph.listItem.level = 4;

  // To add paragraphs outside the list, use Before or After.
  list.insertParagraph("New paragraph goes after (not part of the list)", "After");

  await context.sync();
});

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.ListLoadOptions): Word.List;

Parameter

options: Word.Interfaces.ListLoadOptions

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

Gibt zurück

Word.List

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

Parameter

propertyNames: string | string[]

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

Gibt zurück

Word.List

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

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

resetLevelFont(level, resetFontName)

Hinweis

Setzt die Schriftart des Aufzählungszeichens, der Zahl oder des Bilds auf der angegebenen Ebene in der Liste zurück.

resetLevelFont(level: number, resetFontName?: boolean): void;

Parameter

level: number

Erforderlich. Die Ebene in der Liste.

resetFontName: boolean

Optional. Gibt an, ob der Schriftartname zurückgesetzt werden soll. Der Standardwert ist false, was angibt, dass der Schriftartname unverändert bleibt.

Gibt zurück

void

Hinweise

[ API-Satz: WordApi BETA (NUR VORSCHAU) ]

setLevelAlignment(level, alignment)

Legt die Ausrichtung des Aufzählungszeichens, der Zahl oder des Bilds auf der angegebenen Ebene in der Liste fest.

setLevelAlignment(level: number, alignment: Word.Alignment): void;

Parameter

level: number

Erforderlich. Die Ebene in der Liste.

alignment: Word.Alignment

Erforderlich. Die Ebenenausrichtung, die "Links", "Zentriert" oder "Rechts" sein muss.

Gibt zurück

void

Hinweise

[ API-Satz: WordApi 1.3 ]

setLevelAlignment(level, alignmentString)

Legt die Ausrichtung des Aufzählungszeichens, der Zahl oder des Bilds auf der angegebenen Ebene in der Liste fest.

setLevelAlignment(level: number, alignmentString: "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"): void;

Parameter

level: number

Erforderlich. Die Ebene in der Liste.

alignmentString: "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"

Erforderlich. Die Ebenenausrichtung, die "Links", "Zentriert" oder "Rechts" sein muss.

Gibt zurück

void

Hinweise

[ API-Satz: WordApi 1.3 ]

setLevelBullet(level, listBullet, charCode, fontName)

Legt das Format des Aufzählungszeichens auf der angegebenen Ebene in der Liste fest. Wenn das Aufzählungszeichen vom Typ "Custom" ist, ist charCode erforderlich.

setLevelBullet(level: number, listBullet: Word.ListBullet, charCode?: number, fontName?: string): void;

Parameter

level: number

Erforderlich. Die Ebene in der Liste.

listBullet: Word.ListBullet

Erforderlich. Das Aufzählungszeichen.

charCode: number

Optional. Der Codewert des Aufzählungszeichens. Wird nur verwendet, wenn das Aufzählungszeichen "Benutzerdefiniert" ist.

fontName: string

Optional. Der Schriftartname des Aufzählungszeichens. Wird nur verwendet, wenn das Aufzählungszeichen "Benutzerdefiniert" ist.

Gibt zurück

void

Hinweise

[ API-Satz: WordApi 1.3 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/organize-list.yaml

// Inserts a list starting with the first paragraph then set numbering and bullet types of the list items.
await Word.run(async (context) => {
  const paragraphs = context.document.body.paragraphs;
  paragraphs.load("$none");

  await context.sync();

  // Use the first paragraph to start a new list.
  const list = paragraphs.items[0].startNewList();
  list.load("$none");

  await context.sync();

  // To add new items to the list, use Start or End on the insertLocation parameter.
  list.insertParagraph("New list item at the start of the list", "Start");
  const paragraph = list.insertParagraph("New list item at the end of the list (set to list level 5)", "End");

  // Set numbering for list level 1.
  list.setLevelNumbering(0, Word.ListNumbering.arabic);

  // Set bullet type for list level 5.
  list.setLevelBullet(4, Word.ListBullet.arrow);

  // Set list level for the last item in this list.
  paragraph.listItem.level = 4;

  list.load("levelTypes");

  await context.sync();
});

setLevelBullet(level, listBulletString, charCode, fontName)

Legt das Format des Aufzählungszeichens auf der angegebenen Ebene in der Liste fest. Wenn das Aufzählungszeichen vom Typ "Custom" ist, ist charCode erforderlich.

setLevelBullet(level: number, listBulletString: "Custom" | "Solid" | "Hollow" | "Square" | "Diamonds" | "Arrow" | "Checkmark", charCode?: number, fontName?: string): void;

Parameter

level: number

Erforderlich. Die Ebene in der Liste.

listBulletString: "Custom" | "Solid" | "Hollow" | "Square" | "Diamonds" | "Arrow" | "Checkmark"

Erforderlich. Das Aufzählungszeichen.

charCode: number

Optional. Der Codewert des Aufzählungszeichens. Wird nur verwendet, wenn das Aufzählungszeichen "Benutzerdefiniert" ist.

fontName: string

Optional. Der Schriftartname des Aufzählungszeichens. Wird nur verwendet, wenn das Aufzählungszeichen "Benutzerdefiniert" ist.

Gibt zurück

void

Hinweise

[ API-Satz: WordApi 1.3 ]

setLevelIndents(level, textIndent, bulletNumberPictureIndent)

Legt die zwei Einzüge der angegebenen Ebene in der Liste fest.

setLevelIndents(level: number, textIndent: number, bulletNumberPictureIndent: number): void;

Parameter

level: number

Erforderlich. Die Ebene in der Liste.

textIndent: number

Erforderlich. Der Texteinzug in Punkt. Sie ist identisch mit absatzlinkem Einzug.

bulletNumberPictureIndent: number

Erforderlich. Der relative Einzug des Aufzählungszeichens, der Zahl oder des Bilds in Punkt. Er entspricht dem Absatzeinzug der ersten Zeile.

Gibt zurück

void

Hinweise

[ API-Satz: WordApi 1.3 ]

setLevelNumbering(level, listNumbering, formatString)

Legt das Nummerierungsformat auf der angegebenen Ebene in der Liste fest.

setLevelNumbering(level: number, listNumbering: Word.ListNumbering, formatString?: Array<string | number>): void;

Parameter

level: number

Erforderlich. Die Ebene in der Liste.

listNumbering: Word.ListNumbering

Erforderlich. Das Ordnungsformat.

formatString: Array<string | number>

Optional. Das Nummerierungszeichenfolgenformat, das als Array von Zeichenfolgen und/oder ganzen Zahlen definiert ist. Jede ganze Zahl ist eine Ebene des Zahlentyps, die höher oder gleich dieser Ebene ist. Beispielsweise kann ein Array von ["(", level - 1, ".", level, ")"] das Format von "(2.c)" definieren, wobei 2 die Elementnummer des übergeordneten Elements und c die Elementnummer dieser Ebene ist.

Gibt zurück

void

Hinweise

[ API-Satz: WordApi 1.3 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/organize-list.yaml

// Inserts a list starting with the first paragraph then set numbering and bullet types of the list items.
await Word.run(async (context) => {
  const paragraphs = context.document.body.paragraphs;
  paragraphs.load("$none");

  await context.sync();

  // Use the first paragraph to start a new list.
  const list = paragraphs.items[0].startNewList();
  list.load("$none");

  await context.sync();

  // To add new items to the list, use Start or End on the insertLocation parameter.
  list.insertParagraph("New list item at the start of the list", "Start");
  const paragraph = list.insertParagraph("New list item at the end of the list (set to list level 5)", "End");

  // Set numbering for list level 1.
  list.setLevelNumbering(0, Word.ListNumbering.arabic);

  // Set bullet type for list level 5.
  list.setLevelBullet(4, Word.ListBullet.arrow);

  // Set list level for the last item in this list.
  paragraph.listItem.level = 4;

  list.load("levelTypes");

  await context.sync();
});

setLevelNumbering(level, listNumberingString, formatString)

Legt das Nummerierungsformat auf der angegebenen Ebene in der Liste fest.

setLevelNumbering(level: number, listNumberingString: "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter", formatString?: Array<string | number>): void;

Parameter

level: number

Erforderlich. Die Ebene in der Liste.

listNumberingString: "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter"

Erforderlich. Das Ordnungsformat.

formatString: Array<string | number>

Gibt zurück

void

Hinweise

[ API-Satz: WordApi 1.3 ]

setLevelPicture(level, base64EncodedImage)

Hinweis

Legt das Bild auf der angegebenen Ebene in der Liste fest.

setLevelPicture(level: number, base64EncodedImage?: string): void;

Parameter

level: number

Erforderlich. Die Ebene in der Liste.

base64EncodedImage: string

Optional. Das festzulegende Base64-codierte Bild. Wenn nicht angegeben, wird das Standardbild festgelegt.

Gibt zurück

void

Hinweise

[ API-Satz: WordApi BETA (NUR VORSCHAU) ]

setLevelStartingNumber(level, startingNumber)

Legt die Anfangsnummer auf der angegebenen Ebene in der Liste fest. Der Standardwert ist 1.

setLevelStartingNumber(level: number, startingNumber: number): void;

Parameter

level: number

Erforderlich. Die Ebene in der Liste.

startingNumber: number

Erforderlich. Die Zahl, mit der sie beginnen soll.

Gibt zurück

void

Hinweise

[ API-Satz: WordApi 1.3 ]

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

toJSON(): Word.Interfaces.ListData;

Gibt zurück

Word.Interfaces.ListData

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

Gibt zurück

Word.List

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

Gibt zurück

Word.List