Word.Interfaces.StyleLoadOptions interface

Paket:

word

Stellt eine Formatvorlage in einem Word Dokument dar.

Hinweise

[ API-Satz: WordApi 1.3 ]

Eigenschaften

$all	Wenn Sie $all für die Ladeoptionen angeben, werden alle skalaren Eigenschaften (zRange.address. B. ) geladen, aber nicht die Navigationseigenschaften (zRange.format.fill.color. B. ).
baseStyle	Gibt den Namen einer vorhandenen Formatvorlage an, die als Basisformatierung einer anderen Formatvorlage verwendet werden soll.
borders	Gibt ein BorderCollection-Objekt an, das alle Rahmen für die angegebene Formatvorlage darstellt.
builtIn	Ruft ab, ob die angegebene Formatvorlage eine integrierte Formatvorlage ist.
description	Ruft die Beschreibung des angegebenen Stils ab.
font	Ruft ein Schriftartobjekt ab, das die Zeichenformatierung der angegebenen Formatvorlage darstellt.
inUse	Ruft ab, ob es sich bei der angegebenen Formatvorlage um eine integrierte Formatvorlage handelt, die im Dokument geändert oder angewendet wurde, oder um eine neue Formatvorlage, die im Dokument erstellt wurde.
linked	Ruft ab, ob eine Formatvorlage eine verknüpfte Formatvorlage ist, die sowohl für die Absatz- als auch für die Zeichenformatierung verwendet werden kann.
listTemplate	Ruft ein ListTemplate-Objekt ab, das die Listenformatierung für das angegebene Style-Objekt darstellt.
nameLocal	Ruft den Namen einer Formatvorlage in der Sprache des Benutzers ab.
nextParagraphStyle	Gibt den Namen der Formatvorlage an, die automatisch auf einen neuen Absatz angewendet werden soll, der nach einem Absatz eingefügt wird, der mit der angegebenen Formatvorlage formatiert ist.
paragraphFormat	Ruft ein ParagraphFormat-Objekt ab, das die Absatzeinstellungen für die angegebene Formatvorlage darstellt.
priority	Gibt die Priorität an.
quickStyle	Gibt an, ob die Formatvorlage einer verfügbaren Schnellformatvorlage entspricht.
shading	Ruft ein Shading-Objekt ab, das die Schattierung für die angegebene Formatvorlage darstellt. Gilt nicht für das Listenformat.
tableStyle	Ruft ein TableStyle-Objekt ab, das Style-Eigenschaften darstellt, die auf eine Tabelle angewendet werden können.
type	Ruft den Stiltyp ab.
unhideWhenUsed	Gibt an, ob die angegebene Formatvorlage als empfohlene Formatvorlage in den Formatvorlagen und im Aufgabenbereich Formatvorlagen in Microsoft Word sichtbar gemacht wird, nachdem sie im Dokument verwendet wurde.
visibility	Gibt an, ob die angegebene Formatvorlage als empfohlene Formatvorlage im Formatvorlagenkatalog und im Aufgabenbereich Formatvorlagen angezeigt wird.

Details zur Eigenschaft

$all

Wenn Sie $all für die Ladeoptionen angeben, werden alle skalaren Eigenschaften (zRange.address. B. ) geladen, aber nicht die Navigationseigenschaften (zRange.format.fill.color. B. ).

$all?: boolean;

Eigenschaftswert

boolean

baseStyle

Gibt den Namen einer vorhandenen Formatvorlage an, die als Basisformatierung einer anderen Formatvorlage verwendet werden soll.

baseStyle?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.5 ]

Hinweis: Die Möglichkeit zum Festlegen baseStyle wurde in WordApi 1.6 eingeführt.

borders

Gibt ein BorderCollection-Objekt an, das alle Rahmen für die angegebene Formatvorlage darstellt.

borders?: Word.Interfaces.BorderCollectionLoadOptions;

Eigenschaftswert

Word.Interfaces.BorderCollectionLoadOptions

Hinweise

[ API-Satz: WordApiDesktop 1.1 ]

builtIn

Ruft ab, ob die angegebene Formatvorlage eine integrierte Formatvorlage ist.

builtIn?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.5 ]

description

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 Beschreibung des angegebenen Stils ab.

description?: boolean;

Eigenschaftswert

boolean

Hinweise

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

font

Ruft ein Schriftartobjekt ab, das die Zeichenformatierung der angegebenen Formatvorlage darstellt.

font?: Word.Interfaces.FontLoadOptions;

Eigenschaftswert

Word.Interfaces.FontLoadOptions

Hinweise

[ API-Satz: WordApi 1.5 ]

inUse

Ruft ab, ob es sich bei der angegebenen Formatvorlage um eine integrierte Formatvorlage handelt, die im Dokument geändert oder angewendet wurde, oder um eine neue Formatvorlage, die im Dokument erstellt wurde.

inUse?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.5 ]

linked

Ruft ab, ob eine Formatvorlage eine verknüpfte Formatvorlage ist, die sowohl für die Absatz- als auch für die Zeichenformatierung verwendet werden kann.

linked?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.5 ]

listTemplate

Ruft ein ListTemplate-Objekt ab, das die Listenformatierung für das angegebene Style-Objekt darstellt.

listTemplate?: Word.Interfaces.ListTemplateLoadOptions;

Eigenschaftswert

Word.Interfaces.ListTemplateLoadOptions

Hinweise

[ API-Satz: WordApiDesktop 1.1 ]

nameLocal

Ruft den Namen einer Formatvorlage in der Sprache des Benutzers ab.

nameLocal?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.5 ]

nextParagraphStyle

Gibt den Namen der Formatvorlage an, die automatisch auf einen neuen Absatz angewendet werden soll, der nach einem Absatz eingefügt wird, der mit der angegebenen Formatvorlage formatiert ist.

nextParagraphStyle?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.5 ]

Hinweis: Die Möglichkeit zum Festlegen nextParagraphStyle wurde in WordApi 1.6 eingeführt.

paragraphFormat

Ruft ein ParagraphFormat-Objekt ab, das die Absatzeinstellungen für die angegebene Formatvorlage darstellt.

paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions;

Eigenschaftswert

Word.Interfaces.ParagraphFormatLoadOptions

Hinweise

[ API-Satz: WordApi 1.5 ]

priority

Gibt die Priorität an.

priority?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.5 ]

quickStyle

Gibt an, ob die Formatvorlage einer verfügbaren Schnellformatvorlage entspricht.

quickStyle?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.5 ]

shading

Ruft ein Shading-Objekt ab, das die Schattierung für die angegebene Formatvorlage darstellt. Gilt nicht für das Listenformat.

shading?: Word.Interfaces.ShadingLoadOptions;

Eigenschaftswert

Word.Interfaces.ShadingLoadOptions

Hinweise

[ API-Satz: WordApi 1.6 ]

tableStyle

Ruft ein TableStyle-Objekt ab, das Style-Eigenschaften darstellt, die auf eine Tabelle angewendet werden können.

tableStyle?: Word.Interfaces.TableStyleLoadOptions;

Eigenschaftswert

Word.Interfaces.TableStyleLoadOptions

Hinweise

[ API-Satz: WordApi 1.6 ]

type

Ruft den Stiltyp ab.

type?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.5 ]

unhideWhenUsed

Gibt an, ob die angegebene Formatvorlage als empfohlene Formatvorlage in den Formatvorlagen und im Aufgabenbereich Formatvorlagen in Microsoft Word sichtbar gemacht wird, nachdem sie im Dokument verwendet wurde.

unhideWhenUsed?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.5 ]

visibility

Gibt an, ob die angegebene Formatvorlage als empfohlene Formatvorlage im Formatvorlagenkatalog und im Aufgabenbereich Formatvorlagen angezeigt wird.

visibility?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.5 ]