Excel.Style class

Spécifie si le texte est automatiquement mis en retrait lorsque l’alignement du texte dans une cellule est défini sur une distribution égale.

autoIndent: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.8

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

readonly borders: Excel.RangeBorderCollection;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

Indique si le style est un style intégré.

readonly builtIn: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Remplissage du style.

readonly fill: Excel.RangeFill;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

Objet Font qui représente la police du style.

readonly font: Excel.RangeFont;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

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

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

formulaHidden: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

Représente l’alignement horizontal pour le style. Pour Excel.HorizontalAlignment plus de détails.

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

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

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();
});

Indique si le style inclut les propriétés retrait automatique, alignement horizontal, alignement vertical, renvoi à la ligne, niveau de retrait et orientation du texte.

includeAlignment: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

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

includeBorder: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

Indique si le style inclut les propriétés de police suivantes : arrière-plan, gras, couleur, index des couleurs, style de police, italique, nom, taille, barré, indice, exposant et soulignement.

includeFont: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

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

includeNumber: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

Spécifie si le style inclut les propriétés intérieures color, color index, inverser si negative, pattern, pattern color et pattern color index index.

includePatterns: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

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

includeProtection: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

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

indentLevel: number;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

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

locked: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

Nom du style.

readonly name: string;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

Le code de format du nombre format pour le style.

numberFormat: string;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

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

numberFormatLocal: string;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

L’ordre de lecture du style.

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

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

Spécifie si le texte est automatiquement réduit pour s’adapter à la largeur de colonne disponible.

shrinkToFit: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

L’orientation du texte pour le style.

textOrientation: number;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.8

Spécifie l’alignement vertical du style. Pour Excel.VerticalAlignment plus de détails.

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

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

Indique si Excel encapsule le texte dans l’objet.

wrapText: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

Supprime ce style.

delete(): void;

Retours

Remarques

Jeu d’API : ExcelApi 1.7

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

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

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

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

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

Paramètres

Retours

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

set(properties: Interfaces.StyleUpdateData, 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: Excel.Style): 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 Excel.Style est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.StyleDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.StyleData;

Retours