Word.ListItem class

Paket:

word

Stellt das Absatzlistenelementformat dar.

Extends

OfficeExtension.ClientObject

Hinweise

[ API-Satz: WordApi 1.3 ]

Eigenschaften

context	Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
level	Gibt die Ebene des Elements in der Liste an.
listString	Ruft das Aufzählungszeichen, die Zahl oder das Bild des Listenelements als Zeichenfolge ab.
siblingIndex	Ruft die Ordnungsnummer des Listenelements im Verhältnis zu seinen gleichgeordneten Elementen ab.

Methoden

getAncestor(parentOnly)	Ruft das übergeordnete Listenelement oder den nächstgelegenen Vorgänger ab, wenn das übergeordnete Element nicht vorhanden ist. Löst einen Fehler aus ItemNotFound , wenn das Listenelement keinen Vorgänger aufweist.
getAncestorOrNullObject(parentOnly)	Ruft das übergeordnete Listenelement oder den nächstgelegenen Vorgänger ab, wenn das übergeordnete Element nicht vorhanden ist. Wenn das Listenelement keinen Vorgänger aufweist, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getDescendants(directChildrenOnly)	Ruft alle untergeordneten Listenelemente des Listenelements ab.
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.
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.) Die ursprüngliche Word. Das ListItem-Objekt ist ein API-Objekt. Die toJSON Methode gibt ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.ListItemData) 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

level

Gibt die Ebene des Elements in der Liste an.

level: number;

Eigenschaftswert

number

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

listString

Ruft das Aufzählungszeichen, die Zahl oder das Bild des Listenelements als Zeichenfolge ab.

readonly listString: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApi 1.3 ]

siblingIndex

Ruft die Ordnungsnummer des Listenelements im Verhältnis zu seinen gleichgeordneten Elementen ab.

readonly siblingIndex: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApi 1.3 ]

Details zur Methode

getAncestor(parentOnly)

Ruft das übergeordnete Listenelement oder den nächstgelegenen Vorgänger ab, wenn das übergeordnete Element nicht vorhanden ist. Löst einen Fehler aus ItemNotFound , wenn das Listenelement keinen Vorgänger aufweist.

getAncestor(parentOnly?: boolean): Word.Paragraph;

Parameter

parentOnly

boolean

Optional. Gibt an, dass nur das übergeordnete Element des Listenelements zurückgegeben wird. Der Standardwert ist false, der angibt, dass der niedrigste Vorgänger abgerufen werden soll.

Gibt zurück

Word.Paragraph

Hinweise

[ API-Satz: WordApi 1.3 ]

getAncestorOrNullObject(parentOnly)

Ruft das übergeordnete Listenelement oder den nächstgelegenen Vorgänger ab, wenn das übergeordnete Element nicht vorhanden ist. Wenn das Listenelement keinen Vorgänger aufweist, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getAncestorOrNullObject(parentOnly?: boolean): Word.Paragraph;

Parameter

parentOnly

boolean

Optional. Gibt an, dass nur das übergeordnete Element des Listenelements zurückgegeben wird. Der Standardwert ist false, der angibt, dass der niedrigste Vorgänger abgerufen werden soll.

Gibt zurück

Word.Paragraph

Hinweise

[ API-Satz: WordApi 1.3 ]

getDescendants(directChildrenOnly)

Ruft alle untergeordneten Listenelemente des Listenelements ab.

getDescendants(directChildrenOnly?: boolean): Word.ParagraphCollection;

Parameter

directChildrenOnly

boolean

Optional. Gibt an, dass nur die direkten untergeordneten Elemente des Listenelements zurückgegeben werden. Der Standardwert ist false und gibt an, dass alle nachfolgerfähigen Elemente abgerufen werden sollen.

Gibt zurück

Word.ParagraphCollection

Hinweise

[ API-Satz: WordApi 1.3 ]

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.ListItemLoadOptions): Word.ListItem;

Parameter

options

Word.Interfaces.ListItemLoadOptions

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

Gibt zurück

Word.ListItem

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

Parameter

propertyNames

string | string[]

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

Gibt zurück

Word.ListItem

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

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

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

Parameter

properties

Word.Interfaces.ListItemUpdateData

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

Parameter

properties

Word.ListItem

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

toJSON(): Word.Interfaces.ListItemData;

Gibt zurück

Word.Interfaces.ListItemData

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

Gibt zurück

Word.ListItem

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

Gibt zurück

Word.ListItem