Word.ParagraphFormat class

Spécifie l’alignement des paragraphes spécifiés.

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

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.5 ]

Exemples

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

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Spécifie la valeur (en points) d’une première ligne ou d’un retrait négatif. Utilisez une valeur positive pour définir un retrait de première ligne et utilisez une valeur négative pour définir un retrait négatif.

firstLineIndent: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.5 ]

Spécifie si toutes les lignes des paragraphes spécifiés restent sur la même page lorsque Microsoft Word repaginate le document.

keepTogether: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.5 ]

Spécifie si le paragraphe spécifié reste sur la même page que le paragraphe qui le suit lorsque Microsoft Word repaginate le document.

keepWithNext: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.5 ]

Spécifie le retrait gauche.

leftIndent: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.5 ]

Exemples

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

Spécifie l’espacement des lignes (en points) pour les paragraphes spécifiés.

lineSpacing: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.5 ]

Spécifie la quantité d’espacement (dans le quadrillage) après les paragraphes spécifiés.

lineUnitAfter: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.5 ]

Spécifie la quantité d’espacement (dans le quadrillage) avant les paragraphes spécifiés.

lineUnitBefore: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.5 ]

Spécifie si les retraits gauche et droit ont la même largeur.

mirrorIndents: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.5 ]

Spécifie le niveau hiérarchique des paragraphes spécifiés.

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

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.5 ]

Spécifie le retrait droit (en points) pour les paragraphes spécifiés.

rightIndent: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.5 ]

Spécifie la quantité d’espacement (en points) après le paragraphe ou la colonne de texte spécifié.

spaceAfter: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.5 ]

Spécifie l’espacement (en points) avant les paragraphes spécifiés.

spaceBefore: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.5 ]

Spécifie si les première et dernière lignes du paragraphe spécifié restent sur la même page que le reste du paragraphe lorsque Microsoft Word réagine le document.

widowControl: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.5 ]

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Word.Interfaces.ParagraphFormatLoadOptions): Word.ParagraphFormat;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Word.ParagraphFormat;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.ParagraphFormat;

Paramètres

Retours

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

set(properties: Interfaces.ParagraphFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

Retours

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Word.ParagraphFormat): void;

Paramètres

Retours

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Word.ParagraphFormat est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.ParagraphFormatDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Word.Interfaces.ParagraphFormatData;

Retours

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet sur des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run », et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivie lors de la première création de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

track(): Word.ParagraphFormat;

Retours

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la mise en production de la mémoire ne prenne effet.

untrack(): Word.ParagraphFormat;

Retours