Excel.Style class
Objet encapsulant le format d’un style et d’autres propriétés.
- Extends
Remarques
[Jeu d’API : ExcelApi 1.7]
Propriétés
| auto |
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. |
| built |
Indique si le style est un style intégré. |
| context | Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office. |
| fill | Remplissage du style. |
| font | Objet |
| formula |
Indique si la formule est masquée lorsque la feuille de calcul est protégée. |
| horizontal |
Représente l’alignement horizontal pour le style. Pour |
| include |
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. |
| include |
Indique si le style inclut les propriétés de couleur, d’index de couleur, de style de ligne et de bordure d’épaisseur. |
| include |
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. |
| include |
Spécifie si le style inclut la propriété de format de nombre. |
| include |
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. |
| include |
Spécifie si le style inclut les propriétés de protection masquées et verrouillées de formule. |
| indent |
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. |
| number |
Le code de format du nombre format pour le style. |
| number |
Le code de format localisé du nombre format pour le style. |
| reading |
L’ordre de lecture du style. |
| shrink |
Spécifie si le texte est automatiquement réduit pour s’adapter à la largeur de colonne disponible. |
| text |
L’orientation du texte pour le style. |
| vertical |
Spécifie l’alignement vertical du style. Pour |
| wrap |
Indique 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 |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| set(properties, options) | 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) | 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 |
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
[Jeu 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é
Remarques
[Jeu d’API : ExcelApi 1.7]
builtIn
Indique si le style est un style intégré.
readonly builtIn: boolean;
Valeur de propriété
boolean
Remarques
[Jeu d’API : ExcelApi 1.7]
context
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é
fill
Remplissage du style.
readonly fill: Excel.RangeFill;
Valeur de propriété
Remarques
[Jeu d’API : ExcelApi 1.7]
font
Objet Font qui représente la police du style.
readonly font: Excel.RangeFont;
Valeur de propriété
Remarques
[Jeu d’API : ExcelApi 1.7]
formulaHidden
Indique si la formule est masquée lorsque la feuille de calcul est protégée.
formulaHidden: boolean;
Valeur de propriété
boolean
Remarques
[Jeu d’API : ExcelApi 1.7]
horizontalAlignment
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é
Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed"
Remarques
[Jeu d’API : ExcelApi 1.7]
includeAlignment
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é
boolean
Remarques
[Jeu d’API : ExcelApi 1.7]
includeBorder
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é
boolean
Remarques
[Jeu d’API : ExcelApi 1.7]
includeFont
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é
boolean
Remarques
[Jeu 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
[Jeu d’API : ExcelApi 1.7]
includePatterns
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é
boolean
Remarques
[Jeu 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
[Jeu 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
[Jeu 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
[Jeu d’API : ExcelApi 1.7]
name
Nom du style.
readonly name: string;
Valeur de propriété
string
Remarques
[Jeu d’API : ExcelApi 1.7]
numberFormat
Le code de format du nombre format pour le style.
numberFormat: string;
Valeur de propriété
string
Remarques
[Jeu 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
[Jeu 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
[Jeu d’API : ExcelApi 1.7]
shrinkToFit
Spécifie si le texte est automatiquement réduit pour s’adapter à la largeur de colonne disponible.
shrinkToFit: boolean;
Valeur de propriété
boolean
Remarques
[Jeu d’API : ExcelApi 1.7]
textOrientation
L’orientation du texte pour le style.
textOrientation: number;
Valeur de propriété
number
Remarques
[Jeu d’API : ExcelApi 1.8]
verticalAlignment
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é
Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed"
Remarques
[Jeu d’API : ExcelApi 1.7]
wrapText
Indique si Excel encapsule le texte dans l’objet.
wrapText: boolean;
Valeur de propriété
boolean
Remarques
[Jeu d’API : ExcelApi 1.7]
Détails de la méthode
delete()
Supprime ce style.
delete(): void;
Retours
void
Remarques
[Jeu 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(options?: Excel.Interfaces.StyleLoadOptions): Excel.Style;
Paramètres
Fournit des options pour les propriétés de l’objet à charger.
Retours
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 propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.
Retours
set(properties, options)
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
- properties
- Excel.Interfaces.StyleUpdateData
Objet JavaScript dont les propriétés sont structurées de façon isomorphe par rapport aux 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 de propriétés 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.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;