Word.ListFormat class
Stellt die Listenformatierungsmerkmale eines Bereichs dar.
- Extends
Hinweise
Verwendet von
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/format-list-range.yaml
// Gets the range covering the entire body and reads list formatting properties.
await Word.run(async (context) => {
const bodyRange: Word.Range = context.document.body.getRange();
const listFormat: Word.ListFormat = bodyRange.listFormat;
listFormat.load("isSingleList, listType, listLevelNumber, listString, listValue");
await context.sync();
console.log("List format info for the body range:");
console.log(`- Is single list: ${listFormat.isSingleList}`);
console.log(`- List type: ${listFormat.listType}`);
console.log(`- List level number (first paragraph): ${listFormat.listLevelNumber}`);
console.log(`- List string (first paragraph): "${listFormat.listString}"`);
console.log(`- List value (first paragraph): ${listFormat.listValue}`);
});
Eigenschaften
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| is |
Gibt an, ob das |
| is |
Gibt an, ob das |
| list | Gibt ein |
| list |
Gibt die Nummer der Listenebene für den ersten Absatz des |
| list |
Ruft die Zeichenfolgendarstellung des Listenwerts des ersten Absatzes im Bereich für das |
| list |
Ruft die Listenvorlage ab, die dem |
| list |
Ruft den Typ der Liste für das |
| list |
Ruft den numerischen Wert des ersten Absatzes im Bereich für das |
Methoden
| apply |
Fügt den Absätzen im Bereich Aufzählungszeichen und Formatierungen hinzu. |
| apply |
Fügt den Absätzen im Bereich Aufzählungszeichen und Formatierungen hinzu. |
| apply |
Wendet eine Listenvorlage mit einer bestimmten Ebene auf die Absätze im Bereich an. |
| apply |
Fügt den Absätzen im Bereich Nummerierung und Formatierung hinzu. |
| apply |
Fügt den Absätzen im Bereich Nummerierung und Formatierung hinzu. |
| apply |
Fügt den Absätzen im Bereich Gliederung, Nummerierung und Formatierung hinzu. |
| apply |
Fügt den Absätzen im Bereich Gliederung, Nummerierung und Formatierung hinzu. |
| can |
Bestimmt, ob das |
| convert |
Wandelt Zahlen in der Liste in Nur-Text um. |
| convert |
Wandelt Zahlen in der Liste in Nur-Text um. |
| count |
Zählt die nummerierten Elemente in der Liste. |
| list |
Rückt die Liste um eine Ebene ein. |
| list |
Stuft die Liste um eine Ebene 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 " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| remove |
Entfernt die Nummerierung aus der Liste. |
| remove |
Entfernt die Nummerierung aus der Liste. |
| 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 |
| 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 |
| 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 |
Details zur Eigenschaft
context
Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
isSingleList
Gibt an, ob das ListFormat Objekt eine einzelne Liste enthält.
readonly isSingleList: boolean;Eigenschaftswert
boolean
Hinweise
isSingleListTemplate
Gibt an, ob das ListFormat Objekt eine einzelne Listenvorlage enthält.
readonly isSingleListTemplate: boolean;Eigenschaftswert
boolean
Hinweise
list
Gibt ein List Objekt zurück, das die erste formatierte Liste darstellt, die ListFormat im Objekt enthalten ist.
readonly list: Word.List;Eigenschaftswert
Hinweise
listLevelNumber
Gibt die Nummer der Listenebene für den ersten Absatz des ListFormat Objekts an.
listLevelNumber: number;Eigenschaftswert
number
Hinweise
listString
Ruft die Zeichenfolgendarstellung des Listenwerts des ersten Absatzes im Bereich für das ListFormat Objekt ab.
readonly listString: string;Eigenschaftswert
string
Hinweise
listTemplate
Ruft die Listenvorlage ab, die dem ListFormat Objekt zugeordnet ist.
readonly listTemplate: Word.ListTemplate;Eigenschaftswert
Hinweise
listType
Ruft den Typ der Liste für das ListFormat Objekt ab.
readonly listType: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet";Eigenschaftswert
Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet"
Hinweise
listValue
Ruft den numerischen Wert des ersten Absatzes im Bereich für das ListFormat Objekt ab.
readonly listValue: number;Eigenschaftswert
number
Hinweise
Details zur Methode
applyBulletDefault(defaultListBehavior)
Fügt den Absätzen im Bereich Aufzählungszeichen und Formatierungen hinzu.
applyBulletDefault(defaultListBehavior: Word.DefaultListBehavior): void;Parameter
- defaultListBehavior
- Word.DefaultListBehavior
Optional. Gibt das Standardverhalten der Liste an. Der Standardwert ist word97.
Gibt zurück
void
Hinweise
applyBulletDefault(defaultListBehavior)
Fügt den Absätzen im Bereich Aufzählungszeichen und Formatierungen hinzu.
applyBulletDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void;Parameter
- defaultListBehavior
-
"Word97" | "Word2000" | "Word2002"
Optional. Gibt das Standardverhalten der Liste an. Der Standardwert ist word97.
Gibt zurück
void
Hinweise
applyListTemplateWithLevel(listTemplate, options)
Wendet eine Listenvorlage mit einer bestimmten Ebene auf die Absätze im Bereich an.
applyListTemplateWithLevel(listTemplate: Word.ListTemplate, options?: Word.ListTemplateApplyOptions): void;Parameter
- listTemplate
- Word.ListTemplate
Die anzuwendende Listenvorlage.
- options
- Word.ListTemplateApplyOptions
Optional. Optionen zum Anwenden der Listenvorlage, z. B. ob die vorherige Liste fortgesetzt werden soll oder auf welchen Teil der Liste die Vorlage angewendet werden soll.
Gibt zurück
void
Hinweise
applyNumberDefault(defaultListBehavior)
Fügt den Absätzen im Bereich Nummerierung und Formatierung hinzu.
applyNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void;Parameter
- defaultListBehavior
- Word.DefaultListBehavior
Optional. Gibt das Standardverhalten der Liste an.
Gibt zurück
void
Hinweise
applyNumberDefault(defaultListBehavior)
Fügt den Absätzen im Bereich Nummerierung und Formatierung hinzu.
applyNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void;Parameter
- defaultListBehavior
-
"Word97" | "Word2000" | "Word2002"
Optional. Gibt das Standardverhalten der Liste an.
Gibt zurück
void
Hinweise
applyOutlineNumberDefault(defaultListBehavior)
Fügt den Absätzen im Bereich Gliederung, Nummerierung und Formatierung hinzu.
applyOutlineNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void;Parameter
- defaultListBehavior
- Word.DefaultListBehavior
Optional. Gibt das Standardverhalten der Liste an.
Gibt zurück
void
Hinweise
applyOutlineNumberDefault(defaultListBehavior)
Fügt den Absätzen im Bereich Gliederung, Nummerierung und Formatierung hinzu.
applyOutlineNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void;Parameter
- defaultListBehavior
-
"Word97" | "Word2000" | "Word2002"
Optional. Gibt das Standardverhalten der Liste an.
Gibt zurück
void
Hinweise
canContinuePreviousList(listTemplate)
Bestimmt, ob das ListFormat Objekt eine vorherige Liste fortsetzen kann.
canContinuePreviousList(listTemplate: Word.ListTemplate): OfficeExtension.ClientResult<Word.Continue>;Parameter
- listTemplate
- Word.ListTemplate
Die zu überprüfende Listenvorlage.
Gibt zurück
Ein Continue Wert, der angibt, ob eine Fortsetzung möglich ist.
Hinweise
convertNumbersToText(numberType)
Wandelt Zahlen in der Liste in Nur-Text um.
convertNumbersToText(numberType: Word.NumberType): void;Parameter
- numberType
- Word.NumberType
Optional. Der Typ der zu konvertierenden Zahl.
Gibt zurück
void
Hinweise
convertNumbersToText(numberType)
Wandelt Zahlen in der Liste in Nur-Text um.
convertNumbersToText(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void;Parameter
- numberType
-
"Paragraph" | "ListNum" | "AllNumbers"
Optional. Der Typ der zu konvertierenden Zahl.
Gibt zurück
void
Hinweise
countNumberedItems(options)
Zählt die nummerierten Elemente in der Liste.
countNumberedItems(options?: Word.ListFormatCountNumberedItemsOptions): OfficeExtension.ClientResult<number>;Parameter
Optional. Optionen zum Zählen von nummerierten Elementen, z. B. der Nummerntyp und die zu zählende Ebene.
Gibt zurück
OfficeExtension.ClientResult<number>
Die Anzahl der Elemente.
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/format-list-range.yaml
// Counts all numbered items across every level using numberType: AllNumbers.
await Word.run(async (context) => {
const bodyRange: Word.Range = context.document.body.getRange();
const listFormat: Word.ListFormat = bodyRange.listFormat;
const options: Word.ListFormatCountNumberedItemsOptions = {
numberType: Word.NumberType.allNumbers,
};
const count: OfficeExtension.ClientResult<number> = listFormat.countNumberedItems(options);
await context.sync();
console.log(`Total numbered items (all levels): ${count.value}`);
});
listIndent()
Rückt die Liste um eine Ebene ein.
listIndent(): void;Gibt zurück
void
Hinweise
listOutdent()
Stuft die Liste um eine Ebene ein.
listOutdent(): void;Gibt zurück
void
Hinweise
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.ListFormatLoadOptions): Word.ListFormat;Parameter
Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.
Gibt zurück
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.ListFormat;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
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.ListFormat;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
removeNumbers(numberType)
Entfernt die Nummerierung aus der Liste.
removeNumbers(numberType: Word.NumberType): void;Parameter
- numberType
- Word.NumberType
Optional. Der Typ der zu entfernenden Nummer.
Gibt zurück
void
Hinweise
removeNumbers(numberType)
Entfernt die Nummerierung aus der Liste.
removeNumbers(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void;Parameter
- numberType
-
"Paragraph" | "ListNum" | "AllNumbers"
Optional. Der Typ der zu entfernenden Nummer.
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.ListFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- Word.Interfaces.ListFormatUpdateData
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
set(properties)
Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
set(properties: Word.ListFormat): void;Parameter
- properties
- Word.ListFormat
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 sie übergeben wird.) Während das ursprüngliche Word.ListFormat Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Word.Interfaces.ListFormatData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.
toJSON(): Word.Interfaces.ListFormatData;Gibt zurück
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.ListFormat;Gibt zurück
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.ListFormat;