Word.List class

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

context: RequestContext;

Eigenschaftswert

Ruft die ID der Liste ab.

readonly id: number;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.3

Überprüft, ob jede der 9 Ebenen in der Liste vorhanden ist. true Gibt an, dass die Ebene vorhanden ist, d. h. es gibt mindestens ein Listenelement auf dieser Ebene.

readonly levelExistences: boolean[];

Eigenschaftswert

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: Word.ListCollection = 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: Word.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]}`);
  }
});

Ruft die Typen aller 9 Ebenen in der Liste ab. Jeder Typ kann ,number oderpicture seinbullet.

readonly levelTypes: Word.ListLevelType[];

Eigenschaftswert

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: Word.ListCollection = 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: Word.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]}`);
  }
});

Ruft die Absätze in der Liste ab.

readonly paragraphs: Word.ParagraphCollection;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.3

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

getLevelFont(level: number): Word.Font;

Parameter

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.1

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

getLevelParagraphs(level: number): Word.ParagraphCollection;

Parameter

Gibt zurück

Hinweise

API-Satz: WordApi 1.3

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

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.1

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

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApi 1.3

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

Gibt zurück

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: Word.ParagraphCollection = context.document.body.paragraphs;
  paragraphs.load("$none");

  await context.sync();

  // Start new list using the second paragraph.
  const list: Word.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: Word.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();
});

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

Gibt zurück

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

Gibt zurück

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

Gibt zurück

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

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.1

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

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApi 1.3

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

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApi 1.3

Legt das Format des Aufzählungszeichens auf der angegebenen Ebene in der Liste fest. Wenn die Aufzählungszeichen ist custom, ist das charCode erforderlich.

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

Parameter

Gibt zurück

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: Word.ParagraphCollection = context.document.body.paragraphs;
  paragraphs.load("$none");

  await context.sync();

  // Use the first paragraph to start a new list.
  const list: Word.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: Word.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();
});

Legt das Format des Aufzählungszeichens auf der angegebenen Ebene in der Liste fest. Wenn die Aufzählungszeichen ist custom, ist das charCode erforderlich.

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApi 1.3

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

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApi 1.3

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

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

Parameter

Gibt zurück

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: Word.ParagraphCollection = context.document.body.paragraphs;
  paragraphs.load("$none");

  await context.sync();

  // Use the first paragraph to start a new list.
  const list: Word.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: Word.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();
});

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

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApi 1.3

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

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.1

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

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApi 1.3

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

toJSON(): Word.Interfaces.ListData;

Gibt zurück

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

Gibt zurück

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

Gibt zurück