Excel.Style class

Objet encapsulant le format d’un style et d’autres propriétés.

[Ensemble d’API : ExcelApi 1.7]

Extends

Propriétés

autoIndent

Spécifie si le texte est automatiquement mis en retrait lorsque l’alignement du texte dans une cellule est égal à la distribution.

[Ensemble d’API : ExcelApi 1.8]

borders

Collection de quatre objets de bordure qui représentent le style des quatre bordures.

[Ensemble d’API : ExcelApi 1.7]

builtIn

Spécifie si le style est un style intégré.

[Ensemble d’API : ExcelApi 1.7]

context

Contexte de demande associé à l’objet. Cela connecte le processus du add-in au processus de l’application hôte Office.

fill

Remplissage du style.

[Ensemble d’API : ExcelApi 1.7]

font

Objet Font qui représente la police du style.

[Ensemble d’API : ExcelApi 1.7]

formulaHidden

Spécifie si la formule est masquée lorsque la feuille de calcul est protégée.

[Ensemble d’API : ExcelApi 1.7]

horizontalAlignment

Représente l’alignement horizontal pour le style. Pour Excel.HorizontalAlignment plus d’informations, voir.

[Ensemble d’API : ExcelApi 1.7]

includeAlignment

Spécifie si le style inclut le retrait automatique, l’alignement horizontal, l’alignement vertical, le texte de wrap, le niveau de retrait et les propriétés d’orientation du texte.

[Ensemble d’API : ExcelApi 1.7]

includeBorder

Indique si le style inclut les propriétés de couleur, d’index de couleur, de style de trait et de bordure de poids.

[Ensemble d’API : ExcelApi 1.7]

includeFont

Spécifie si le style inclut les propriétés d’arrière-plan, de gras, de couleur, d’index de couleur, de style de police, d’italique, de nom, de taille, de strikethrough, d’indice, d’exposant et de soulignement de police.

[Ensemble d’API : ExcelApi 1.7]

includeNumber

Spécifie si le style inclut la propriété de format numérique.

[Ensemble d’API : ExcelApi 1.7]

includePatterns

Spécifie si le style inclut les propriétés de couleur, d’index de couleur, d’inversion si négatif, de motif, de couleur de motif et d’index de couleur de motif.

[Ensemble d’API : ExcelApi 1.7]

includeProtection

Spécifie si le style inclut les propriétés de protection masquées et verrouillées de la formule.

[Ensemble d’API : ExcelApi 1.7]

indentLevel

Entier compris entre 0 à 250 qui indique le niveau de retrait du style.

[Ensemble d’API : ExcelApi 1.7]

locked

Spécifie si l’objet est verrouillé lorsque la feuille de calcul est protégée.

[Ensemble d’API : ExcelApi 1.7]

name

Nom du style.

[Ensemble d’API : ExcelApi 1.7]

numberFormat

Le code de format du nombre format pour le style.

[Ensemble d’API : ExcelApi 1.7]

numberFormatLocal

Le code de format localisé du nombre format pour le style.

[Ensemble d’API : ExcelApi 1.7]

readingOrder

L’ordre de lecture du style.

[Ensemble d’API : ExcelApi 1.7]

shrinkToFit

Spécifie si le texte est automatiquement réduit pour tenir dans la largeur de colonne disponible.

[Ensemble d’API : ExcelApi 1.7]

textOrientation

L’orientation du texte pour le style.

[Ensemble d’API : ExcelApi 1.8]

verticalAlignment

Spécifie l’alignement vertical du style. Pour Excel.VerticalAlignment plus d’informations, voir.

[Ensemble d’API : ExcelApi 1.7]

wrapText

Spécifie si Excel encapsule le texte dans l’objet.

[Ensemble d’API : ExcelApi 1.7]

Méthodes

delete()

Supprime ce style.

[Ensemble d’API : ExcelApi 1.7]

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 transmettre un objet simple avec les propriétés appropriées ou un autre objet API du même type.

set(properties)

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

toJSON()

Remplace la méthode JavaScript afin de fournir une sortie plus utile lorsqu’un objet toJSON() API est transmis à JSON.stringify(). (JSON.stringify, à son tour, appelle toJSON la méthode de l’objet qui lui est transmis.) Alors que l’objet Excel.Style d’origine est un objet API, la méthode renvoie un objet toJSON JavaScript simple (tapé sous la forme Excel.Interfaces.StyleData) qui contient des copies superficiels de toutes les propriétés enfants chargées à partir de l’objet d’origine.

Détails de la propriété

autoIndent

Spécifie si le texte est automatiquement mis en retrait lorsque l’alignement du texte dans une cellule est égal à la distribution.

[Ensemble d’API : ExcelApi 1.8]

autoIndent: boolean;

Valeur de propriété

boolean

borders

Collection de quatre objets de bordure qui représentent le style des quatre bordures.

[Ensemble d’API : ExcelApi 1.7]

readonly borders: Excel.RangeBorderCollection;

Valeur de propriété

builtIn

Spécifie si le style est un style intégré.

[Ensemble d’API : ExcelApi 1.7]

readonly builtIn: boolean;

Valeur de propriété

boolean

context

Contexte de demande associé à l’objet. Cela connecte le processus du add-in au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

fill

Remplissage du style.

[Ensemble d’API : ExcelApi 1.7]

readonly fill: Excel.RangeFill;

Valeur de propriété

font

Objet Font qui représente la police du style.

[Ensemble d’API : ExcelApi 1.7]

readonly font: Excel.RangeFont;

Valeur de propriété

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml
await Excel.run(async (context) => {
    let style = context.workbook.styles.getItem("Normal");
    style.font.load("bold, color, italic, name, size");
    style.fill.load("color");

    await context.sync();

    console.log("Bold: " + style.font.bold);
    console.log("Font color: " + style.font.color);
    console.log("Italic: " + style.font.italic);
    console.log("Name: " + style.font.name);
    console.log("Size: " + style.font.size);
    console.log("Fill color: " + style.fill.color);
});

formulaHidden

Spécifie si la formule est masquée lorsque la feuille de calcul est protégée.

[Ensemble d’API : ExcelApi 1.7]

formulaHidden: boolean;

Valeur de propriété

boolean

horizontalAlignment

Représente l’alignement horizontal pour le style. Pour Excel.HorizontalAlignment plus d’informations, voir.

[Ensemble d’API : ExcelApi 1.7]

horizontalAlignment: Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed";

Valeur de propriété

Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed"

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml
await Excel.run(async (context) => {
    let worksheet = context.workbook.worksheets.getItem("Sample");
    let range = worksheet.getRange("A1:E1");

    // Apply built-in style. 
    // Styles are in the Home tab ribbon.
    range.style = Excel.BuiltInStyle.neutral;
    range.format.horizontalAlignment = "Right";

    await context.sync();
});

includeAlignment

Spécifie si le style inclut le retrait automatique, l’alignement horizontal, l’alignement vertical, le texte de wrap, le niveau de retrait et les propriétés d’orientation du texte.

[Ensemble d’API : ExcelApi 1.7]

includeAlignment: boolean;

Valeur de propriété

boolean

includeBorder

Indique si le style inclut les propriétés de couleur, d’index de couleur, de style de trait et de bordure de poids.

[Ensemble d’API : ExcelApi 1.7]

includeBorder: boolean;

Valeur de propriété

boolean

includeFont

Spécifie si le style inclut les propriétés d’arrière-plan, de gras, de couleur, d’index de couleur, de style de police, d’italique, de nom, de taille, de strikethrough, d’indice, d’exposant et de soulignement de police.

[Ensemble d’API : ExcelApi 1.7]

includeFont: boolean;

Valeur de propriété

boolean

includeNumber

Spécifie si le style inclut la propriété de format numérique.

[Ensemble d’API : ExcelApi 1.7]

includeNumber: boolean;

Valeur de propriété

boolean

includePatterns

Spécifie si le style inclut les propriétés de couleur, d’index de couleur, d’inversion si négatif, de motif, de couleur de motif et d’index de couleur de motif.

[Ensemble d’API : ExcelApi 1.7]

includePatterns: boolean;

Valeur de propriété

boolean

includeProtection

Spécifie si le style inclut les propriétés de protection masquées et verrouillées de la formule.

[Ensemble d’API : ExcelApi 1.7]

includeProtection: boolean;

Valeur de propriété

boolean

indentLevel

Entier compris entre 0 à 250 qui indique le niveau de retrait du style.

[Ensemble d’API : ExcelApi 1.7]

indentLevel: number;

Valeur de propriété

number

locked

Spécifie si l’objet est verrouillé lorsque la feuille de calcul est protégée.

[Ensemble d’API : ExcelApi 1.7]

locked: boolean;

Valeur de propriété

boolean

name

Nom du style.

[Ensemble d’API : ExcelApi 1.7]

readonly name: string;

Valeur de propriété

string

numberFormat

Le code de format du nombre format pour le style.

[Ensemble d’API : ExcelApi 1.7]

numberFormat: string;

Valeur de propriété

string

numberFormatLocal

Le code de format localisé du nombre format pour le style.

[Ensemble d’API : ExcelApi 1.7]

numberFormatLocal: string;

Valeur de propriété

string

readingOrder

L’ordre de lecture du style.

[Ensemble d’API : ExcelApi 1.7]

readingOrder: Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft";

Valeur de propriété

Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft"

shrinkToFit

Spécifie si le texte est automatiquement réduit pour tenir dans la largeur de colonne disponible.

[Ensemble d’API : ExcelApi 1.7]

shrinkToFit: boolean;

Valeur de propriété

boolean

textOrientation

L’orientation du texte pour le style.

[Ensemble d’API : ExcelApi 1.8]

textOrientation: number;

Valeur de propriété

number

verticalAlignment

Spécifie l’alignement vertical du style. Pour Excel.VerticalAlignment plus d’informations, voir.

[Ensemble d’API : ExcelApi 1.7]

verticalAlignment: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed";

Valeur de propriété

Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed"

wrapText

Spécifie si Excel encapsule le texte dans l’objet.

[Ensemble d’API : ExcelApi 1.7]

wrapText: boolean;

Valeur de propriété

boolean

Détails de la méthode

delete()

Supprime ce style.

[Ensemble d’API : ExcelApi 1.7]

delete(): void;

Retours

void

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml
await Excel.run(async (context) => {
    let style = context.workbook.styles.getItem("Diagonal Orientation Style");

    // Delete the diagonal orientation style from the style collection.
    // Styles are in the Home tab ribbon.
    style.delete();

    await context.sync();

    console.log("Successfully deleted the diagonal orientation style from the Home tab ribbon.");
});

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?: Excel.Interfaces.StyleLoadOptions): Excel.Style;

Paramètres

options
Excel.Interfaces.StyleLoadOptions

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

Retours

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml
await Excel.run(async (context) => {
    let style = context.workbook.styles.getItem("Diagonal Orientation Style");            
    style.load("textOrientation, horizontalAlignment, autoIndent, readingOrder, wrapText, includeProtection, shrinkToFit, locked");

    await context.sync();

    console.log("Orientation: " + style.textOrientation);
    console.log("Horizontal alignment: " + style.horizontalAlignment);
    console.log("Add indent: " + style.autoIndent);
    console.log("Reading order: " + style.readingOrder);
    console.log("Wrap text: " + style.wrapText);
    console.log("Include protection: " + style.includeProtection);
    console.log("Shrink to fit: " + style.shrinkToFit);
    console.log("Style locked: " + style.locked);
});

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[]): Excel.Style;

Paramètres

propertyNames

string | string[]

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

Retours

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;
        }): Excel.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 est une chaîne délimitée par des virgules qui spécifie les propriétés de propertyNamesAndPaths.expand navigation à charger.

Retours

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre un objet simple 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
Excel.Interfaces.StyleUpdateData

Objet JavaScript avec des propriétés structurées de manière isomorphe aux propriétés de l’objet sur lequel la méthode est appelée.

options
OfficeExtension.UpdateOptions

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

Retours

void

Remarques

Cette méthode possède la signature supplémentaire suivante :

set(properties: Excel.Style): void

set(properties)

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

set(properties: Excel.Style): void;

Paramètres

properties
Excel.Style

Retours

void

toJSON()

Remplace la méthode JavaScript afin de fournir une sortie plus utile lorsqu’un objet toJSON() API est transmis à JSON.stringify(). (JSON.stringify, à son tour, appelle toJSON la méthode de l’objet qui lui est transmis.) Alors que l’objet Excel.Style d’origine est un objet API, la méthode renvoie un objet toJSON JavaScript simple (tapé sous la forme Excel.Interfaces.StyleData) qui contient des copies superficiels de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.StyleData;

Retours