Word.ParagraphFormat class

  • Référence
Paquet:
word

Représente un style de paragraphe dans un document.

Extends
OfficeExtension.ClientObject

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

Propriétés

alignment

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

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

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

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

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

Spécifie le retrait gauche.
lineSpacing

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

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

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

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

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

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

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

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

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.

Méthodes

load(options)

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)

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)

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.
set(properties, options)

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)

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

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

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.
untrack()

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.

Détails de la propriété

alignment

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

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

Valeur de propriété

Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"

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

context

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é

Word.RequestContext

firstLineIndent

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é

number

Remarques

[ Ensemble d’API : WordApi 1.5 ]

keepTogether

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é

boolean

Remarques

[ Ensemble d’API : WordApi 1.5 ]

keepWithNext

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é

boolean

Remarques

[ Ensemble d’API : WordApi 1.5 ]

leftIndent

Spécifie le retrait gauche.

leftIndent: number;

Valeur de propriété

number

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

lineSpacing

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

lineSpacing: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.5 ]

lineUnitAfter

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

lineUnitAfter: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.5 ]

lineUnitBefore

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

lineUnitBefore: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.5 ]

mirrorIndents

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

mirrorIndents: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi 1.5 ]

outlineLevel

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é

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

Remarques

[ Ensemble d’API : WordApi 1.5 ]

rightIndent

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

rightIndent: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.5 ]

spaceAfter

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é

number

Remarques

[ Ensemble d’API : WordApi 1.5 ]

spaceBefore

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

spaceBefore: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.5 ]

widowControl

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é

boolean

Remarques

[ Ensemble d’API : WordApi 1.5 ]

Détails de la méthode

load(options)

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

options
Word.Interfaces.ParagraphFormatLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Word.ParagraphFormat

load(propertyNames)

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

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.

Retours

Word.ParagraphFormat

load(propertyNamesAndPaths)

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

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

Word.ParagraphFormat

set(properties, options)

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

properties
Word.Interfaces.ParagraphFormatUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des propriétés de l’objet sur lequel la méthode est appelée.

options
OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet properties tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

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

properties
Word.ParagraphFormat

Retours

void

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que le Word d’origine. L’objet ParagraphFormat est un objet API. La toJSON méthode renvoie un objet JavaScript brut (tapé 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

Word.Interfaces.ParagraphFormatData

track()

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

Word.ParagraphFormat

untrack()

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

Word.ParagraphFormat