Partager via

Excel.Style class

  • Référence
Paquet:
excel

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

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Propriétés

autoIndent

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

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

Spécifie si le style 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.
fill

Remplissage du style.
font

Objet Font qui représente la police du style.
formulaHidden

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

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

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

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

Spécifie si le style inclut l’arrière-plan, le gras, la couleur, l’index de couleur, le style de police, l’italique, le nom, la taille, le barré, l’indice, l’exposant et le soulignement.
includeNumber

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

Spécifie si le style inclut la couleur, l’index de couleur, l’inverse si négatif, le modèle, la couleur de modèle et les propriétés intérieures de l’index de couleur de modèle.
includeProtection

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

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

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

Nom du style.
numberFormat

Le code de format du nombre format pour le style.
numberFormatLocal

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

L’ordre de lecture du style.
shrinkToFit

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

L’orientation du texte pour le style.
verticalAlignment

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

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

Méthodes

delete()

Supprime ce 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.stringifyappelle à son tour 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 brut (typé en tant Excel.Interfaces.StyleDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées 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 défini sur une distribution égale.

autoIndent: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

borders

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

readonly borders: Excel.RangeBorderCollection;

Valeur de propriété

Excel.RangeBorderCollection

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

builtIn

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

readonly builtIn: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

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é

Excel.RequestContext

fill

Remplissage du style.

readonly fill: Excel.RangeFill;

Valeur de propriété

Excel.RangeFill

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

font

Objet Font qui représente la police du style.

readonly font: Excel.RangeFont;

Valeur de propriété

Excel.RangeFont

Remarques

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

formulaHidden

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

formulaHidden: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

horizontalAlignment

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

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"

Remarques

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

includeAlignment

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

includeAlignment: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

includeBorder

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

includeBorder: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

includeFont

Spécifie si le style inclut l’arrière-plan, le gras, la couleur, l’index de couleur, le style de police, l’italique, le nom, la taille, le barré, l’indice, l’exposant et le soulignement.

includeFont: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

includeNumber

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

includeNumber: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

includePatterns

Spécifie si le style inclut la couleur, l’index de couleur, l’inverse si négatif, le modèle, la couleur de modèle et les propriétés intérieures de l’index de couleur de modèle.

includePatterns: boolean;

Valeur de propriété

boolean

Remarques

[ 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 formule.

includeProtection: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

indentLevel

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

indentLevel: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

locked

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

locked: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

name

Nom du style.

readonly name: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

numberFormat

Le code de format du nombre format pour le style.

numberFormat: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

numberFormatLocal

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

numberFormatLocal: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

readingOrder

L’ordre de lecture du style.

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

Valeur de propriété

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

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

shrinkToFit

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

shrinkToFit: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

textOrientation

L’orientation du texte pour le style.

textOrientation: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

verticalAlignment

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

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

Valeur de propriété

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

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

wrapText

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

wrapText: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Détails de la méthode

delete()

Supprime ce style.

delete(): void;

Retours

void

Remarques

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

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 les propriétés de l’objet à charger.

Retours

Excel.Style

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 qui spécifient les propriétés à charger.

Retours

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

Retours

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

Paramètres

properties
Excel.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.stringifyappelle à son tour 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 brut (typé en tant Excel.Interfaces.StyleDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Excel.Interfaces.StyleData;

Retours

Excel.Interfaces.StyleData