Partager via

Word.Style class

  • Référence
Paquet:
word

Représente un style dans un document Word.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Exemples

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

Propriétés

baseStyle

Spécifie le nom d’un style existant à utiliser comme mise en forme de base d’un autre style.
borders

Spécifie un objet BorderCollection qui représente toutes les bordures du style spécifié.
builtIn

Obtient si le style spécifié est un style intégré.
context

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

Obtient la description du style spécifié.
font

Obtient un objet de police qui représente la mise en forme des caractères du style spécifié.
inUse

Obtient si le style spécifié est un style intégré qui a été modifié ou appliqué dans le document ou un nouveau style qui a été créé dans le document.
linked

Obtient si un style est un style lié qui peut être utilisé pour la mise en forme des paragraphes et des caractères.
listTemplate

Obtient un objet ListTemplate qui représente la mise en forme de liste pour l’objet Style spécifié.
nameLocal

Obtient le nom d’un style dans la langue de l’utilisateur.
nextParagraphStyle

Spécifie le nom du style à appliquer automatiquement à un nouveau paragraphe inséré après un paragraphe mis en forme avec le style spécifié.
paragraphFormat

Obtient un objet ParagraphFormat qui représente les paramètres de paragraphe pour le style spécifié.
priority

Spécifie la priorité.
quickStyle

Spécifie si le style correspond à un style rapide disponible.
shading

Obtient un objet Shading qui représente l’ombrage du style spécifié. Non applicable au style Liste.
tableStyle

Obtient un objet TableStyle représentant les propriétés Style qui peuvent être appliquées à un tableau.
type

Obtient le type de style.
unhideWhenUsed

Spécifie si le style spécifié est rendu visible en tant que style recommandé dans les styles et dans le volet Office Styles de Microsoft Word après son utilisation dans le document.
visibility

Spécifie si le style spécifié est visible en tant que style recommandé dans la galerie Styles et dans le volet Office Styles.

Méthodes

delete()

Supprime le style.
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.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Word.Style est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.StyleDataque ) 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é

baseStyle

Spécifie le nom d’un style existant à utiliser comme mise en forme de base d’un autre style.

baseStyle: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.5 ]

Remarque : La possibilité de définir baseStyle a été introduite dans WordApi 1.6.

borders

Spécifie un objet BorderCollection qui représente toutes les bordures du style spécifié.

readonly borders: Word.BorderCollection;

Valeur de propriété

Word.BorderCollection

Remarques

[ Ensemble d’API : WordApiDesktop 1.1 ]

Exemples

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

// Updates border properties (e.g., type, width, color) 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 border 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 borders: Word.BorderCollection = style.borders;
    borders.load("items");
    await context.sync();

    borders.outsideBorderType = Word.BorderType.dashed;
    borders.outsideBorderWidth = Word.BorderWidth.pt025;
    borders.outsideBorderColor = "green";
    console.log("Updated outside borders.");
  }
});

builtIn

Obtient si le style spécifié est un style intégré.

readonly builtIn: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi 1.5 ]

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

description

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Obtient la description du style spécifié.

readonly description: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi BETA (PRÉVERSION UNIQUEMENT) ]

font

Obtient un objet de police qui représente la mise en forme des caractères du style spécifié.

readonly font: Word.Font;

Valeur de propriété

Word.Font

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

// 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

Obtient si le style spécifié est un style intégré qui a été modifié ou appliqué dans le document ou un nouveau style qui a été créé dans le document.

readonly inUse: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi 1.5 ]

linked

Obtient si un style est un style lié qui peut être utilisé pour la mise en forme des paragraphes et des caractères.

readonly linked: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi 1.5 ]

listTemplate

Obtient un objet ListTemplate qui représente la mise en forme de liste pour l’objet Style spécifié.

readonly listTemplate: Word.ListTemplate;

Valeur de propriété

Word.ListTemplate

Remarques

[ Ensemble d’API : WordApiDesktop 1.1 ]

Exemples

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

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

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

  if (style.isNullObject || style.type != Word.StyleType.list) {
    console.warn(`There's no existing style with the name '${styleName}'. Or this isn't a list style.`);
  } else {
    // Load objects to log properties and their values in the console.
    style.load();
    style.listTemplate.load();
    await context.sync();

    console.log(`Properties of the '${styleName}' style:`, style);

    const listLevels = style.listTemplate.listLevels;
    listLevels.load("items");
    await context.sync();

    console.log(`List levels of the '${styleName}' style:`, listLevels);
  }
});

nameLocal

Obtient le nom d’un style dans la langue de l’utilisateur.

readonly nameLocal: string;

Valeur de propriété

string

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

// 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

Spécifie le nom du style à appliquer automatiquement à un nouveau paragraphe inséré après un paragraphe mis en forme avec le style spécifié.

nextParagraphStyle: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.5 ]

Remarque : La possibilité de définir nextParagraphStyle a été introduite dans WordApi 1.6.

paragraphFormat

Obtient un objet ParagraphFormat qui représente les paramètres de paragraphe pour le style spécifié.

readonly paragraphFormat: Word.ParagraphFormat;

Valeur de propriété

Word.ParagraphFormat

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

priority

Spécifie la priorité.

priority: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.5 ]

quickStyle

Spécifie si le style correspond à un style rapide disponible.

quickStyle: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi 1.5 ]

shading

Obtient un objet Shading qui représente l’ombrage du style spécifié. Non applicable au style Liste.

readonly shading: Word.Shading;

Valeur de propriété

Word.Shading

Remarques

[ Ensemble d’API : WordApi 1.6 ]

Exemples

// 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

Obtient un objet TableStyle représentant les propriétés Style qui peuvent être appliquées à un tableau.

readonly tableStyle: Word.TableStyle;

Valeur de propriété

Word.TableStyle

Remarques

[ Ensemble d’API : WordApi 1.6 ]

type

Obtient le type de style.

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

Valeur de propriété

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

Remarques

[ Ensemble d’API : WordApi 1.5 ]

unhideWhenUsed

Spécifie si le style spécifié est rendu visible en tant que style recommandé dans les styles et dans le volet Office Styles de Microsoft Word après son utilisation dans le document.

unhideWhenUsed: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi 1.5 ]

visibility

Spécifie si le style spécifié est visible en tant que style recommandé dans la galerie Styles et dans le volet Office Styles.

visibility: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi 1.5 ]

Détails de la méthode

delete()

Supprime le style.

delete(): void;

Retours

void

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

// 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)

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

Paramètres

options
Word.Interfaces.StyleLoadOptions

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

Retours

Word.Style

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

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

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

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

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

Paramètres

properties
Word.Interfaces.StyleUpdateData

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

Paramètres

properties
Word.Style

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.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Word.Style est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.StyleDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Word.Interfaces.StyleData;

Retours

Word.Interfaces.StyleData

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

Retours

Word.Style

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

Retours

Word.Style