Word.ListFormat class
Stellt die Listenformatierungsmerkmale eines Bereichs dar.
- Extends
Hinweise
Eigenschaften
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. 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 für das Objekt an |
| list |
Ruft die Zeichenfolgendarstellung des Listenwerts des ersten Absatzes im Bereich für das |
| list |
Ruft die dem |
| list |
Ruft den Typ der Liste für das -Objekt ab |
| 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 Gliederungsnummern und Formatierungen hinzu. |
| apply |
Fügt den Absätzen im Bereich Gliederungsnummern und Formatierungen hinzu. |
| can |
Bestimmt, ob das |
| convert |
Konvertiert Zahlen in der Liste in Nur-Text. |
| convert |
Konvertiert Zahlen in der Liste in Nur-Text. |
| count |
Zählt die nummerierten Elemente in der Liste. |
| list |
Schränkt die Liste um eine Ebene ein. |
| list |
Überrückt die Liste um eine Ebene. |
| 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 über |
| 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 |
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
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 für das Objekt an ListFormat .
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 dem ListFormat -Objekt zugeordnete Listenvorlage ab.
readonly listTemplate: Word.ListTemplate;Eigenschaftswert
Hinweise
listType
Ruft den Typ der Liste für das -Objekt ab ListFormat .
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 Standardlistenverhalten 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 Standardlistenverhalten 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 Standardlistenverhalten 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 Standardlistenverhalten an.
Gibt zurück
void
Hinweise
applyOutlineNumberDefault(defaultListBehavior)
Fügt den Absätzen im Bereich Gliederungsnummern und Formatierungen hinzu.
applyOutlineNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void;Parameter
- defaultListBehavior
- Word.DefaultListBehavior
Optional. Gibt das Standardlistenverhalten an.
Gibt zurück
void
Hinweise
applyOutlineNumberDefault(defaultListBehavior)
Fügt den Absätzen im Bereich Gliederungsnummern und Formatierungen hinzu.
applyOutlineNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void;Parameter
- defaultListBehavior
-
"Word97" | "Word2000" | "Word2002"
Optional. Gibt das Standardlistenverhalten 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)
Konvertiert Zahlen in der Liste in Nur-Text.
convertNumbersToText(numberType: Word.NumberType): void;Parameter
- numberType
- Word.NumberType
Optional. Der Typ der zu konvertierenden Zahl.
Gibt zurück
void
Hinweise
convertNumbersToText(numberType)
Konvertiert Zahlen in der Liste in Nur-Text.
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 nummerierter Elemente, z. B. der Typ der Zahl und die zu zählende Ebene.
Gibt zurück
OfficeExtension.ClientResult<number>
Die Anzahl der Elemente.
Hinweise
listIndent()
Schränkt die Liste um eine Ebene ein.
listIndent(): void;Gibt zurück
void
Hinweise
listOutdent()
Überrückt die Liste um eine Ebene.
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 dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
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 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
removeNumbers(numberType)
Entfernt die Nummerierung aus der Liste.
removeNumbers(numberType: Word.NumberType): void;Parameter
- numberType
- Word.NumberType
Optional. Der Typ der zu entfernenden Zahl.
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 Zahl.
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
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.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 das Objekt übergeben wird.) Während das ursprüngliche Word.ListFormat Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.ListFormatData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt 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 ü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.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 aufrufen context.sync() , bevor die Speicherfreigabe wirksam wird.
untrack(): Word.ListFormat;