Freigeben über

Word.Style class

  • Referenz
Paket:
word

Stellt eine Formatvorlage in einem Word Dokument dar.

Extends
OfficeExtension.ClientObject

Hinweise

[ API-Satz: WordApi 1.3 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-styles.yaml

// Applies the specified style to a paragraph.
await Word.run(async (context) => {
  const styleName = $("#style-name-to-use").val() as string;
  if (styleName == "") {
    console.warn("Enter a style name to apply.");
    return;
  }

  const style: Word.Style = context.document.getStyles().getByNameOrNullObject(styleName);
  style.load();
  await context.sync();

  if (style.isNullObject) {
    console.warn(`There's no existing style with the name '${styleName}'.`);
  } else if (style.type != Word.StyleType.paragraph) {
    console.log(`The '${styleName}' style isn't a paragraph style.`);
  } else {
    const body: Word.Body = context.document.body;
    body.clear();
    body.insertParagraph(
      "Do you want to create a solution that extends the functionality of Word? You can use the Office Add-ins platform to extend Word clients running on the web, on a Windows desktop, or on a Mac.",
      "Start"
    );
    const paragraph: Word.Paragraph = body.paragraphs.getFirst();
    paragraph.style = style.nameLocal;
    console.log(`'${styleName}' style applied to first paragraph.`);
  }
});

Eigenschaften

baseStyle

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

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

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
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.
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.

Methoden

delete()

Löscht die Formatvorlage.
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.) Während das ursprüngliche Word.Style Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.StyleData) 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

baseStyle

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

baseStyle: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApi 1.5 ]

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

builtIn

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

readonly builtIn: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.5 ]

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

font

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

readonly font: Word.Font;

Eigenschaftswert

Word.Font

Hinweise

[ API-Satz: WordApi 1.5 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-styles.yaml

// Updates font properties (e.g., color, size) of the specified style.
await Word.run(async (context) => {
  const styleName = $("#style-name").val() as string;
  if (styleName == "") {
    console.warn("Enter a style name to update font properties.");
    return;
  }

  const style: Word.Style = context.document.getStyles().getByNameOrNullObject(styleName);
  style.load();
  await context.sync();

  if (style.isNullObject) {
    console.warn(`There's no existing style with the name '${styleName}'.`);
  } else {
    const font: Word.Font = style.font;
    font.color = "#FF0000";
    font.size = 20;
    console.log(`Successfully updated font properties of the '${styleName}' style.`);
  }
});

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.

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

readonly linked: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.5 ]

nameLocal

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

readonly nameLocal: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApi 1.5 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-styles.yaml

// Applies the specified style to a paragraph.
await Word.run(async (context) => {
  const styleName = $("#style-name-to-use").val() as string;
  if (styleName == "") {
    console.warn("Enter a style name to apply.");
    return;
  }

  const style: Word.Style = context.document.getStyles().getByNameOrNullObject(styleName);
  style.load();
  await context.sync();

  if (style.isNullObject) {
    console.warn(`There's no existing style with the name '${styleName}'.`);
  } else if (style.type != Word.StyleType.paragraph) {
    console.log(`The '${styleName}' style isn't a paragraph style.`);
  } else {
    const body: Word.Body = context.document.body;
    body.clear();
    body.insertParagraph(
      "Do you want to create a solution that extends the functionality of Word? You can use the Office Add-ins platform to extend Word clients running on the web, on a Windows desktop, or on a Mac.",
      "Start"
    );
    const paragraph: Word.Paragraph = body.paragraphs.getFirst();
    paragraph.style = style.nameLocal;
    console.log(`'${styleName}' style applied to first paragraph.`);
  }
});

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: string;

Eigenschaftswert

string

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.

readonly paragraphFormat: Word.ParagraphFormat;

Eigenschaftswert

Word.ParagraphFormat

Hinweise

[ API-Satz: WordApi 1.5 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-styles.yaml

// Sets certain aspects of the specified style's paragraph format e.g., the left indent size and the alignment.
await Word.run(async (context) => {
  const styleName = $("#style-name").val() as string;
  if (styleName == "") {
    console.warn("Enter a style name to update its paragraph format.");
    return;
  }

  const style: Word.Style = context.document.getStyles().getByNameOrNullObject(styleName);
  style.load();
  await context.sync();

  if (style.isNullObject) {
    console.warn(`There's no existing style with the name '${styleName}'.`);
  } else {
    style.paragraphFormat.leftIndent = 30;
    style.paragraphFormat.alignment = Word.Alignment.centered;
    console.log(`Successfully the paragraph format of the '${styleName}' style.`);
  }
});

priority

Gibt die Priorität an.

priority: number;

Eigenschaftswert

number

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.

readonly shading: Word.Shading;

Eigenschaftswert

Word.Shading

Hinweise

[ API-Satz: WordApi 1.6 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-styles.yaml

// Updates shading properties (e.g., texture, pattern colors) of the specified style.
await Word.run(async (context) => {
  const styleName = $("#style-name").val() as string;
  if (styleName == "") {
    console.warn("Enter a style name to update shading properties.");
    return;
  }

  const style: Word.Style = context.document.getStyles().getByNameOrNullObject(styleName);
  style.load();
  await context.sync();

  if (style.isNullObject) {
    console.warn(`There's no existing style with the name '${styleName}'.`);
  } else {
    const shading: Word.Shading = style.shading;
    shading.load();
    await context.sync();

    shading.backgroundPatternColor = "blue";
    shading.foregroundPatternColor = "yellow";
    shading.texture = Word.ShadingTextureType.darkTrellis;

    console.log("Updated shading.");
  }
});

tableStyle

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

readonly tableStyle: Word.TableStyle;

Eigenschaftswert

Word.TableStyle

Hinweise

[ API-Satz: WordApi 1.6 ]

type

Ruft den Stiltyp ab.

readonly type: Word.StyleType | "Character" | "List" | "Paragraph" | "Table";

Eigenschaftswert

Word.StyleType | "Character" | "List" | "Paragraph" | "Table"

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 ]

Details zur Methode

delete()

Löscht die Formatvorlage.

delete(): void;

Gibt zurück

void

Hinweise

[ API-Satz: WordApi 1.5 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-styles.yaml

// Deletes the custom style.
await Word.run(async (context) => {
  const styleName = $("#style-name-to-delete").val() as string;
  if (styleName == "") {
    console.warn("Enter a style name to delete.");
    return;
  }

  const style: Word.Style = context.document.getStyles().getByNameOrNullObject(styleName);
  style.load();
  await context.sync();

  if (style.isNullObject) {
    console.warn(`There's no existing style with the name '${styleName}'.`);
  } else {
    style.delete();
    console.log(`Successfully deleted custom style '${styleName}'.`);
  }
});

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.StyleLoadOptions): Word.Style;

Parameter

options
Word.Interfaces.StyleLoadOptions

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

Gibt zurück

Word.Style

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

Parameter

propertyNames

string | string[]

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

Gibt zurück

Word.Style

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

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

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

Parameter

properties
Word.Interfaces.StyleUpdateData

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

Parameter

properties
Word.Style

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

toJSON(): Word.Interfaces.StyleData;

Gibt zurück

Word.Interfaces.StyleData

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

Gibt zurück

Word.Style

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

Gibt zurück

Word.Style