Word.ParagraphFormat class

Gibt die Ausrichtung für die angegebenen Absätze an.

alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";

Eigenschaftswert

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.`);
  }
});

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Gibt den Wert (in Punkt) für eine erste Zeile oder einen hängenden Einzug an. Verwenden Sie zum Festlegen eines Erstzeileneinzugs einen positiven Wert, und verwenden Sie für einen negativen Wert für einen hängenden Einzug.

firstLineIndent: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.5 ]

Gibt an, ob alle Zeilen in den angegebenen Absätzen auf derselben Seite verbleiben, wenn Microsoft Word das Dokument neu ausgestaltet.

keepTogether: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.5 ]

Gibt an, ob der angegebene Absatz auf derselben Seite wie der darauf folgende Absatz verbleibt, wenn Microsoft Word das Dokument neu ausgestaltet.

keepWithNext: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.5 ]

Gibt den linken Einzug an.

leftIndent: number;

Eigenschaftswert

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.`);
  }
});

Gibt den Zeilenabstand (in Punkt) für die angegebenen Absätze an.

lineSpacing: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.5 ]

Gibt den Abstand (in Gitternetzlinien) nach den angegebenen Absätzen an.

lineUnitAfter: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.5 ]

Gibt den Abstand (in Gitternetzlinien) vor den angegebenen Absätzen an.

lineUnitBefore: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.5 ]

Gibt an, ob linke und rechte Einzüge die gleiche Breite aufweisen.

mirrorIndents: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.5 ]

Gibt die Gliederungsebene für die angegebenen Absätze an.

outlineLevel: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText";

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.5 ]

Gibt den rechten Einzug (in Punkt) für die angegebenen Absätze an.

rightIndent: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.5 ]

Gibt den Abstand (in Punkt) nach dem angegebenen Absatz oder der angegebenen Textspalte an.

spaceAfter: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.5 ]

Gibt den Abstand (in Punkt) vor den angegebenen Absätzen an.

spaceBefore: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.5 ]

Gibt an, ob die erste und letzte Zeile im angegebenen Absatz auf derselben Seite wie der Rest des Absatzes verbleiben, wenn Microsoft Word das Dokument neu ausgestaltet.

widowControl: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.5 ]

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.ParagraphFormatLoadOptions): Word.ParagraphFormat;

Parameter

Gibt zurück

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

Parameter

Gibt zurück

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

Parameter

Gibt zurück

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

Parameter

Gibt zurück

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Word.ParagraphFormat): void;

Parameter

Gibt zurück

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

toJSON(): Word.Interfaces.ParagraphFormatData;

Gibt zurück

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

Gibt zurück

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

Gibt zurück